Assign plan to an account

Assign a plan to an account and propagates it to every store under that account: existing active/expired store_plans are closed and a fresh active store_plan (running to month-end) is created per store, and the account-level company_plans link is updated/created.

Auth: Partner — authentication under partner/account. Path id must resolve to a bundle_id=3 company (404 if missing, 403 if not an account), with a partner (getParentCompany) and pass canManageBrand else 403. The plan must be available to that partner via company_plans, and must match the partner billing model: plan-based partners may only assign is_admin_managed=1 plans. Usage-based partners only is_admin_managed=0 (else 403).

Rate limit: No rate limit.

Request

  • Body (JSON):
FieldTypeRequiredNotes
plan_idintegeryesMust be an existing plan; further checked for partner availability + billing-model match in the controller.

Response{ data. } envelope wrapping an inner data object.

  • data.account (object) — fresh Company model row for the account.
  • data.plan (object) — the assigned Plan with features and planReviewSites.reviewSite included (same shape as Get assigned plan for account).
  • data.stores_assigned (integer) — number of stores the plan was propagated to.

Path params

ParameterTypeRequiredNotes
brandIdintegerRequiredDigits only.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
integer
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json