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
currency'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'ars' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'brl' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'cdf' | 'chf' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'fkp' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'std' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'ugx' | 'usd' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xcg' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmw'
days_until_dueinteger nullable
Payment terms in days for an invoiced subscription. Defaults to 30.
paid_outside_stripeboolean nullable
If true, the first invoice is recorded in Stripe as paid outside Stripe and the company gets the plan straight away. Requires collection_method to be send_invoice, and the invoice is not emailed. Defaults to false.
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.
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.
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