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

ff85db3452b4

plans

Publish plan version

put/plans/version/{plan_version_id}/publish

Path parameters

plan_version_idstring required

plan_version_id

Request body

activation_strategy'on_payment' | 'on_publish'
coupon_external_idstring nullable
customer_emailstring nullable
days_until_dueinteger nullable
excluded_company_idsstring[] required
migration_strategy'immediate' | 'leave' required
phonestring nullable
proration_behavior'always_invoice' | 'create_prorations'
require_no_migrationboolean nullable

Refuse the publish if any company would be migrated onto the new version

send_invoiceboolean nullable

Whether Stripe emails the invoice when it is finalized. Defaults to true.

Response

OK

paramsobject required

Input parameters