Credits

Get credit balance

Retrieve the authenticated user's current credit balance

get/api/credits/balance

Request

  • Base URL: https://api.zvid.io
  • URL: https://api.zvid.io/api/credits/balance
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Response

Credit balance retrieved successfully

balanceinteger required

Total available credits from subscription and add-on pools

subscriptionCreditsinteger required

Credits remaining in the current subscription period

Example response

{
  "balance": 1800,
  "subscriptionCredits": 1200,
  "addonCredits": {
    "balance": 600,
    "totalEarned": 1000,
    "totalSpent": 400
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.