تحديث استحقاق الرصيد - Dodo Payments Documentation

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

التفويضات

Authorization

string

header

مطلوب

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

معلمات المسار

string

مطلوب

Credit Entitlement ID

الجسم

application/json

currency

null | enum<string>

Currency for pricing

الخيارات المتاحة:

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

max_rollover_count

integer<int32> | null

Maximum number of times credits can be rolled over

name

string | null

Name of the credit entitlement

overage_behavior

null | 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 | null

Whether overage charges are enabled when credits run out

overage_limit

integer<int64> | null

Maximum overage units allowed

price_per_unit

string | null

Price per credit unit

rollover_enabled

boolean | null

Whether rollover is enabled for unused credits

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

unit

string | null

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

الاستجابة

Credit entitlement updated successfully