The id of the associated account.
Subscription
Optional apply_Whether to apply the account's surcharge rate to payments created by this subscription. If true, the percentage amount set in surcharge_rate will be applied to payments created by this subscription.
Subscription
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. 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.
Subscription
Optional cancel_A date in the future at which the subscription will automatically get canceled.
Subscription
Optional canceled_If the subscription has been canceled, the date of that cancellation.
Subscription
Time at which the object was created.
Subscription
The id of the customer who owns the subscription.
Subscription
Unique identifier for the object.
Subscription
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.
Subscription
The frequency at which a subscription is billed. One of week, month or year.
Subscription
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. This metadata will be copied to the payment_intent.metadata field when a payment is attempted.
Subscription
Optional next_The date at which payment will next be attempted. The value will be null when no more payments are to be attempted. Examples: canceled and paused statuses or cancel_at is prior to what would be the next payment date. When a payment fails and the status changes to past_due this value can be manually updated to determine the next attempt.
Subscription
Optional pause_A date in the future at which the subscription will automatically get paused.
Subscription
Optional paused_If the subscription has been paused, the date of the most recent pausing.
Subscription
The id of the PaymentMethod used for this subscription. It must belong to the customer associated with the subscription.
Subscription
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.
Subscription
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).
Subscription
Optional resume_If the subscription has been paused, the date in the future at which the subscription will automatically return to active.
Subscription
Status of this subscription, one of active, canceled, past_due, paused, or pending.
Subscription
Optional surcharge_Amount (in the smallest currency unit) of the surcharge applied to the subscription.
Subscription
Optional surcharge_If set, the percentage amount that will be applied to payments created by this subscription. A decimal value with up to three decimal places representing a percentage (e.g., 7.5 for 7.5%). The amount will be the surcharge rate set on the account at the time the subscription is created. In order for this to be set, surcharging must be enabled on the account and apply_surcharge must be true.
Subscription
Time at which the object was last updated.
Subscription
Generated using TypeDoc
Export
Subscription