See the plans available to you, what each one includes, and assign them to your accounts.
See the plans available to you, what each one includes, and assign them to your accounts.
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 | List your plans | List the plans available to the authenticated partner. |
GET | Get one plan | Get a single plan for the authenticated partner (usage-based: for editing; plan-based: read-only). |
GET | Get your billing setup | Get the authenticated partner's billing model, contract model, billing config, per-feature rates, and review-site universe — everything the Plan Builder UI needs to render. |
POST | Assign or change an account's plan | Assign the selected plan to one or more accounts and (re)applies it to every store under each account. |
GET | Get a location's current plan | Get the currently active plan for the store identified by store_id, plus its who_will_pay billing flag from store_options. |
GET | List plans visible to an 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. |
POST | Add locations to a plan mid-cycle | Assign a plan to one or more stores for the current month. |
POST | Cancel a plan | Cancel every active store plan under the given account and notifies an admin via a brandPlanCancelled billing webhook. |
POST | Cancel a plan (selected locations) | Cancel the subscription for the specified stores. |