# GET Get the Store coupons

Returns the coupons on the authenticated Store, as the merchant admin's billing page shows them. Requires `billing:read`. `pending` is a coupon the merchant added that the next subscription uses. `active` is the coupon the subscription uses now, and `active_expires_at` is when its discount stops. Each is null when there is none. The API cannot apply or remove a coupon. This endpoint accepts no query parameters.

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

## cURL example

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

## Response examples

### 200 GET 200 example 1

```json
{
  "data": {
    "object": "store_coupons",
    "pending": {
      "object": "coupon",
      "code": "SPRING10",
      "percent": 10,
      "intervals": 1,
      "is_retention_offer": false,
      "is_win_back_offer": false,
      "redeemed_at": null
    },
    "active": {
      "object": "coupon",
      "code": "WELCOME20",
      "percent": 20,
      "intervals": 3,
      "is_retention_offer": false,
      "is_win_back_offer": false,
      "redeemed_at": "2026-10-01T00:00:00Z"
    },
    "active_expires_at": "2027-01-01T00:00:00Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/stores/me/coupons",
    "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"
}
```
