Schedule Plan Change

Schedules one of your companies to move to a plan at a job tier on a later date. The plan and job tier must be in the company's offering today, as for POST billing/plan_changes: read GET billing/plan_offering for the company first. A company has at most one scheduled change; scheduling again replaces it, and DELETE takes it back. The change is made on change_on and billed at the price in effect that day. The job limit, the card on file and any outstanding balance are checked then rather than now; a change that cannot be made that day is dropped and the company stays on its plan. A company with a cancellation scheduled cannot also have a plan change scheduled, nor the reverse. A company billed directly by the platform rather than by you cannot be scheduled here. Users need the AccountManagement permission. Integration-partner keys are refused.

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

The identifier of the associated company.

Body Params
string
required

The plan to move to: one of the offering's offered_plans, sold at the job tier named in job_tier_id. Trial and legacy can never be moved to.

string

The job tier to move to, from the offering's tiers[].id. Required, except for a company whose owner bills by usage and has no job tiers: there it must be left out.

date
required

The day the change takes effect, YYYY-MM-DD, after today.

Responses
204

The plan change was scheduled. Returns an empty payload.

400

The company has not verified its email address yet.

403

The user does not have the AccountManagement permission, or the key is an integration-partner key.

404

The company is not one of yours, or is not an active, approved account.

500

Internal system error. Please contact support in the event that this occurs.

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