ed2f53e4a3de

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-12265497975.2 KB

checkout

Preview manage plan

post/manage-plan/preview

Request body

activate_on_paymentboolean nullable

If true, the company gets the plan only once the first invoice is paid. Only applies to an invoiced subscription. Defaults to false.

base_plan_idstring nullable

base_plan_price_idstring nullable

base_plan_version_idstring nullable

billing_cycle_anchorstring date-time nullable

The date the subscription's billing period renews on. Only honored when starting a new subscription; changing the anchor on an existing subscription is not supported.

billing_emailstring nullable

Address the invoice is sent to. Required when collection_method is send_invoice.

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.

collection_method'charge_automatically' | 'send_invoice'

company_idstring required

coupon_external_idstring nullable

days_until_dueinteger nullable

Payment terms in days for an invoiced subscription. Defaults to 30.

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.

send_invoiceboolean nullable

Whether Stripe emails the invoice when it is finalized. Only applies to an invoiced subscription. Defaults to true.

trial_endstring date-time nullable

Response

paramsobject required

Input parameters