djstripe.models.checkout
Session
Bases: StripeModel
A Checkout Session represents your customer's session as they pay for one-time purchases or subscriptions through Checkout.
Stripe documentation: https://stripe.com/docs/api/checkout/sessions?lang=python
amount_subtotal
property amount_subtotal
Total of all items before discounts and taxes are applied.
amount_total
property amount_total
Total of all items after discounts and taxes are applied.
billing_address_collection
property billing_address_collection
The value (auto or required) for whether Checkout collected the customer's billing address.
cancel_url
property cancel_url
The URL the customer will be directed to if they decide to cancel payment and return to your website.
client_reference_id
property client_reference_id
A unique string to reference the Checkout Session.
currency
property currency
Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer
attribute customer
customer_email
property customer_email
If provided, this value will be used when the Customer object is created.
display_items
property display_items
The line items, plans, or SKUs purchased by the customer.
expand_fields
attribute expand_fields
line_items
property line_items
The line items purchased by the customer.
locale
property locale
The IETF language tag of the locale Checkout is displayed in.
mode
property mode
The mode of the Checkout Session, one of payment, setup, or subscription.
payment_intent
attribute payment_intent
payment_method_types
property payment_method_types
The list of payment method types (e.g. card) that this Checkout Session is allowed to accept.
payment_status
property payment_status
The payment status of the Checkout Session, one of paid, unpaid, or no_payment_required.
setup_intent
attribute setup_intent
shipping_address_collection
property shipping_address_collection
When set, provides configuration for Checkout to collect a shipping address from a customer.
shipping_cost
property shipping_cost
The details of the customer cost of shipping, including the customer chosen ShippingRate.
shipping_details
property shipping_details
Shipping information for this Checkout Session.
shipping_options
property shipping_options
The shipping rate options applied to this Session.
status
property status
The status of the Checkout Session, one of open, complete, or expired.
stripe_class
attribute stripe_class
submit_type
property submit_type
Describes the type of transaction being performed by Checkout.
subscription
attribute subscription
success_url
property success_url
The URL the customer will be directed to after successful payment or subscription creation.
total_details
property total_details
Tax and discount details for the computed total amount.
url
property url
The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout.