Sign in
Subscription

Get Credit Balance

Remaining credits and entitlement for the caller's org.

Answers even when the org is out of credits: that is exactly when a caller needs it.

get/v1/subscription/credit-balance

Headers

X-API-Keystring required

API key required to authenticate requests.

Response

Successful Response

meteredboolean required

Whether the org bills through Metronome; false means credits do not apply

entitledboolean required

Whether the org may currently spend (false once out of credits with no overages)

grantednumber nullable

Credits granted across active grants. Null when the org is not metered.

usednumber nullable

Credits used against those grants. Null when the org is not metered.

remainingnumber nullable

Credits still available. Null when the org is not metered.

Changes

Changed in 1 of the 20 revisions of this API.1