Skip to content
Start here

Credits

Get Account Credits
client.billing.credits.get(CreditGetParams { account_id } params, RequestOptionsoptions?): CreditGetResponse { confirmed_balance_cents, currency, days_remaining, 7 more }
GET/accounts/{account_id}/billing/credits
ModelsExpand Collapse
CreditGetResponse { confirmed_balance_cents, currency, days_remaining, 7 more }
confirmed_balance_cents?: number

The confirmed credit balance in cents.

formatint64
currency?: string

Currency of the credit balance.

days_remaining?: number

Days remaining until the credits expire.

formatint64
eligible?: boolean

Whether the account is eligible to receive credits.

has_record?: boolean

Whether a credit record exists for the account.

original_amount_cents?: number

The original credit amount in cents.

formatint64
percent_consumed?: number

Percentage of the original credit amount consumed.

formatdouble
projected_depletion_date?: string

Projected date when the credits will be depleted.

formatdate-time
valid_from?: string

When the credits become valid.

formatdate-time
valid_to?: string

When the credits expire.

formatdate-time