Sign Customiser

Navigation

Dark mode

Returns what the authenticated Store's plan allows, as the merchant admin reads it to show or lock a feature. Requires billing:read.

GET/api/v3/stores/me/plan-features
GETGet the Store plan features
GET/api/v3/stores/me/plan-features

Get the Store plan features

Returns what the authenticated Store's plan allows, as the merchant admin reads it to show or lock a feature. Requires `billing:read`. Use `GET /api/v3/stores/me/subscription` for the subscription status and dates. `can_go_live` is false when the Store cannot put a customiser live on its storefront. `features` lists the plan entitlements: a feature that is false is locked in the merchant admin, and `customiser_limit` is the number of live customisers the plan allows, or null for no limit. 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 plan features

Click Send to see the live response.

Overview

Use GET/api/v3/stores/me/subscription for the subscription status and dates. can_go_live is false when the Store cannot put a customiser live on its storefront. features lists the plan entitlements: a feature that is false is locked in the merchant admin, and customiser_limit is the number of live customisers the plan allows, or null for no limit. This endpoint accepts no query parameters.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: billing:read

Get the Store plan features
curl https://web.signcustomiser.com/api/v3/stores/me/plan-features \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "data": {
    "object": "plan_features",
    "subscribed": true,
    "can_go_live": true,
    "plan": "growth_10",
    "billing_interval": "monthly",
    "ends_at": null,
    "on_generic_trial": false,
    "has_incomplete_payment": false,
    "is_past_due": false,
    "plan_credits_enabled": true,
    "has_ai_designer": true,
    "features": {
      "customiser_limit": 10,
      "advanced_letter": true,
      "per_word_styling": true,
      "svg_files": true,
      "sharing": true,
      "icons": true,
      "free_transform": true,
      "custom_design_forms": true,
      "quote_mode": true,
      "custom_support_background": true,
      "size_scaling": true
    }
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/stores/me/plan-features",
    "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.