CustomerSubscription

Fields

Field	Type	Required	Description	Example
created_at	date	:heavy_check_mark:	Creation timestamp of the object.
modified_at	date	:heavy_check_mark:	Last modification timestamp of the object.
id	str	:heavy_check_mark:	The ID of the object.
amount	int	:heavy_check_mark:	The amount of the subscription.	10000
currency	str	:heavy_check_mark:	The currency of the subscription.	usd
recurring_interval	models.RecurringInterval	:heavy_check_mark:	N/A
recurring_interval_count	int	:heavy_check_mark:	Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on.
status	models.SubscriptionStatus	:heavy_check_mark:	N/A
current_period_start	date	:heavy_check_mark:	The start timestamp of the current billing period.
current_period_end	date	:heavy_check_mark:	The end timestamp of the current billing period.
current_meter_period_start	date	:heavy_check_mark:	The start timestamp of the current meter period, if the product has a meter cycle set. Metered credits are granted and overage is settled on this cadence.
current_meter_period_end	date	:heavy_check_mark:	The end timestamp of the current meter period, if the product has a meter cycle set. This is when credits next renew.
trial_start	date	:heavy_check_mark:	The start timestamp of the trial period, if any.
trial_end	date	:heavy_check_mark:	The end timestamp of the trial period, if any.
cancel_at_period_end	bool	:heavy_check_mark:	Whether the subscription will be canceled at the end of the current period.
canceled_at	date	:heavy_check_mark:	The timestamp when the subscription was canceled. The subscription might still be active if cancel_at_period_end is true.
started_at	date	:heavy_check_mark:	The timestamp when the subscription started.
ends_at	date	:heavy_check_mark:	The timestamp when the subscription will end.
ended_at	date	:heavy_check_mark:	The timestamp when the subscription ended.
past_due_at	date	:heavy_minus_sign:	The timestamp when the subscription entered past_due status.
pause_at_period_end	bool	:heavy_check_mark:	Whether the subscription will be paused at the end of the current period.
paused_at	date	:heavy_check_mark:	The timestamp when the subscription was paused.
resumes_at	date	:heavy_check_mark:	The timestamp when a paused subscription is scheduled to automatically resume, if set.
customer_id	str	:heavy_check_mark:	The ID of the subscribed customer.
product_id	str	:heavy_check_mark:	The ID of the subscribed product.
discount_id	Nullable[str]	:heavy_check_mark:	The ID of the applied discount, if any.
checkout_id	Nullable[str]	:heavy_check_mark:	N/A
seats	OptionalNullable[int]	:heavy_minus_sign:	The number of seats for seat-based subscriptions. None for non-seat subscriptions.
customer_cancellation_reason	Nullable[models.CustomerCancellationReason]	:heavy_check_mark:	N/A
customer_cancellation_comment	Nullable[str]	:heavy_check_mark:	N/A
product	models.CustomerSubscriptionProduct	:heavy_check_mark:	N/A
prices	List[models.CustomerSubscriptionPrices]	:heavy_check_mark:	List of enabled prices for the subscription.
meters	List[models.CustomerSubscriptionMeter]	:heavy_check_mark:	List of meters associated with the subscription.
pending_update	Nullable[models.PendingSubscriptionUpdate]	:heavy_check_mark:	Pending subscription update that will be applied at the beginning of the next period. If null, there is no pending update.