Assign or change an account's plan

Put an account on a plan, or move it to a different one. Every location under the account gets the new plan immediately: the previous plan is closed and the new one runs to month-end. Returns the plan and how many locations were assigned.

Prerequisites: the account's id (brandId) and a plan_id set up for your partner (see List your plans).

Authentication: Partner token. The account must be inside your account tree (otherwise 404); an account of another partner returns 403. The plan must be set up for the account's partner and match its billing model (plan-based partners: plans set up by Shout About Us; usage-based partners: their own plans); otherwise 403.

Rate limit: none.

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

Required. The account's id.

Body Params
integer
required
Defaults to 36

The plan to assign. Must be an existing plan set up for your partner.

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