Determines the date of the first payment and the day of week/month/year for subsequent payments. If a month doesn't have the anchor day, the subscription will be billed on the last day of the month. For example, a monthly subscription starting on January 31 bills on Feb 28/29, then March 31, April 30, etc. Format must be ISO8601 (e.g. '2000-01-25', '2024-02-01T04:00:00-0500', '2018-04-04T16:00:00.000Z'). UTC is assumed unless a timezone offset is supplied. The subscription will be billed close to (typically within 30 minutes) the time portion of this date-time field. Note: if no time portion was specified during the creation of the subscription (i.e. '2022-04-01') then the time is defaulted to midnight UTC (00:00:00) and the subscription will be billed around 7PM Eastern on the previous day.
SubscriptionCreateParams
Optional cancel_A date in the future at which the subscription will automatically get canceled.
SubscriptionCreateParams
Three-letter ISO currency code, in lowercase.
SubscriptionCreateParams
The id of the customer who owns the subscription.
SubscriptionCreateParams
Optional interval_The number of intervals (specified in the interval_unit attribute) between subscription billings. For example, interval_unit=month and interval_count=3 bills every 3 months.
SubscriptionCreateParams
The frequency at which a subscription is billed. One of week, month or year.
SubscriptionCreateParams
Optional metadataSet of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value (i.e. \'\' or null) to them. All keys can be unset by posting an empty value (i.e. {} or null) to metadata.
SubscriptionCreateParams
The id of the PaymentMethod used for this subscription. It must belong to the customer associated with the subscription.
SubscriptionCreateParams
Optional platform_The amount of the fee (if any) that will be requested to be applied to the payment and transferred to the partner account. The amount of the fee collected will be capped a the total payment amount.
SubscriptionCreateParams
Amount intended to be collected by this subscription. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).
SubscriptionCreateParams
Generated using TypeDoc
Export
SubscriptionCreateParams