Billing
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.
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": "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"
}{
"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"
}{
"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"
}{
"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"
}