Sign Customiser

Store

Get the Store subscription

Copy page

Return the authenticated Store's current local subscription projection. The same provider-neutral contract covers Universal and Shopify Stores, with a stable machine plan, separate display name, billing interval, renewal intent, and known trial or end timestamps. Status is expected to grow. Provider ids, payment details, test flags, customer details, and raw provider objects are never exposed or fetched. Requires store:read; this operation is read-only and safe to retry. This endpoint accepts no query parameters. A 401 means the key is missing or invalid. A 403 means it lacks store:read; create a correctly scoped key. Remove parameters after a 422. Retry a 429 after retry_after seconds.

GET /api/v3/stores/me/subscription

Authorisation

Bearer token required. Include in the Authorization header.

Get the Store subscription
curl https://web.signcustomiser.com/api/v3/stores/me/subscription \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response 200 
{
  "data": {
    "object": "subscription",
    "status": "active",
    "plan": "seed",
    "plan_display_name": "Seed",
    "billing_interval": "monthly",
    "recurring": true,
    "trial_ends_at": null,
    "ends_at": null
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/stores/me/subscription",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}
Response 401 
{
  "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"
}
Response 403 
{
  "type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "This operation requires the store:read scope.",
  "required_scopes": [
    "store:read"
  ],
  "granted_scopes": [],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
Response 422 
{
  "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"
}
Response 429 
{
  "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"
}