# GET 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.

- Source URL: https://www.signcustomiser.com/help/api/v3-get-get-the-store-credit-balance/
- Markdown URL: https://www.signcustomiser.com/help/api/v3-get-get-the-store-credit-balance.md
- Group: Billing
- OpenAPI for this group: https://www.signcustomiser.com/help/openapi/billing.json
- Method: GET
- Path: /api/v3/stores/me/credits
- Auth: Bearer token
- Required scopes: `billing:read`

## cURL example

```bash
curl https://web.signcustomiser.com/api/v3/stores/me/credits \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
```

## Response examples

### 200 GET 200 example 1

```json
{
  "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"
  }
}
```

### 401 Missing API key

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/missing_api_key",
  "title": "Missing API key",
  "status": 401,
  "code": "missing_api_key",
  "detail": "Provide a store API key as a bearer token.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```

### 403 Insufficient scope

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "This operation requires the billing:read scope.",
  "required_scopes": [
    "billing:read"
  ],
  "granted_scopes": [
    "store:read"
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```

### 422 Unknown query parameter

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/unknown_parameter",
  "title": "Unknown query parameter",
  "status": 422,
  "code": "unknown_parameter",
  "detail": "This endpoint accepts no query parameters.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```

### 429 Rate limited

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/rate_limited",
  "title": "Too many requests",
  "status": 429,
  "code": "rate_limited",
  "detail": "You have exceeded the request limit for this API key.",
  "retry_after": 60,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```
