Change Plan

Moves the company to a plan at a job tier, and returns the offering as it stands after the change (current is the new plan). The plan must be one the offering sells at that tier: read GET billing/plan_offering first, and take job_tier_id from tiers[].id. A company can only select a plan when the offering's mode is select; in request mode use plan_requests. A paid plan on a company charged by card needs a chargeable payment method on file (see Payment Methods) and is charged when the change is made; preview the charge with plan_change_preview. Users need the AccountManagement permission. Company keys may call it; integration-partner keys are refused.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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.

Responses

400

The company has not verified its email address yet.

401

The user does not have the AccountManagement permission.

403

Not authorized

404

The company 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