Subscription

Read your active subscription plan and your credit balance.

📄️Get active subscription

Returns the currently active subscription plan for your account. The response includes the plan code (e.g. monthly_pro, annual_business), the status (active for the subscription in force), the current billing period start and end dates, the next reset of the usage counters, whether the subscription has been canceled, and the next plan code if a plan change is scheduled. Use this endpoint to programmatically check your plan tier before making API calls that may be restricted by plan level, or to display subscription information in your own dashboard. The billing period dates define the current invoicing cycle, at the end of which the plan renews unless it has been canceled. The nextRenew date is the next reset of the usage counters: on an annual plan it comes every month, well before billingPeriodEnd. If canceled is true while status is still active, the plan remains usable until the end of the current billing period, after which it will not renew; nextPlan, when set, is the plan that takes over. Returns 401 if the API key is missing or invalid. Returns 404 if no active subscription exists for your account. Returns 502 if the upstream subscription service is temporarily unavailable.

📄️Get credit balance

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, and all three values are expressed in credits. 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. If your account has no credits yet, all three values are 0. Returns 401 if the API key is missing or invalid. Returns 502 if the upstream wallet service is temporarily unavailable.