Subscription
Read your active subscription plan and remaining quotas.
Get active subscription
Returns the currently active subscription plan for your account. The response includes the plan code (e.g. PRO_MONTHLY, STARTER_YEARLY), the status (ACTIVE, CANCELED, SUSPENDED), the current billing period start and end dates, the next renewal date, 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. The nextRenew date indicates when the subscription will automatically renew (unless canceled). If canceled is true but status is still ACTIVE, the plan remains usable until the end of the current billing period, after which it will not renew. 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 contact quota usage
Returns the contact storage quota for your account, broken down into plan limit, extra limit, total limit, used count, and remaining capacity. The planLimit is the number of contacts included in your subscription plan. The extraLimit is any additional contact capacity you have purchased on top of your plan. The totalLimit is the sum of both. The used field indicates how many contacts are currently stored in your account, and remaining is the number of new contacts you can still add before reaching your quota. Monitor this endpoint before performing bulk contact imports to ensure you have sufficient capacity. If remaining reaches zero, attempts to create new contacts will be rejected. To increase your quota, upgrade your subscription plan or purchase additional contact capacity through the billing dashboard. 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. 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.