Account-side plan listing + currently-active plan details for a store.
Account-side plan listing + currently-active plan details for a store. Read-only; the partner manages the plan catalogue.
Prerequisites
- A bearer token in the
Authorizationheader. Any endpoint that needs no token says so on its own page. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | Plan list (account) | Get every plan assigned to a given company (account) via the company_plans pivot, including each plan's features, feature options, and plan-level review sites, ordered cheapest-first. |
GET | Plan details (current store plan) | Get the currently active plan for the store identified by store_id, plus its who_will_pay billing flag from store_options. |
POST | Add prorated plan to stores | Assign a plan to one or more stores for the current month. |
POST | Cancel store subscriptions | Cancel the subscription for the specified stores. |