On this page
No Headings
namestringThe name of the subscription.
start_dateobjectdate-timeDate and time in ISO 8601 format.
The effective start date of the subscription; can be past, current, or future. Date must be provided in ISO 8601 format
end_dateobjectdate-timeDate and time in ISO 8601 format.
The subscription will terminate on this date without renewal. Date must be provided in ISO 8601 format
external_customer_idstring^[a-zA-Z0-9_-]*$External reference to the customer
external_idstring^[a-zA-Z0-9_-]*$The subscription external unique identifier supplied by client. Must contain only alphanumeric characters, underscores, and hyphens.
plan_codestringThe plan code
billing_timestring"CALENDAR", "ANNIVERSARY""CALENDAR"The billing time for the subscription, which can be set as either anniversary or calendar