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'
billing_cycle_anchorstring date-time nullable
The date the subscription's billing period renews on. Only honored on a first publish that starts a subscription.
coupon_external_idstring nullable
customer_emailstring nullable
days_until_dueinteger nullable
excluded_company_idsstring[] required
migration_strategy'end_of_billing_period' | 'immediate' | 'leave' required
phonestring nullable
prorate_first_periodboolean nullable
When true, the partial period between the subscription starting and its renewal date is billed pro rata straight away. When false that period is free and no invoice is raised until the renewal date. Only applies alongside billing_cycle_anchor. Defaults to true.
proration_behavior'always_invoice' | 'create_prorations' | 'none'
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