Plans (partner-managed)
Partner-managed plan templates + assignment surface.
Partner-managed plan templates + assignment surface. Usage-Based partners own their plans here; Plan-Based partners get an admin-managed catalogue via the endpoints listed below.
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
GET — 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.
GET — Get a single plan for the authenticated partner (usage-based: for editing; plan-based: read-only).
POST — Create a new usage-based plan owned by the authenticated partner and link it via company_plans.
DELETE — Soft-delete a partner-managed usage-based plan and removes its company_plans link to the partner (one DB transaction).
POST — Assign the selected plan to one or more accounts and (re)apply it to every store under each account.
POST — Cancel every active store plan under the given account and notify an admin via a brandPlanCancelled billing webhook.
Updated 11 days ago