跳转到主要内容
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);
{
  "business_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "overage_behavior": "forgive_at_reset",
  "overage_enabled": true,
  "precision": 123,
  "rollover_enabled": true,
  "unit": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "currency": "AED",
  "description": "<string>",
  "expires_after_days": 123,
  "max_rollover_count": 123,
  "overage_limit": 123,
  "price_per_unit": "<string>",
  "rollover_percentage": 123,
  "rollover_timeframe_count": 123,
  "rollover_timeframe_interval": "Day"
}

授权

Authorization
string
header
必填

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

请求体

application/json
name
string
必填

Name of the credit entitlement

overage_enabled
boolean
必填

Whether overage charges are enabled when credits run out

precision
integer<int32>
必填

Precision for credit amounts (0-10 decimal places)

rollover_enabled
boolean
必填

Whether rollover is enabled for unused credits

unit
string
必填

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)

可用选项:
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.

可用选项:
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

可用选项:
Day,
Week,
Month,
Year

响应

Credit entitlement created successfully

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

Controls how overage is handled at billing cycle end.

可用选项:
forgive_at_reset,
invoice_at_billing,
carry_deficit,
carry_deficit_auto_repay
overage_enabled
boolean
必填
precision
integer<int32>
必填
rollover_enabled
boolean
必填
unit
string
必填
updated_at
string<date-time>
必填
currency
null | enum<string>
可用选项:
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>
可用选项:
Day,
Week,
Month,
Year