Global API
...
Request
Subscription
Subscription - Stripe
2 min
to create a subscription in stripe, the following properties can be provided those marked with are required subscription field name data type description collectionmethod string either 'send invoice' or 'charge automatically' items list subscription docid 84 r8gpyvrec2g6ktbvye at least one line item is required to create a subscription processorcustomerid string customer id in the processor id locations docid\ f3cm5zoc auraeoan2xb1 processorid string id of the connected stripe processor backdatestartdate datetime a past timestamp to backdate the subscription’s start date to billingcycleanchor datetime a future timestamp to anchor the subscription’s billing cycle cancelat datetime a timestamp at which the subscription should cancel cancelatperiodend boolean indicates whether the subscription should cancel at the end of the current period coupon couponstring coupon id in the processor createddateinprocessor datetime readonly field currentperiodenddate datetime readonly field currentperiodstartdate datetime readonly field daysuntildue integer conditionally required passed if collectionmethod is send invoice, by default it will be 30 days description string the subscription’s description, meant to be displayable to the customer latestinvoice string readonly field procesorsubscriptionid string readonly field processororgid string readonly field processorpaymentmethodid string passed if collectionmethod is charge automatically if not set, invoices will use the customer’s default source id locations docid\ f3cm5zoc auraeoan2xb1 promotioncode string the api id of a promotion code to apply to this subscription prorationbehavior determines how to handle prorations resulting from the billingcycleanchor the default is create prorations salesforceaccount string readonly field salesforcecontact string readonly field salesforcecustomerid string readonly field salesforceid startdate datetime used in case of subscription schedule creation it indicates when the subscription schedule starts status string readonly field trialend datetime the end of the trial period the customer will get before being charged for the first time trialfromplan boolean indicates if a plan’s trial period days should be applied to the subscription setting trialend per subscription is preferred, and this defaults to false setting this flag to true together with trialend is not allowed trialperioddays integer free trail days items field name data type description processorpriceid string id of the specific /price that is getting added to the subscription note this is the id in the processor not in salesforce quantity integer q uantity of items in subscription amount decimal readonly field chargecurrency string readonly field description string readonly field invoice string readonly field name string readonly field procesorsubscriptionid string readonly field salesforceid string readonly field salesforcepriceid string readonly field salesforcesubscriptionid string readonly field unitamount decimal readonly field unitamountdecimal decimal readonly field