Preview Plan Change

Returns what a plan change would charge the company's card on file today, and when the plan would next renew, without making the change. A preview exists only for a company charged by card (the offering's charges_card is true). A company you bill yourself is not charged by card, and a company billed directly by the platform cannot be changed through your key, so a private-label key gets a 422 for either; what you charge your own companies is yours to compute from the offering's prices. Takes the same plan and job_tier_id as plan_changes. 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.

Query Params
string
required

The plan to preview moving to: one of the offering's offered_plans.

string

The job tier to preview moving 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

401

The user does not have the AccountManagement permission.

403

Not authorized

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