Billing
List plans
Lists every subscription plan in Sign Customiser, as the merchant admin
reads them. Requires billing:read.
Overview
The list is the same for every Store: it is not the plans the Store can choose, and it includes plans that are no longer offered. Use GET/api/v3/stores/me/subscription for the Store's own plan. The API cannot change a plan. The list is short, so it is always returned in one complete page, in a fixed order. This endpoint accepts no query parameters.
Authorisation
Bearer token required. Include it in the Authorization header.
Required scope: billing:read
List plans
curl https://web.signcustomiser.com/api/v3/plans \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN'Response
{
"data": [
{
"object": "plan",
"plan": "growth_10",
"plan_display_name": "Growth 10",
"billing_interval": "monthly",
"price_amount": 4900,
"currency": "USD"
},
{
"object": "plan",
"plan": "growth_10_yearly",
"plan_display_name": "Growth 10 Yearly",
"billing_interval": "yearly",
"price_amount": 47000,
"currency": "USD"
}
],
"pagination": {
"has_more": false,
"next_cursor": null
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/plans",
"documentation": "https://www.signcustomiser.com/help/api/",
"next": null
},
"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"
}