application_fee_percentstring decimal nullable required
djstripe_createdstring date-time required
djstripe_updatedstring date-time required
livemodeboolean nullable
Null here indicates that the livemode status is unknown or was previously unrecorded. Otherwise, this field indicates whether this record comes from Stripe test mode or live mode operation.
createdstring date-time nullable
The datetime this object was created in stripe.
descriptionstring nullable
A description of this object.
billing_cycle_anchorstring date-time nullable
Determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices.
billing_thresholdsunknown
cancel_atstring date-time nullable
A date in the future at which the subscription will automatically get canceled.
cancel_at_period_endboolean
If the subscription has been canceled with the at_period_end flag set to true, cancel_at_period_end on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.
canceled_atstring date-time nullable
If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will still reflect the date of the initial cancellation request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
collection_method'charge_automatically' | 'send_invoice' required
- charge_automatically - Charge automatically
- send_invoice - Send invoice
current_period_endstring date-time required
End of the current period for which the subscription has been invoiced. At the end of this period, a new invoice will be created.
current_period_startstring date-time required
Start of the current period for which the subscription has been invoiced.
days_until_dueinteger nullable
Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where billing=charge_automatically.
ended_atstring date-time nullable
If the subscription has ended (either because it was canceled or because the customer was switched to a subscription to a new plan), the date the subscription ended.
next_pending_invoice_item_invoicestring date-time nullable
Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
pending_invoice_item_intervalunknown
proration_datestring date-time nullable
If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with upcoming invoice endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations
quantityinteger nullable
The quantity applied to this subscription. This value will be null for multi-plan subscriptions
start_datestring date-time nullable
Date when the subscription was first created. The date might differ from the created date due to backdating.
status'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'trialing' | 'unpaid' required
- active - Active
- canceled - Canceled
- incomplete - Incomplete
- incomplete_expired - Incomplete Expired
- past_due - Past due
- trialing - Trialing
- unpaid - Unpaid
trial_endstring date-time nullable
If the subscription has a trial, the end of that trial.
trial_startstring date-time nullable
If the subscription has a trial, the beginning of that trial.
djstripe_owner_accountstring nullable
The Stripe Account this object belongs to.
customerstring required
The customer associated with this subscription.
default_payment_methodstring nullable
The default payment method for the subscription. It must belong to the customer associated with the subscription. If not set, invoices will use the default payment method in the customer's invoice settings.
default_sourcestring nullable
The default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If not set, defaults to the customer's default source.
latest_invoicestring nullable
The most recent invoice this subscription has generated.
pending_setup_intentstring nullable
We can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments.
planinteger nullable
The plan associated with this subscription. This value will be null for multi-plan subscriptions
default_tax_ratesinteger[]
The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.