> ## Documentation Index > Fetch the complete documentation index at: https://docs.clipstake.com/llms.txt > Use this file to discover all available pages before exploring further. # Get the credit balance ## OpenAPI ````yaml /openapi.json get /credits openapi: 3.1.0 info: title: Clipstake API description: >- Instagram, X and YouTube media tracking, audience geography and demographics, as an API. version: 0.0.1 servers: - url: https://api.clipstake.com/v1 security: [] paths: /credits: get: tags: - Credits summary: Get the credit balance operationId: credits-get parameters: [] responses: '200': description: Successful response content: application/json: schema: type: object properties: balance: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Credits the workspace holds now. Can be a little below 0: a read that already happened is never refused. tracking_paused: type: boolean description: >- True when the workspace has no credits left. No tracked media is read until credits are added. paused_since: anyOf: - type: string format: date-time - type: 'null' description: >- When tracking paused for lack of credits. Null while tracking runs, or when the workspace never held credits. expiring_soon: type: array items: type: object properties: credits: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Credits left in this batch. expires_at: type: string format: date-time description: When the credits left in this batch expire. required: - credits - expires_at additionalProperties: false description: >- Batches of credits that expire in the next 14 days, soonest first. next_expiry: anyOf: - type: object properties: credits: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Credits left in this batch. expires_at: type: string format: date-time description: When the credits left in this batch expire. required: - credits - expires_at additionalProperties: false - type: 'null' description: >- The batch of credits that expires first. Null when no credits are left. spent_last_7_days: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Credits used in the last 7 days. spent_last_30_days: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Credits used in the last 30 days. days_covered: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- How many days the balance lasts at the rate of your active tracked media. The rate is each media at its cadence and geo price, plus the daily geo account fee. Null when no tracked media are active, or the balance is 0 or less. auto_top_up: anyOf: - type: object properties: enabled: type: boolean trigger_credits: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- A credit pack is bought when the balance falls below this number. pack: type: string description: >- The credit pack that is bought: `starter`, `growth`, `pro`, `business` or `scale`. Accept values you do not know. monthly_limit_cents: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The most auto top-up spends in a calendar month, in US cents. Null means no limit. has_card: type: boolean description: True when a card is saved for auto top-up. disabled_reason: description: >- Why auto top-up turned itself off: `declined` or `dispute`. Null when it did not. Accept values you do not know. type: - string - 'null' required: - enabled - trigger_credits - pack - monthly_limit_cents - has_card - disabled_reason additionalProperties: false - type: 'null' description: >- Auto top-up settings. Null when they were never set. Change them on the Billing page of the console. required: - balance - tracking_paused - paused_since - expiring_soon - next_expiry - spent_last_7_days - spent_last_30_days - days_covered - auto_top_up additionalProperties: false example: balance: 412350 tracking_paused: false paused_since: null expiring_soon: - credits: 20000 expires_at: '2026-11-02T09:15:00.000Z' next_expiry: credits: 20000 expires_at: '2026-11-02T09:15:00.000Z' spent_last_7_days: 61810 spent_last_30_days: 248440 days_covered: 46 auto_top_up: enabled: true trigger_credits: 100000 pack: growth monthly_limit_cents: 50000 has_card: true disabled_reason: null '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error.UNAUTHORIZED' example: error: code: unauthorized message: Provide a valid API key. request_id: req_01K5A7P2CH8T6R4W9M1B '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR' example: error: code: internal_error message: An unexpected error occurred. request_id: req_01K5A7S6FQ3V8H2N9C4M security: - Authorization: [] components: schemas: error.UNAUTHORIZED: type: object properties: message: type: string description: The error message example: Unauthorized code: type: string description: The error code example: UNAUTHORIZED issues: description: An array of issues that were responsible for the error example: [] type: array items: type: object properties: message: type: string required: - message additionalProperties: false required: - message - code additionalProperties: false title: Unauthorized error (401) description: The error information example: code: UNAUTHORIZED message: Unauthorized issues: [] error.INTERNAL_SERVER_ERROR: type: object properties: message: type: string description: The error message example: Internal server error code: type: string description: The error code example: INTERNAL_SERVER_ERROR issues: description: An array of issues that were responsible for the error example: [] type: array items: type: object properties: message: type: string required: - message additionalProperties: false required: - message - code additionalProperties: false title: Internal server error error (500) description: The error information example: code: INTERNAL_SERVER_ERROR message: Internal server error issues: [] securitySchemes: Authorization: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.