Skip to content

Latest commit

 

History

History
28 lines (25 loc) · 11.6 KB

customerordersubscription.md

File metadata and controls

28 lines (25 loc) · 11.6 KB

CustomerOrderSubscription

Fields

Field Type Required Description
created_at date ✔️ Creation timestamp of the object.
modified_at date ✔️ Last modification timestamp of the object.
id str ✔️ The ID of the object.
amount int ✔️ The amount of the subscription.
currency str ✔️ The currency of the subscription.
recurring_interval models.SubscriptionRecurringInterval ✔️ N/A
status models.SubscriptionStatus ✔️ N/A
current_period_start date ✔️ The start timestamp of the current billing period.
current_period_end date ✔️ The end timestamp of the current billing period.
cancel_at_period_end bool ✔️ Whether the subscription will be canceled at the end of the current period.
canceled_at date ✔️ The timestamp when the subscription was canceled. The subscription might still be active if cancel_at_period_end is true.
started_at date ✔️ The timestamp when the subscription started.
ends_at date ✔️ The timestamp when the subscription will end.
ended_at date ✔️ The timestamp when the subscription ended.
customer_id str ✔️ The ID of the subscribed customer.
product_id str ✔️ The ID of the subscribed product.
discount_id Nullable[str] ✔️ The ID of the applied discount, if any.
checkout_id Nullable[str] ✔️ N/A
customer_cancellation_reason Nullable[models.CustomerCancellationReason] ✔️ N/A
customer_cancellation_comment Nullable[str] ✔️ N/A
price_id str ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.