Saltar al contenido principal
POST
/
credit-entitlements
JavaScript
import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const creditEntitlement = await client.creditEntitlements.create({
  name: 'name',
  overage_enabled: true,
  precision: 0,
  rollover_enabled: true,
  unit: 'unit',
});

console.log(creditEntitlement.id);
import os
from dodopayments import DodoPayments

client = DodoPayments(
bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"), # This is the default and can be omitted
)
credit_entitlement = client.credit_entitlements.create(
name="name",
overage_enabled=True,
precision=0,
rollover_enabled=True,
unit="unit",
)
print(credit_entitlement.id)
package main

import (
"context"
"fmt"

"github.com/dodopayments/dodopayments-go"
"github.com/dodopayments/dodopayments-go/option"
)

func main() {
client := dodopayments.NewClient(
option.WithBearerToken("My Bearer Token"),
)
creditEntitlement, err := client.CreditEntitlements.New(context.TODO(), dodopayments.CreditEntitlementNewParams{
Name: dodopayments.F("name"),
OverageEnabled: dodopayments.F(true),
Precision: dodopayments.F(int64(0)),
RolloverEnabled: dodopayments.F(true),
Unit: dodopayments.F("unit"),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", creditEntitlement.ID)
}
package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.creditentitlements.CreditEntitlement;
import com.dodopayments.api.models.creditentitlements.CreditEntitlementCreateParams;

public final class Main {
private Main() {}

public static void main(String[] args) {
DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

CreditEntitlementCreateParams params = CreditEntitlementCreateParams.builder()
.name("name")
.overageEnabled(true)
.precision(0)
.rolloverEnabled(true)
.unit("unit")
.build();
CreditEntitlement creditEntitlement = client.creditEntitlements().create(params);
}
}
package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.creditentitlements.CreditEntitlement
import com.dodopayments.api.models.creditentitlements.CreditEntitlementCreateParams

fun main() {
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

val params: CreditEntitlementCreateParams = CreditEntitlementCreateParams.builder()
.name("name")
.overageEnabled(true)
.precision(0)
.rolloverEnabled(true)
.unit("unit")
.build()
val creditEntitlement: CreditEntitlement = client.creditEntitlements().create(params)
}
require "dodopayments"

dodo_payments = Dodopayments::Client.new(
bearer_token: "My Bearer Token",
environment: "test_mode" # defaults to "live_mode"
)

credit_entitlement = dodo_payments.credit_entitlements.create(
name: "name",
overage_enabled: true,
precision: 0,
rollover_enabled: true,
unit: "unit"
)

puts(credit_entitlement)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;
use Dodopayments\CreditEntitlements\CbbOverageBehavior;
use Dodopayments\Misc\Currency;
use Dodopayments\Subscriptions\TimeInterval;

$client = new Client(
bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
environment: 'test_mode',
);

try {
$creditEntitlement = $client->creditEntitlements->create(
name: 'name',
overageEnabled: true,
precision: 0,
rolloverEnabled: true,
unit: 'unit',
currency: Currency::AED,
description: 'description',
expiresAfterDays: 0,
maxRolloverCount: 0,
overageBehavior: CbbOverageBehavior::FORGIVE_AT_RESET,
overageLimit: 0,
pricePerUnit: 'price_per_unit',
rolloverPercentage: 0,
rolloverTimeframeCount: 0,
rolloverTimeframeInterval: TimeInterval::DAY,
);

var_dump($creditEntitlement);
} catch (APIException $e) {
echo $e->getMessage();
}
using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.CreditEntitlements;

DodoPaymentsClient client = new();

CreditEntitlementCreateParams parameters = new()
{
Name = "name",
OverageEnabled = true,
Precision = 0,
RolloverEnabled = true,
Unit = "unit",
};

var creditEntitlement = await client.CreditEntitlements.Create(parameters);

Console.WriteLine(creditEntitlement);
use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
let client = Client::from_env()?;
let result = client
.credit_entitlements()
.create()
.body(dodopayments::models::CreditEntitlementsCreateParams {
name: Some("name".to_string()),
overage_enabled: Some(true),
precision: Some(0),
rollover_enabled: Some(true),
unit: Some("unit".to_string()),
..Default::default()
})
.await?;
println!("{result:?}");
Ok(())
}
curl --request POST \
--url https://test.dodopayments.com/credit-entitlements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"overage_enabled": true,
"precision": 123,
"rollover_enabled": true,
"unit": "<string>",
"description": "<string>",
"expires_after_days": 123,
"max_rollover_count": 123,
"overage_limit": 123,
"price_per_unit": "<string>",
"rollover_percentage": 123,
"rollover_timeframe_count": 123
}
'
{
  "business_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "overage_enabled": true,
  "precision": 123,
  "rollover_enabled": true,
  "unit": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "expires_after_days": 123,
  "max_rollover_count": 123,
  "overage_limit": 123,
  "price_per_unit": "<string>",
  "rollover_percentage": 123,
  "rollover_timeframe_count": 123
}

Autorizaciones

Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cuerpo

application/json
name
string
requerido

Name of the credit entitlement

overage_enabled
boolean
requerido

Whether overage charges are enabled when credits run out

precision
integer<int32>
requerido

Precision for credit amounts (0-10 decimal places)

rollover_enabled
boolean
requerido

Whether rollover is enabled for unused credits

unit
string
requerido

Unit of measurement for the credit (e.g., "API Calls", "Tokens", "Credits")

currency
null | enum<string>

Currency for pricing (required if price_per_unit is set)

Opciones disponibles:
AED,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BWP,
BYN,
BZD,
CAD,
CHF,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SLL,
SOS,
SRD,
SSP,
STN,
SVC,
SZL,
THB,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
description
string | null

Optional description of the credit entitlement

expires_after_days
integer<int32> | null

Number of days after which credits expire (optional)

max_rollover_count
integer<int32> | null

Maximum number of times credits can be rolled over

overage_behavior
null | enum<string>

Controls how overage is handled at billing cycle end. Defaults to forgive_at_reset if not specified.

Opciones disponibles:
forgive_at_reset,
invoice_at_billing,
carry_deficit,
carry_deficit_auto_repay
overage_limit
integer<int64> | null

Maximum overage units allowed (optional)

price_per_unit
string | null

Price per credit unit

rollover_percentage
integer<int32> | null

Percentage of unused credits that can rollover (0-100)

rollover_timeframe_count
integer<int32> | null

Count of timeframe periods for rollover limit

rollover_timeframe_interval
null | enum<string>

Interval type for rollover timeframe

Opciones disponibles:
Day,
Week,
Month,
Year

Respuesta

Credit entitlement created successfully

business_id
string
requerido
created_at
string<date-time>
requerido
id
string
requerido
name
string
requerido
overage_behavior
enum<string>
requerido

Controls how overage is handled at billing cycle end.

Opciones disponibles:
forgive_at_reset,
invoice_at_billing,
carry_deficit,
carry_deficit_auto_repay
overage_enabled
boolean
requerido
precision
integer<int32>
requerido
rollover_enabled
boolean
requerido
unit
string
requerido
updated_at
string<date-time>
requerido
currency
null | enum<string>
Opciones disponibles:
AED,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BWP,
BYN,
BZD,
CAD,
CHF,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SLL,
SOS,
SRD,
SSP,
STN,
SVC,
SZL,
THB,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
description
string | null
expires_after_days
integer<int32> | null
max_rollover_count
integer<int32> | null
overage_limit
integer<int64> | null
price_per_unit
string | null

Price per credit unit

rollover_percentage
integer<int32> | null
rollover_timeframe_count
integer<int32> | null
rollover_timeframe_interval
null | enum<string>

Unit of a duration count (e.g. license-key validity period).

Opciones disponibles:
Day,
Week,
Month,
Year
Última modificación el 1 de abril de 2026