Skip to main content

Get credit balance

GET 
/api/v1/partner-gateway/subscription/credit

Returns the credit balance for your account, split into three values: total credit, frozen credit, and available credit. Credit is the currency used to pay for message sending and other billable operations on the platform. The credit field is your total credit balance. The frozenCredit field represents credit that has been reserved (frozen) for pending operations such as scheduled campaigns that have been queued but not yet fully delivered. Frozen credit cannot be spent on new operations until the pending operations complete or are canceled. The availableCredit field is the amount you can actually spend right now (credit minus frozenCredit). Check this endpoint before launching large campaigns to ensure you have enough available credit to cover the estimated cost. If available credit is insufficient, the campaign or message send may be rejected. Credit can be topped up through the billing dashboard or via your account manager. Returns 401 if the API key is missing or invalid. Returns 502 if the upstream wallet service is temporarily unavailable.

Responses​

Credit balance retrieved successfully

Last updated on