Plans

Account-side plan listing + currently-active plan details for a store.

Account-side plan listing + currently-active plan details for a store. The partner manages the plan catalogue; you can view plans and manage store subscriptions.

Prerequisites

  • A bearer token in the Authorization header. 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

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

Plan list (account)

GET — 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.

Open →

Plan details (current store plan)

GET — Get the currently active plan for the store identified by store_id, plus its who_will_pay billing flag from store_options.

Open →

Add prorated plan to stores

POST — Assign a plan to one or more stores for the current month.

Open →

Cancel store subscriptions

POST — Cancel the subscription for the specified stores.

Open →


Did this page help you?