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.
billing_start_datestring date-time nullable
The date the contract term starts. A past date backdates the subscription so the first invoice covers the term from this date to the renewal date. Requires billing_cycle_anchor. Only honored on a first publish that starts a subscription.
collection_method'charge_automatically' | 'send_invoice'
coupon_external_idstring nullable
A Stripe coupon to apply. On a custom-plan republish it discounts the amendment invoice and is only used when that invoice is raised today; it must exist in Stripe. It is attached to the subscription, so a repeating or forever coupon also discounts the renewals that follow.
customer_emailstring nullable
days_until_dueinteger nullable
Payment terms in days. On a custom-plan republish they apply to the amendment invoice only, leave the subscription's renewal terms unchanged, and are only used when that invoice is raised today and sent rather than charged. Defaults to the subscription's terms.
end_datestring date-time nullable
When a custom plan that doesn't renew ends: the company moves to the default plan then, and no renewal invoice is raised. Required when the version's renewal_policy is expire_to_default, and refused otherwise. Moved back to the last renewal on or before it, which must leave at least one whole billing period. Only honored on a first publish that starts a subscription.
excluded_company_idsstring[] required
migration_strategy'end_of_billing_period' | 'immediate' | 'leave' | 'scheduled' required
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
scheduled_atstring date-time nullable
When every company moves, for migration_strategy scheduled. Must be in the future; the migration runs within about a minute of this time. Not accepted with other strategies.
send_invoiceboolean nullable
Whether Stripe emails the invoice when it is finalized. Defaults to true.