Sign Customiser

Navigation

Dark mode

Returns the authenticated Store's AI credit balance, as the merchant admin's AI credits page shows it. Requires billing:read.

GET/api/v3/stores/me/credits
GETGet the Store credit balance
GET/api/v3/stores/me/credits

Get the Store credit balance

Returns the authenticated Store's AI credit balance, as the merchant admin's AI credits page shows it. Requires `billing:read`. The AI sign designer spends plan credits first and then purchased credits. Plan credits reset at `plan_cycle_ends_at`; purchased credits do not. This endpoint accepts no query parameters.

Authorisation

The Authorization header expects a Bearer token. Generate one on the API keys page in your dashboard.

Get the Store credit balance

Click Send to see the live response.

Overview

The AI sign designer spends plan credits first and then purchased credits. Plan credits reset at plan_cycle_ends_at; purchased credits do not. This endpoint accepts no query parameters.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: billing:read

Get the Store credit balance
curl https://web.signcustomiser.com/api/v3/stores/me/credits \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "data": {
    "object": "credit_balance",
    "balance": 42,
    "plan_balance": 40,
    "purchased_balance": 2,
    "plan_cycle_ends_at": "2026-12-01T00:00:00Z",
    "last_used_at": "2026-11-14T09:30:00Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/stores/me/credits",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.