Skip to navigation

Get Credits

Get the organization’s credit balance.

Needs view_billing or manage_billing.

Authentication

AuthorizationBearer

A management key (mgmt_...), sent as Authorization: Bearer <key>. Reading /v1/routing-policies also accepts the organization’s gateway API keys; writing there needs a management key.

Response

The organization's credit balance
balance_usddouble
Credit left. Only an enterprise contract balance can be negative.
credits_expired_usddouble
Credit that lapsed before it was used.
credits_purchased_usddouble
Credit bought or added by coupon.
free_credits_usddouble
The free credit granted at signup.
total_spend_usddouble
Spend drawn from credit to date.

Errors

401
Unauthorized Error
403
Forbidden Error
502
Bad Gateway Error