v80

OpenAPI 3.0.0raw.githubusercontent.com2026-08-03260491955.2 KB

checkout

Preview manage plan

post/manage-plan/preview

base_plan_idstring nullable

base_plan_price_idstring nullable

base_plan_version_idstring nullable

billing_entity_idstring nullable

The company that pays for this subscription. Must already have a Stripe customer. Only honored when starting a new subscription.

cancel_immediatelyboolean nullable

If false, subscription cancels at period end. Only applies when removing all plans. Defaults to true.

company_idstring required

coupon_external_idstring nullable

payment_method_external_idstring nullable

promo_codestring nullable

prorateboolean nullable

If true and cancel_immediately is true, issue prorated credit. Only applies when removing all plans. Defaults to true.

trial_endstring date-time nullable

paramsobject required

Input parameters