post
https://production-api.shoutaboutus.com/api/v1/account/add-prorated-plan
Assign a plan to one or more stores for the current month. For each store it closes any active/expired store plans without an issued next-invoice, opens a new active store plan. It also creates or updates the CompanyPlan pointer for each affected account and fires a planChanged billing webhook. Billing side effect: the plan amount is applied to next month's invoice.
Auth
- Bearer partner / account token.
plan_idmust be assigned to the caller's plan-assignment company (company_plansforplanAssignmentCompanyId); everystore_ids[]must belong to the caller's hierarchy (an ownership check).
Rate limit
- No rate limit.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
plan_id | integer | Required | Must exist in company_plans for the caller's plan-assignment company. Error message: 'The selected plan is not assigned to your partner account.' |
store_ids | integer[] | Required | Non-empty array. |
store_ids.* | integer | Required | Must be an existing location and in caller's hierarchy (an ownership check). |
Behaviour
200—{ data: { status: 'success', message } }.422— plan not assigned to caller, or astore_idinvalid / out of scope.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
