Subscribe

Changed on

Returns the account credit balance and usage context.

get/api/v1/credits

Request

  • Base URL: https://xquik.com
  • URL: https://xquik.com/api/v1/credits
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Response

Credits balance and usage

auto_topup_amount_dollarsnumber required

Configured dollar amount for each automatic top-up.

auto_topup_enabledboolean required
auto_topup_stoppedboolean required

Whether declined charges stopped automatic top-up while it is enabled. It stops after 3 declines in a row on 1 card. A paid top-up, a paid plan renewal, or the next automatic top-up on a new card clears it.

auto_topup_thresholdstring required

Credit balance threshold that triggers automatic top-up when enabled, as a bigint string.

balancestring required

Current credit balance as a bigint string, which keeps precision above Number.MAX_SAFE_INTEGER.

lifetime_purchasedstring required

Lifetime purchased credits as a bigint string.

lifetime_usedstring required

Lifetime consumed credits as a bigint string.

Example response

{
  "auto_topup_amount_dollars": 10,
  "auto_topup_threshold": "50000",
  "balance": "50000",
  "lifetime_purchased": "200000",
  "lifetime_used": "150000"
}

Changes

  • 45942c75fdc2Revision changes
    • warning

      added the new topup_in_progress enum value to the ///// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status