billing

Get credit balance and pricing

Fetches the authenticated account's remaining credits, the account email the credentials belong to, and current credit purchase pricing. Confirm the account email before purchasing credits, since credits are non-transferable between accounts.

get/v2/credits

Response

Credit balance, the account email, and credit purchase pricing

creditsRemaininginteger required
accountEmailstring required
pricePer1000CreditsUsdnumber required

Example response

{
  "creditsRemaining": 54688,
  "accountEmail": "user@example.com",
  "purchaseQuantityRange": {
    "min": 1000,
    "max": 10000
  },
  "pricePer1000CreditsUsd": 6
}

Changes

Changed in 2 of the 8 revisions of this API.7

    • added the optional property action to the response with the 401 status

      response-optional-property-added

    • added the optional property action to the response with the 403 status

      response-optional-property-added

    • added the optional property action to the response with the 500 status

      response-optional-property-added

    • added the optional property details to the response with the 401 status

      response-optional-property-added

    • added the optional property details to the response with the 403 status

      response-optional-property-added

    • added the optional property details to the response with the 500 status

      response-optional-property-added

    • added the non-success response with the status 403

      response-non-success-status-added