stripity_stripe

defmodule Stripe.Checkout.Session do
  use Stripe.Entity

  @moduledoc "A Checkout Session represents your customer's session as they pay for\none-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)\nor [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a\nnew Session each time your customer attempts to pay.\n\nOnce payment is successful, the Checkout Session will contain a reference\nto the [Customer](https://stripe.com/docs/api/customers), and either the successful\n[PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active\n[Subscription](https://stripe.com/docs/api/subscriptions).\n\nYou can create a Checkout Session on your server and redirect to its URL\nto begin Checkout.\n\nRelated guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)"
  (
    defstruct [
      :line_items,
      :success_url,
      :allow_promotion_codes,
      :consent_collection,
      :mode,
      :currency_conversion,
      :ui_mode,
      :origin_context,
      :shipping_cost,
      :livemode,
      :customer,
      :billing_address_collection,
      :setup_intent,
      :after_expiration,
      :return_url,
      :created,
      :consent,
      :payment_intent,
      :expires_at,
      :customer_creation,
      :customer_details,
      :invoice,
      :wallet_options,
      :status,
      :payment_link,
      :amount_total,
      :id,
      :cancel_url,
      :automatic_tax,
      :adaptive_pricing,
      :phone_number_collection,
      :invoice_creation,
      :payment_method_options,
      :currency,
      :optional_items,
      :url,
      :object,
      :payment_method_collection,
      :client_secret,
      :discounts,
      :payment_method_types,
      :permissions,
      :tax_id_collection,
      :saved_payment_method_options,
      :client_reference_id,
      :customer_email,
      :collected_information,
      :recovered_from,
      :total_details,
      :locale,
      :shipping_options,
      :subscription,
      :name_collection,
      :redirect_on_completion,
      :amount_subtotal,
      :payment_status,
      :custom_fields,
      :metadata,
      :excluded_payment_method_types,
      :custom_text,
      :shipping_address_collection,
      :presentment_details,
      :branding_settings,
      :submit_type,
      :payment_method_configuration_details
    ]

    @typedoc "The `checkout.session` type.\n\n  * `adaptive_pricing` Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).\n  * `after_expiration` When set, provides configuration for actions to take if this Checkout Session expires.\n  * `allow_promotion_codes` Enables user redeemable promotion codes.\n  * `amount_subtotal` Total of all items before discounts or taxes are applied.\n  * `amount_total` Total of all items after discounts and taxes are applied.\n  * `automatic_tax` \n  * `billing_address_collection` Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.\n  * `branding_settings` \n  * `cancel_url` If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.\n  * `client_reference_id` A unique string to reference the Checkout Session. This can be a\ncustomer ID, a cart ID, or similar, and can be used to reconcile the\nSession with your internal systems.\n  * `client_secret` The client secret of your Checkout Session. Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. For `ui_mode: embedded`, the client secret is to be used when initializing Stripe.js embedded checkout.\n For `ui_mode: custom`, use the client secret with [initCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end.\n  * `collected_information` Information about the customer collected within the Checkout Session.\n  * `consent` Results of `consent_collection` for this session.\n  * `consent_collection` When set, provides configuration for the Checkout Session to gather active consent from customers.\n  * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n  * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n  * `currency_conversion` Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions created before 2025-03-31.\n  * `custom_fields` Collect additional information from your customer using custom fields. Up to 3 fields are supported.\n  * `custom_text` \n  * `customer` The ID of the customer for this Session.\nFor Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout\nwill create a new customer object based on information provided\nduring the payment flow unless an existing customer was provided when\nthe Session was created.\n  * `customer_creation` Configure whether a Checkout Session creates a Customer when the Checkout Session completes.\n  * `customer_details` The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.\n  * `customer_email` If provided, this value will be used when the Customer object is created.\nIf not provided, customers will be asked to enter their email address.\nUse this parameter to prefill customer data if you already have an email\non file. To access information about the customer once the payment flow is\ncomplete, use the `customer` attribute.\n  * `discounts` List of coupons and promotion codes attached to the Checkout Session.\n  * `excluded_payment_method_types` A list of the types of payment methods (e.g., `card`) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).\n  * `expires_at` The timestamp at which the Checkout Session will expire.\n  * `id` Unique identifier for the object.\n  * `invoice` ID of the invoice created by the Checkout Session, if it exists.\n  * `invoice_creation` Details on the state of invoice creation for the Checkout Session.\n  * `line_items` The line items purchased by the customer.\n  * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n  * `locale` The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.\n  * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n  * `mode` The mode of the Checkout Session.\n  * `name_collection` \n  * `object` String representing the object's type. Objects of the same type share the same value.\n  * `optional_items` The optional items presented to the customer at checkout.\n  * `origin_context` Where the user is coming from. This informs the optimizations that are applied to the session.\n  * `payment_intent` The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.\n  * `payment_link` The ID of the Payment Link that created this Session.\n  * `payment_method_collection` Configure whether a Checkout Session should collect a payment method. Defaults to `always`.\n  * `payment_method_configuration_details` Information about the payment method configuration used for this Checkout session if using dynamic payment methods.\n  * `payment_method_options` Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.\n  * `payment_method_types` A list of the types of payment methods (e.g. card) this Checkout\nSession is allowed to accept.\n  * `payment_status` The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.\nYou can use this value to decide when to fulfill your customer's order.\n  * `permissions` This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.\n\nFor specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.\n  * `phone_number_collection` \n  * `presentment_details` \n  * `recovered_from` The ID of the original expired Checkout Session that triggered the recovery flow.\n  * `redirect_on_completion` This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.\n  * `return_url` Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.\n  * `saved_payment_method_options` Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.\n  * `setup_intent` The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.\n  * `shipping_address_collection` When set, provides configuration for Checkout to collect a shipping address from a customer.\n  * `shipping_cost` The details of the customer cost of shipping, including the customer chosen ShippingRate.\n  * `shipping_options` The shipping rate options applied to this Session.\n  * `status` The status of the Checkout Session, one of `open`, `complete`, or `expired`.\n  * `submit_type` Describes the type of transaction being performed by Checkout in order to customize\nrelevant text on the page, such as the submit button. `submit_type` can only be\nspecified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.\n  * `subscription` The ID of the [Subscription](https://stripe.com/docs/api/subscriptions) for Checkout Sessions in `subscription` mode.\n  * `success_url` The URL the customer will be directed to after the payment or\nsubscription creation is successful.\n  * `tax_id_collection` \n  * `total_details` Tax and discount details for the computed total amount.\n  * `ui_mode` The UI mode of the Session. Defaults to `hosted`.\n  * `url` The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted`. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`\nThis value is only present when the session is active.\n  * `wallet_options` Wallet-specific configuration for this Checkout Session.\n"
    @type t :: %__MODULE__{
            adaptive_pricing: term | nil,
            after_expiration: term | nil,
            allow_promotion_codes: boolean | nil,
            amount_subtotal: integer | nil,
            amount_total: integer | nil,
            automatic_tax: term,
            billing_address_collection: binary | nil,
            branding_settings: term,
            cancel_url: binary | nil,
            client_reference_id: binary | nil,
            client_secret: binary | nil,
            collected_information: term | nil,
            consent: term | nil,
            consent_collection: term | nil,
            created: integer,
            currency: binary | nil,
            currency_conversion: term | nil,
            custom_fields: term,
            custom_text: term,
            customer: (binary | Stripe.Customer.t() | Stripe.DeletedCustomer.t()) | nil,
            customer_creation: binary | nil,
            customer_details: term | nil,
            customer_email: binary | nil,
            discounts: term | nil,
            excluded_payment_method_types: term,
            expires_at: integer,
            id: binary,
            invoice: (binary | Stripe.Invoice.t()) | nil,
            invoice_creation: term | nil,
            line_items: term,
            livemode: boolean,
            locale: binary | nil,
            metadata: term | nil,
            mode: binary,
            name_collection: term,
            object: binary,
            optional_items: term | nil,
            origin_context: binary | nil,
            payment_intent: (binary | Stripe.PaymentIntent.t()) | nil,
            payment_link: (binary | Stripe.PaymentLink.t()) | nil,
            payment_method_collection: binary | nil,
            payment_method_configuration_details: term | nil,
            payment_method_options: term | nil,
            payment_method_types: term,
            payment_status: binary,
            permissions: term | nil,
            phone_number_collection: term,
            presentment_details: term,
            recovered_from: binary | nil,
            redirect_on_completion: binary,
            return_url: binary,
            saved_payment_method_options: term | nil,
            setup_intent: (binary | Stripe.SetupIntent.t()) | nil,
            shipping_address_collection: term | nil,
            shipping_cost: term | nil,
            shipping_options: term,
            status: binary | nil,
            submit_type: binary | nil,
            subscription: (binary | Stripe.Subscription.t()) | nil,
            success_url: binary | nil,
            tax_id_collection: term,
            total_details: term | nil,
            ui_mode: binary | nil,
            url: binary | nil,
            wallet_options: term | nil
          }
  )

  (
    @typedoc "contains details about the ACSS Debit payment method options."
    @type acss_debit :: %{
            optional(:currency) => :cad | :usd,
            optional(:mandate_options) => mandate_options,
            optional(:setup_future_usage) => :none | :off_session | :on_session,
            optional(:target_date) => binary,
            optional(:verification_method) => :automatic | :instant | :microdeposits
          }
  )

  (
    @typedoc "Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing)."
    @type adaptive_pricing :: %{optional(:enabled) => boolean}
  )

  (
    @typedoc "Shipping address."
    @type address :: %{
            optional(:city) => binary,
            optional(:country) => binary,
            optional(:line1) => binary,
            optional(:line2) => binary,
            optional(:postal_code) => binary,
            optional(:state) => binary
          }
  )

  (
    @typedoc "When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order."
    @type adjustable_quantity :: %{
            optional(:enabled) => boolean,
            optional(:maximum) => integer,
            optional(:minimum) => integer
          }
  )

  (
    @typedoc "contains details about the Affirm payment method options."
    @type affirm :: %{
            optional(:capture_method) => :manual,
            optional(:setup_future_usage) => :none
          }
  )

  (
    @typedoc "Configure actions after a Checkout Session has expired."
    @type after_expiration :: %{optional(:recovery) => recovery}
  )

  (
    @typedoc nil
    @type after_submit :: %{optional(:message) => binary}
  )

  (
    @typedoc "contains details about the Afterpay Clearpay payment method options."
    @type afterpay_clearpay :: %{
            optional(:capture_method) => :manual,
            optional(:setup_future_usage) => :none
          }
  )

  (
    @typedoc "contains details about the Alipay payment method options."
    @type alipay :: %{optional(:setup_future_usage) => :none}
  )

  (
    @typedoc "contains details about the Alma payment method options."
    @type alma :: %{optional(:capture_method) => :manual}
  )

  (
    @typedoc "contains details about the AmazonPay payment method options."
    @type amazon_pay :: %{
            optional(:capture_method) => :manual,
            optional(:setup_future_usage) => :none | :off_session
          }
  )

  (
    @typedoc "contains details about the AU Becs Debit payment method options."
    @type au_becs_debit :: %{
            optional(:setup_future_usage) => :none,
            optional(:target_date) => binary
          }
  )

  (
    @typedoc "Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions."
    @type automatic_tax :: %{optional(:enabled) => boolean, optional(:liability) => liability}
  )

  (
    @typedoc "contains details about the Bacs Debit payment method options."
    @type bacs_debit :: %{
            optional(:mandate_options) => mandate_options,
            optional(:setup_future_usage) => :none | :off_session | :on_session,
            optional(:target_date) => binary
          }
  )

  (
    @typedoc "contains details about the Bancontact payment method options."
    @type bancontact :: %{optional(:setup_future_usage) => :none}
  )

  (
    @typedoc "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`."
    @type bank_transfer :: %{
            optional(:eu_bank_transfer) => eu_bank_transfer,
            optional(:requested_address_types) =>
              list(:aba | :iban | :sepa | :sort_code | :spei | :swift | :zengin),
            optional(:type) =>
              :eu_bank_transfer
              | :gb_bank_transfer
              | :jp_bank_transfer
              | :mx_bank_transfer
              | :us_bank_transfer
          }
  )

  (
    @typedoc "contains details about the Billie payment method options."
    @type billie :: %{optional(:capture_method) => :manual}
  )

  (
    @typedoc "Controls how prorations and invoices for subscriptions are calculated and orchestrated."
    @type billing_mode :: %{
            optional(:flexible) => flexible,
            optional(:type) => :classic | :flexible
          }
  )

  (
    @typedoc "contains details about the Boleto payment method options."
    @type boleto :: %{
            optional(:expires_after_days) => integer,
            optional(:setup_future_usage) => :none | :off_session | :on_session
          }
  )

  (
    @typedoc "The branding settings for the Checkout Session. This parameter is not allowed if ui_mode is `custom`."
    @type branding_settings :: %{
            optional(:background_color) => binary | binary,
            optional(:border_style) => :pill | :rectangular | :rounded,
            optional(:button_color) => binary | binary,
            optional(:display_name) => binary,
            optional(:font_family) =>
              :be_vietnam_pro
              | :bitter
              | :chakra_petch
              | :default
              | :hahmlet
              | :inconsolata
              | :inter
              | :lato
              | :lora
              | :m_plus_1_code
              | :montserrat
              | :noto_sans
              | :noto_sans_jp
              | :noto_serif
              | :nunito
              | :open_sans
              | :pridi
              | :pt_sans
              | :pt_serif
              | :raleway
              | :roboto
              | :roboto_slab
              | :source_sans_pro
              | :titillium_web
              | :ubuntu_mono
              | :zen_maru_gothic,
            optional(:icon) => icon,
            optional(:logo) => logo
          }
  )

  (
    @typedoc "Controls settings applied for collecting the customer's business name on the session."
    @type business :: %{optional(:enabled) => boolean, optional(:optional) => boolean}
  )

  (
    @typedoc "contains details about the Card payment method options."
    @type card :: %{
            optional(:capture_method) => :manual,
            optional(:installments) => installments,
            optional(:request_extended_authorization) => :if_available | :never,
            optional(:request_incremental_authorization) => :if_available | :never,
            optional(:request_multicapture) => :if_available | :never,
            optional(:request_overcapture) => :if_available | :never,
            optional(:request_three_d_secure) => :any | :automatic | :challenge,
            optional(:restrictions) => restrictions,
            optional(:setup_future_usage) => :off_session | :on_session,
            optional(:statement_descriptor_suffix_kana) => binary,
            optional(:statement_descriptor_suffix_kanji) => binary
          }
  )

  (
    @typedoc "contains details about the Cashapp Pay payment method options."
    @type cashapp :: %{
            optional(:capture_method) => :manual,
            optional(:setup_future_usage) => :none | :off_session | :on_session
          }
  )

  (
    @typedoc "Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions."
    @type collected_information :: %{optional(:shipping_details) => shipping_details}
  )

  (
    @typedoc "Configure fields for the Checkout Session to gather active consent from customers."
    @type consent_collection :: %{
            optional(:payment_method_reuse_agreement) => payment_method_reuse_agreement,
            optional(:promotions) => :auto | :none,
            optional(:terms_of_service) => :none | :required
          }
  )

  (
    @typedoc nil
    @type created :: %{
            optional(:gt) => integer,
            optional(:gte) => integer,
            optional(:lt) => integer,
            optional(:lte) => integer
          }
  )

  (
    @typedoc nil
    @type custom_fields :: %{
            optional(:dropdown) => dropdown,
            optional(:key) => binary,
            optional(:label) => label,
            optional(:numeric) => numeric,
            optional(:optional) => boolean,
            optional(:text) => text,
            optional(:type) => :dropdown | :numeric | :text
          }
  )

  (
    @typedoc "Display additional text for your customers using custom text."
    @type custom_text :: %{
            optional(:after_submit) => after_submit | binary,
            optional(:shipping_address) => shipping_address | binary,
            optional(:submit) => submit | binary,
            optional(:terms_of_service_acceptance) => terms_of_service_acceptance | binary
          }
  )

  (
    @typedoc "contains details about the Customer Balance payment method options."
    @type customer_balance :: %{
            optional(:bank_transfer) => bank_transfer,
            optional(:funding_type) => :bank_transfer,
            optional(:setup_future_usage) => :none
          }
  )

  (
    @typedoc nil
    @type customer_details :: %{optional(:email) => binary}
  )

  (
    @typedoc "Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided."
    @type customer_update :: %{
            optional(:address) => :auto | :never,
            optional(:name) => :auto | :never,
            optional(:shipping) => :auto | :never
          }
  )

  (
    @typedoc "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions."
    @type delivery_estimate :: %{optional(:maximum) => maximum, optional(:minimum) => minimum}
  )

  (
    @typedoc "contains details about the DemoPay payment method options."
    @type demo_pay :: %{optional(:setup_future_usage) => :none | :off_session}
  )

  (
    @typedoc nil
    @type discounts :: %{optional(:coupon) => binary, optional(:promotion_code) => binary}
  )

  (
    @typedoc "Configuration for `type=dropdown` fields."
    @type dropdown :: %{optional(:default_value) => binary, optional(:options) => list(options)}
  )

  (
    @typedoc "Defines how the subscription should behave when the user's free trial ends."
    @type end_behavior :: %{
            optional(:missing_payment_method) => :cancel | :create_invoice | :pause
          }
  )

  (
    @typedoc "contains details about the EPS payment method options."
    @type eps :: %{optional(:setup_future_usage) => :none}
  )

  (
    @typedoc "Configuration for eu_bank_transfer funding type."
    @type eu_bank_transfer :: %{optional(:country) => binary}
  )

  (
    @typedoc "Additional fields for Financial Connections Session creation"
    @type financial_connections :: %{
            optional(:permissions) =>
              list(:balances | :ownership | :payment_method | :transactions),
            optional(:prefetch) => list(:balances | :ownership | :transactions)
          }
  )

  (
    @typedoc "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`."
    @type fixed_amount :: %{
            optional(:amount) => integer,
            optional(:currency) => binary,
            optional(:currency_options) => map()
          }
  )

  (
    @typedoc "Configure behavior for flexible billing mode."
    @type flexible :: %{optional(:proration_discounts) => :included | :itemized}
  )

  (
    @typedoc "contains details about the FPX payment method options."
    @type fpx :: %{optional(:setup_future_usage) => :none}
  )

  (
    @typedoc "contains details about the Giropay payment method options."
    @type giropay :: %{optional(:setup_future_usage) => :none}
  )

  (
    @typedoc "contains details about the Grabpay payment method options."
    @type grabpay :: %{optional(:setup_future_usage) => :none}
  )

  (
    @typedoc "The icon for the Checkout Session. For best results, use a square image."
    @type icon :: %{
            optional(:file) => binary,
            optional(:type) => :file | :url,
            optional(:url) => binary
          }
  )

  (
    @typedoc "contains details about the Ideal payment method options."
    @type ideal :: %{optional(:setup_future_usage) => :none}
  )

  (
    @typedoc "Controls settings applied for collecting the customer's individual name on the session."
    @type individual :: %{optional(:enabled) => boolean, optional(:optional) => boolean}
  )

  (
    @typedoc "Installment options for card payments"
    @type installments :: %{optional(:enabled) => boolean}
  )

  (
    @typedoc "Generate a post-purchase Invoice for one-time payments."
    @type invoice_creation :: %{
            optional(:enabled) => boolean,
            optional(:invoice_data) => invoice_data
          }
  )

  (
    @typedoc "Parameters passed when creating invoices for payment-mode Checkout Sessions."
    @type invoice_data :: %{
            optional(:account_tax_ids) => list(binary) | binary,
            optional(:custom_fields) => list(custom_fields) | binary,
            optional(:description) => binary,
            optional(:footer) => binary,
            optional(:issuer) => issuer,
            optional(:metadata) => %{optional(binary) => binary},
            optional(:rendering_options) => rendering_options | binary
          }
  )

  (
    @typedoc "All invoices will be billed using the specified settings."
    @type invoice_settings :: %{optional(:issuer) => issuer}
  )

  (
    @typedoc "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account."
    @type issuer :: %{optional(:account) => binary, optional(:type) => :account | :self}
  )

  (
    @typedoc "contains details about the Kakao Pay payment method options."
    @type kakao_pay :: %{
            optional(:capture_method) => :manual,
            optional(:setup_future_usage) => :none | :off_session
          }
  )

  (
    @typedoc "contains details about the Klarna payment method options."
    @type klarna :: %{
            optional(:capture_method) => :manual,
            optional(:setup_future_usage) => :none,
            optional(:subscriptions) => list(subscriptions) | binary
          }
  )

  (
    @typedoc "contains details about the Konbini payment method options."
    @type konbini :: %{
            optional(:expires_after_days) => integer,
            optional(:setup_future_usage) => :none
          }
  )

  (
    @typedoc "contains details about the Korean card payment method options."
    @type kr_card :: %{
            optional(:capture_method) => :manual,
            optional(:setup_future_usage) => :none | :off_session
          }
  )

  (
    @typedoc "The label for the field, displayed to the customer."
    @type label :: %{optional(:custom) => binary, optional(:type) => :custom}
  )

  (
    @typedoc "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."
    @type liability :: %{optional(:account) => binary, optional(:type) => :account | :self}
  )

  (
    @typedoc nil
    @type line_items :: %{
            optional(:adjustable_quantity) => adjustable_quantity,
            optional(:dynamic_tax_rates) => list(binary),
            optional(:price) => binary,
            optional(:price_data) => price_data,
            optional(:quantity) => integer,
            optional(:tax_rates) => list(binary)
          }
  )

  (
    @typedoc "contains details about the Link payment method options."
    @type link :: %{
            optional(:capture_method) => :manual,
            optional(:setup_future_usage) => :none | :off_session
          }
  )

  (
    @typedoc "The logo for the Checkout Session."
    @type logo :: %{
            optional(:file) => binary,
            optional(:type) => :file | :url,
            optional(:url) => binary
          }
  )

  (
    @typedoc "Additional fields for Mandate creation"
    @type mandate_options :: %{
            optional(:custom_mandate_url) => binary | binary,
            optional(:default_for) => list(:invoice | :subscription),
            optional(:interval_description) => binary,
            optional(:payment_schedule) => :combined | :interval | :sporadic,
            optional(:transaction_type) => :business | :personal
          }
  )

  (
    @typedoc "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite."
    @type maximum :: %{
            optional(:unit) => :business_day | :day | :hour | :month | :week,
            optional(:value) => integer
          }
  )

  (
    @typedoc "The lower bound of the estimated range. If empty, represents no lower bound."
    @type minimum :: %{
            optional(:unit) => :business_day | :day | :hour | :month | :week,
            optional(:value) => integer
          }
  )

  (
    @typedoc "contains details about the Mobilepay payment method options."
    @type mobilepay :: %{
            optional(:capture_method) => :manual,
            optional(:setup_future_usage) => :none
          }
  )

  (
    @typedoc "contains details about the Multibanco payment method options."
    @type multibanco :: %{optional(:setup_future_usage) => :none}
  )

  (
    @typedoc "Controls name collection settings for the session.\n\nYou can configure Checkout to collect your customers' business names, individual names, or both. Each name field can be either required or optional.\n\nIf a [Customer](https://stripe.com/docs/api/customers) is created or provided, the names can be saved to the Customer object as well."
    @type name_collection :: %{
            optional(:business) => business,
            optional(:individual) => individual
          }
  )

  (
    @typedoc "contains details about the Naver Pay payment method options."
    @type naver_pay :: %{
            optional(:capture_method) => :manual,
            optional(:setup_future_usage) => :none | :off_session
          }
  )

  (
    @typedoc "Describes the upcoming charge for this subscription."
    @type next_billing :: %{optional(:amount) => integer, optional(:date) => binary}
  )

  (
    @typedoc "Configuration for `type=numeric` fields."
    @type numeric :: %{
            optional(:default_value) => binary,
            optional(:maximum_length) => integer,
            optional(:minimum_length) => integer
          }
  )

  (
    @typedoc nil
    @type optional_items :: %{
            optional(:adjustable_quantity) => adjustable_quantity,
            optional(:price) => binary,
            optional(:quantity) => integer
          }
  )

  (
    @typedoc nil
    @type options :: %{optional(:label) => binary, optional(:value) => binary}
  )

  (
    @typedoc "contains details about the OXXO payment method options."
    @type oxxo :: %{
            optional(:expires_after_days) => integer,
            optional(:setup_future_usage) => :none
          }
  )

  (
    @typedoc "contains details about the P24 payment method options."
    @type p24 :: %{
            optional(:setup_future_usage) => :none,
            optional(:tos_shown_and_accepted) => boolean
          }
  )

  (
    @typedoc "contains details about the PAYCO payment method options."
    @type payco :: %{optional(:capture_method) => :manual}
  )

  (
    @typedoc "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode."
    @type payment_intent_data :: %{
            optional(:application_fee_amount) => integer,
            optional(:capture_method) => :automatic | :automatic_async | :manual,
            optional(:description) => binary,
            optional(:metadata) => %{optional(binary) => binary},
            optional(:on_behalf_of) => binary,
            optional(:receipt_email) => binary,
            optional(:setup_future_usage) => :off_session | :on_session,
            optional(:shipping) => shipping,
            optional(:statement_descriptor) => binary,
            optional(:statement_descriptor_suffix) => binary,
            optional(:transfer_data) => transfer_data,
            optional(:transfer_group) => binary
          }
  )

  (
    @typedoc "This parameter allows you to set some attributes on the payment method created during a Checkout session."
    @type payment_method_data :: %{
            optional(:allow_redisplay) => :always | :limited | :unspecified
          }
  )

  (
    @typedoc "Payment-method-specific configuration."
    @type payment_method_options :: %{
            optional(:sofort) => sofort,
            optional(:customer_balance) => customer_balance,
            optional(:satispay) => satispay,
            optional(:boleto) => boleto,
            optional(:alipay) => alipay,
            optional(:au_becs_debit) => au_becs_debit,
            optional(:amazon_pay) => amazon_pay,
            optional(:bancontact) => bancontact,
            optional(:bacs_debit) => bacs_debit,
            optional(:affirm) => affirm,
            optional(:mobilepay) => mobilepay,
            optional(:pay_by_bank) => map(),
            optional(:grabpay) => grabpay,
            optional(:eps) => eps,
            optional(:billie) => billie,
            optional(:ideal) => ideal,
            optional(:pix) => pix,
            optional(:giropay) => giropay,
            optional(:multibanco) => multibanco,
            optional(:revolut_pay) => revolut_pay,
            optional(:klarna) => klarna,
            optional(:card) => card,
            optional(:twint) => twint,
            optional(:naver_pay) => naver_pay,
            optional(:acss_debit) => acss_debit,
            optional(:link) => link,
            optional(:kr_card) => kr_card,
            optional(:konbini) => konbini,
            optional(:p24) => p24,
            optional(:paypal) => paypal,
            optional(:fpx) => fpx,
            optional(:oxxo) => oxxo,
            optional(:paynow) => paynow,
            optional(:alma) => alma,
            optional(:wechat_pay) => wechat_pay,
            optional(:demo_pay) => demo_pay,
            optional(:samsung_pay) => samsung_pay,
            optional(:kakao_pay) => kakao_pay,
            optional(:cashapp) => cashapp,
            optional(:sepa_debit) => sepa_debit,
            optional(:afterpay_clearpay) => afterpay_clearpay,
            optional(:payco) => payco,
            optional(:us_bank_account) => us_bank_account,
            optional(:swish) => swish
          }
  )

  (
    @typedoc "Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method."
    @type payment_method_reuse_agreement :: %{optional(:position) => :auto | :hidden}
  )

  (
    @typedoc "contains details about the PayNow payment method options."
    @type paynow :: %{optional(:setup_future_usage) => :none}
  )

  (
    @typedoc "contains details about the PayPal payment method options."
    @type paypal :: %{
            optional(:capture_method) => :manual,
            optional(:preferred_locale) =>
              :"cs-CZ"
              | :"da-DK"
              | :"de-AT"
              | :"de-DE"
              | :"de-LU"
              | :"el-GR"
              | :"en-GB"
              | :"en-US"
              | :"es-ES"
              | :"fi-FI"
              | :"fr-BE"
              | :"fr-FR"
              | :"fr-LU"
              | :"hu-HU"
              | :"it-IT"
              | :"nl-BE"
              | :"nl-NL"
              | :"pl-PL"
              | :"pt-PT"
              | :"sk-SK"
              | :"sv-SE",
            optional(:reference) => binary,
            optional(:risk_correlation_id) => binary,
            optional(:setup_future_usage) => :none | :off_session
          }
  )

  (
    @typedoc "This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object. Can only be set when creating `embedded` or `custom` sessions.\n\nFor specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`."
    @type permissions :: %{optional(:update_shipping_details) => :client_only | :server_only}
  )

  (
    @typedoc "Controls phone number collection settings for the session.\n\nWe recommend that you review your privacy policy and check with your legal contacts\nbefore using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers)."
    @type phone_number_collection :: %{optional(:enabled) => boolean}
  )

  (
    @typedoc "contains details about the Pix payment method options."
    @type pix :: %{
            optional(:amount_includes_iof) => :always | :never,
            optional(:expires_after_seconds) => integer,
            optional(:setup_future_usage) => :none
          }
  )

  (
    @typedoc "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required."
    @type price_data :: %{
            optional(:currency) => binary,
            optional(:product) => binary,
            optional(:product_data) => product_data,
            optional(:recurring) => recurring,
            optional(:tax_behavior) => :exclusive | :inclusive | :unspecified,
            optional(:unit_amount) => integer,
            optional(:unit_amount_decimal) => binary
          }
  )

  (
    @typedoc "Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required."
    @type product_data :: %{
            optional(:description) => binary,
            optional(:images) => list(binary),
            optional(:metadata) => %{optional(binary) => binary},
            optional(:name) => binary,
            optional(:tax_code) => binary,
            optional(:unit_label) => binary
          }
  )

  (
    @typedoc "Configure a Checkout Session that can be used to recover an expired session."
    @type recovery :: %{
            optional(:allow_promotion_codes) => boolean,
            optional(:enabled) => boolean
          }
  )

  (
    @typedoc "The recurring components of a price such as `interval` and `interval_count`."
    @type recurring :: %{
            optional(:interval) => :day | :month | :week | :year,
            optional(:interval_count) => integer
          }
  )

  (
    @typedoc nil
    @type rendering_options :: %{
            optional(:amount_tax_display) => :exclude_tax | :include_inclusive_tax,
            optional(:template) => binary
          }
  )

  (
    @typedoc "Restrictions to apply to the card payment method. For example, you can block specific card brands."
    @type restrictions :: %{
            optional(:brands_blocked) =>
              list(:american_express | :discover_global_network | :mastercard | :visa)
          }
  )

  (
    @typedoc "contains details about the RevolutPay payment method options."
    @type revolut_pay :: %{
            optional(:capture_method) => :manual,
            optional(:setup_future_usage) => :none | :off_session
          }
  )

  (
    @typedoc "contains details about the Samsung Pay payment method options."
    @type samsung_pay :: %{optional(:capture_method) => :manual}
  )

  (
    @typedoc "contains details about the Satispay payment method options."
    @type satispay :: %{optional(:capture_method) => :manual}
  )

  (
    @typedoc "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode."
    @type saved_payment_method_options :: %{
            optional(:allow_redisplay_filters) => list(:always | :limited | :unspecified),
            optional(:payment_method_remove) => :disabled | :enabled,
            optional(:payment_method_save) => :disabled | :enabled
          }
  )

  (
    @typedoc "contains details about the Sepa Debit payment method options."
    @type sepa_debit :: %{
            optional(:mandate_options) => mandate_options,
            optional(:setup_future_usage) => :none | :off_session | :on_session,
            optional(:target_date) => binary
          }
  )

  (
    @typedoc "A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode."
    @type setup_intent_data :: %{
            optional(:description) => binary,
            optional(:metadata) => %{optional(binary) => binary},
            optional(:on_behalf_of) => binary
          }
  )

  (
    @typedoc "Shipping information for this payment."
    @type shipping :: %{
            optional(:address) => address,
            optional(:carrier) => binary,
            optional(:name) => binary,
            optional(:phone) => binary,
            optional(:tracking_number) => binary
          }
  )

  (
    @typedoc nil
    @type shipping_address :: %{optional(:message) => binary}
  )

  (
    @typedoc "When set, provides configuration for Checkout to collect a shipping address from a customer."
    @type shipping_address_collection :: %{
            optional(:allowed_countries) =>
              list(
                :AC
                | :AD
                | :AE
                | :AF
                | :AG
                | :AI
                | :AL
                | :AM
                | :AO
                | :AQ
                | :AR
                | :AT
                | :AU
                | :AW
                | :AX
                | :AZ
                | :BA
                | :BB
                | :BD
                | :BE
                | :BF
                | :BG
                | :BH
                | :BI
                | :BJ
                | :BL
                | :BM
                | :BN
                | :BO
                | :BQ
                | :BR
                | :BS
                | :BT
                | :BV
                | :BW
                | :BY
                | :BZ
                | :CA
                | :CD
                | :CF
                | :CG
                | :CH
                | :CI
                | :CK
                | :CL
                | :CM
                | :CN
                | :CO
                | :CR
                | :CV
                | :CW
                | :CY
                | :CZ
                | :DE
                | :DJ
                | :DK
                | :DM
                | :DO
                | :DZ
                | :EC
                | :EE
                | :EG
                | :EH
                | :ER
                | :ES
                | :ET
                | :FI
                | :FJ
                | :FK
                | :FO
                | :FR
                | :GA
                | :GB
                | :GD
                | :GE
                | :GF
                | :GG
                | :GH
                | :GI
                | :GL
                | :GM
                | :GN
                | :GP
                | :GQ
                | :GR
                | :GS
                | :GT
                | :GU
                | :GW
                | :GY
                | :HK
                | :HN
                | :HR
                | :HT
                | :HU
                | :ID
                | :IE
                | :IL
                | :IM
                | :IN
                | :IO
                | :IQ
                | :IS
                | :IT
                | :JE
                | :JM
                | :JO
                | :JP
                | :KE
                | :KG
                | :KH
                | :KI
                | :KM
                | :KN
                | :KR
                | :KW
                | :KY
                | :KZ
                | :LA
                | :LB
                | :LC
                | :LI
                | :LK
                | :LR
                | :LS
                | :LT
                | :LU
                | :LV
                | :LY
                | :MA
                | :MC
                | :MD
                | :ME
                | :MF
                | :MG
                | :MK
                | :ML
                | :MM
                | :MN
                | :MO
                | :MQ
                | :MR
                | :MS
                | :MT
                | :MU
                | :MV
                | :MW
                | :MX
                | :MY
                | :MZ
                | :NA
                | :NC
                | :NE
                | :NG
                | :NI
                | :NL
                | :NO
                | :NP
                | :NR
                | :NU
                | :NZ
                | :OM
                | :PA
                | :PE
                | :PF
                | :PG
                | :PH
                | :PK
                | :PL
                | :PM
                | :PN
                | :PR
                | :PS
                | :PT
                | :PY
                | :QA
                | :RE
                | :RO
                | :RS
                | :RU
                | :RW
                | :SA
                | :SB
                | :SC
                | :SD
                | :SE
                | :SG
                | :SH
                | :SI
                | :SJ
                | :SK
                | :SL
                | :SM
                | :SN
                | :SO
                | :SR
                | :SS
                | :ST
                | :SV
                | :SX
                | :SZ
                | :TA
                | :TC
                | :TD
                | :TF
                | :TG
                | :TH
                | :TJ
                | :TK
                | :TL
                | :TM
                | :TN
                | :TO
                | :TR
                | :TT
                | :TV
                | :TW
                | :TZ
                | :UA
                | :UG
                | :US
                | :UY
                | :UZ
                | :VA
                | :VC
                | :VE
                | :VG
                | :VN
                | :VU
                | :WF
                | :WS
                | :XK
                | :YE
                | :YT
                | :ZA
                | :ZM
                | :ZW
                | :ZZ
              )
          }
  )

  (
    @typedoc "The shipping details to apply to this Session."
    @type shipping_details :: %{optional(:address) => address, optional(:name) => binary}
  )

  (
    @typedoc nil
    @type shipping_options :: %{
            optional(:shipping_rate) => binary,
            optional(:shipping_rate_data) => shipping_rate_data
          }
  )

  (
    @typedoc "Parameters to be passed to Shipping Rate creation for this shipping option."
    @type shipping_rate_data :: %{
            optional(:delivery_estimate) => delivery_estimate,
            optional(:display_name) => binary,
            optional(:fixed_amount) => fixed_amount,
            optional(:metadata) => %{optional(binary) => binary},
            optional(:tax_behavior) => :exclusive | :inclusive | :unspecified,
            optional(:tax_code) => binary,
            optional(:type) => :fixed_amount
          }
  )

  (
    @typedoc "contains details about the Sofort payment method options."
    @type sofort :: %{optional(:setup_future_usage) => :none}
  )

  (
    @typedoc nil
    @type submit :: %{optional(:message) => binary}
  )

  (
    @typedoc "A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode."
    @type subscription_data :: %{
            optional(:application_fee_percent) => number,
            optional(:billing_cycle_anchor) => integer,
            optional(:billing_mode) => billing_mode,
            optional(:default_tax_rates) => list(binary),
            optional(:description) => binary,
            optional(:invoice_settings) => invoice_settings,
            optional(:metadata) => %{optional(binary) => binary},
            optional(:on_behalf_of) => binary,
            optional(:proration_behavior) => :create_prorations | :none,
            optional(:transfer_data) => transfer_data,
            optional(:trial_end) => integer,
            optional(:trial_period_days) => integer,
            optional(:trial_settings) => trial_settings
          }
  )

  (
    @typedoc nil
    @type subscriptions :: %{
            optional(:interval) => :day | :month | :week | :year,
            optional(:interval_count) => integer,
            optional(:name) => binary,
            optional(:next_billing) => next_billing,
            optional(:reference) => binary
          }
  )

  (
    @typedoc "contains details about the Swish payment method options."
    @type swish :: %{optional(:reference) => binary}
  )

  (
    @typedoc "Controls tax ID collection during checkout."
    @type tax_id_collection :: %{
            optional(:enabled) => boolean,
            optional(:required) => :if_supported | :never
          }
  )

  (
    @typedoc nil
    @type terms_of_service_acceptance :: %{optional(:message) => binary}
  )

  (
    @typedoc "Configuration for `type=text` fields."
    @type text :: %{
            optional(:default_value) => binary,
            optional(:maximum_length) => integer,
            optional(:minimum_length) => integer
          }
  )

  (
    @typedoc "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges."
    @type transfer_data :: %{
            optional(:amount_percent) => number,
            optional(:destination) => binary
          }
  )

  (
    @typedoc "Settings related to subscription trials."
    @type trial_settings :: %{optional(:end_behavior) => end_behavior}
  )

  (
    @typedoc "contains details about the TWINT payment method options."
    @type twint :: %{optional(:setup_future_usage) => :none}
  )

  (
    @typedoc "contains details about the Us Bank Account payment method options."
    @type us_bank_account :: %{
            optional(:financial_connections) => financial_connections,
            optional(:setup_future_usage) => :none | :off_session | :on_session,
            optional(:target_date) => binary,
            optional(:verification_method) => :automatic | :instant
          }
  )

  (
    @typedoc "Wallet-specific configuration."
    @type wallet_options :: %{optional(:link) => link}
  )

  (
    @typedoc "contains details about the WeChat Pay payment method options."
    @type wechat_pay :: %{
            optional(:app_id) => binary,
            optional(:client) => :android | :ios | :web,
            optional(:setup_future_usage) => :none
          }
  )

  (
    nil

    @doc "<p>Returns a list of Checkout Sessions.</p>\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/checkout/sessions`\n"
    (
      @spec list(
              params :: %{
                optional(:created) => created | integer,
                optional(:customer) => binary,
                optional(:customer_details) => customer_details,
                optional(:ending_before) => binary,
                optional(:expand) => list(binary),
                optional(:limit) => integer,
                optional(:payment_intent) => binary,
                optional(:payment_link) => binary,
                optional(:starting_after) => binary,
                optional(:status) => :complete | :expired | :open,
                optional(:subscription) => binary
              },
              opts :: Keyword.t()
            ) ::
              {:ok, Stripe.List.t(Stripe.Checkout.Session.t())}
              | {:error, Stripe.ApiErrors.t()}
              | {:error, term()}
      def list(params \\ %{}, opts \\ []) do
        path = Stripe.OpenApi.Path.replace_path_params("/v1/checkout/sessions", [], [])

        Stripe.Request.new_request(opts)
        |> Stripe.Request.put_endpoint(path)
        |> Stripe.Request.put_params(params)
        |> Stripe.Request.put_method(:get)
        |> Stripe.Request.make_request()
      end
    )
  )

  (
    nil

    @doc "<p>Retrieves a Checkout Session object.</p>\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/checkout/sessions/{session}`\n"
    (
      @spec retrieve(
              session :: binary(),
              params :: %{optional(:expand) => list(binary)},
              opts :: Keyword.t()
            ) ::
              {:ok, Stripe.Checkout.Session.t()}
              | {:error, Stripe.ApiErrors.t()}
              | {:error, term()}
      def retrieve(session, params \\ %{}, opts \\ []) do
        path =
          Stripe.OpenApi.Path.replace_path_params(
            "/v1/checkout/sessions/{session}",
            [
              %{
                __struct__: OpenApiGen.Blueprint.Parameter,
                in: "path",
                name: "session",
                required: true,
                schema: %{
                  __struct__: OpenApiGen.Blueprint.Parameter.Schema,
                  any_of: [],
                  items: [],
                  name: "session",
                  properties: [],
                  title: nil,
                  type: "string"
                }
              }
            ],
            [session]
          )

        Stripe.Request.new_request(opts)
        |> Stripe.Request.put_endpoint(path)
        |> Stripe.Request.put_params(params)
        |> Stripe.Request.put_method(:get)
        |> Stripe.Request.make_request()
      end
    )
  )

  (
    nil

    @doc "<p>When retrieving a Checkout Session, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/checkout/sessions/{session}/line_items`\n"
    (
      @spec list_line_items(
              session :: binary(),
              params :: %{
                optional(:ending_before) => binary,
                optional(:expand) => list(binary),
                optional(:limit) => integer,
                optional(:starting_after) => binary
              },
              opts :: Keyword.t()
            ) ::
              {:ok, Stripe.List.t(Stripe.Item.t())}
              | {:error, Stripe.ApiErrors.t()}
              | {:error, term()}
      def list_line_items(session, params \\ %{}, opts \\ []) do
        path =
          Stripe.OpenApi.Path.replace_path_params(
            "/v1/checkout/sessions/{session}/line_items",
            [
              %{
                __struct__: OpenApiGen.Blueprint.Parameter,
                in: "path",
                name: "session",
                required: true,
                schema: %{
                  __struct__: OpenApiGen.Blueprint.Parameter.Schema,
                  any_of: [],
                  items: [],
                  name: "session",
                  properties: [],
                  title: nil,
                  type: "string"
                }
              }
            ],
            [session]
          )

        Stripe.Request.new_request(opts)
        |> Stripe.Request.put_endpoint(path)
        |> Stripe.Request.put_params(params)
        |> Stripe.Request.put_method(:get)
        |> Stripe.Request.make_request()
      end
    )
  )

  (
    nil

    @doc "<p>Creates a Checkout Session object.</p>\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/checkout/sessions`\n"
    (
      @spec create(
              params :: %{
                optional(:submit_type) => :auto | :book | :donate | :pay | :subscribe,
                optional(:branding_settings) => branding_settings,
                optional(:shipping_address_collection) => shipping_address_collection,
                optional(:custom_text) => custom_text,
                optional(:excluded_payment_method_types) =>
                  list(
                    :acss_debit
                    | :affirm
                    | :afterpay_clearpay
                    | :alipay
                    | :alma
                    | :amazon_pay
                    | :au_becs_debit
                    | :bacs_debit
                    | :bancontact
                    | :billie
                    | :blik
                    | :boleto
                    | :card
                    | :cashapp
                    | :crypto
                    | :customer_balance
                    | :eps
                    | :fpx
                    | :giropay
                    | :grabpay
                    | :ideal
                    | :kakao_pay
                    | :klarna
                    | :konbini
                    | :kr_card
                    | :mb_way
                    | :mobilepay
                    | :multibanco
                    | :naver_pay
                    | :nz_bank_account
                    | :oxxo
                    | :p24
                    | :pay_by_bank
                    | :payco
                    | :paynow
                    | :paypal
                    | :pix
                    | :promptpay
                    | :revolut_pay
                    | :samsung_pay
                    | :satispay
                    | :sepa_debit
                    | :sofort
                    | :swish
                    | :twint
                    | :us_bank_account
                    | :wechat_pay
                    | :zip
                  ),
                optional(:metadata) => %{optional(binary) => binary},
                optional(:custom_fields) => list(custom_fields),
                optional(:setup_intent_data) => setup_intent_data,
                optional(:redirect_on_completion) => :always | :if_required | :never,
                optional(:payment_method_configuration) => binary,
                optional(:name_collection) => name_collection,
                optional(:shipping_options) => list(shipping_options),
                optional(:locale) =>
                  :auto
                  | :bg
                  | :cs
                  | :da
                  | :de
                  | :el
                  | :en
                  | :"en-GB"
                  | :es
                  | :"es-419"
                  | :et
                  | :fi
                  | :fil
                  | :fr
                  | :"fr-CA"
                  | :hr
                  | :hu
                  | :id
                  | :it
                  | :ja
                  | :ko
                  | :lt
                  | :lv
                  | :ms
                  | :mt
                  | :nb
                  | :nl
                  | :pl
                  | :pt
                  | :"pt-BR"
                  | :ro
                  | :ru
                  | :sk
                  | :sl
                  | :sv
                  | :th
                  | :tr
                  | :vi
                  | :zh
                  | :"zh-HK"
                  | :"zh-TW",
                optional(:payment_intent_data) => payment_intent_data,
                optional(:customer_email) => binary,
                optional(:client_reference_id) => binary,
                optional(:saved_payment_method_options) => saved_payment_method_options,
                optional(:tax_id_collection) => tax_id_collection,
                optional(:permissions) => permissions,
                optional(:payment_method_types) =>
                  list(
                    :acss_debit
                    | :affirm
                    | :afterpay_clearpay
                    | :alipay
                    | :alma
                    | :amazon_pay
                    | :au_becs_debit
                    | :bacs_debit
                    | :bancontact
                    | :billie
                    | :blik
                    | :boleto
                    | :card
                    | :cashapp
                    | :crypto
                    | :customer_balance
                    | :eps
                    | :fpx
                    | :giropay
                    | :grabpay
                    | :ideal
                    | :kakao_pay
                    | :klarna
                    | :konbini
                    | :kr_card
                    | :link
                    | :mb_way
                    | :mobilepay
                    | :multibanco
                    | :naver_pay
                    | :nz_bank_account
                    | :oxxo
                    | :p24
                    | :pay_by_bank
                    | :payco
                    | :paynow
                    | :paypal
                    | :pix
                    | :promptpay
                    | :revolut_pay
                    | :samsung_pay
                    | :satispay
                    | :sepa_debit
                    | :sofort
                    | :swish
                    | :twint
                    | :us_bank_account
                    | :wechat_pay
                    | :zip
                  ),
                optional(:discounts) => list(discounts),
                optional(:payment_method_collection) => :always | :if_required,
                optional(:optional_items) => list(optional_items),
                optional(:currency) => binary,
                optional(:payment_method_options) => payment_method_options,
                optional(:invoice_creation) => invoice_creation,
                optional(:phone_number_collection) => phone_number_collection,
                optional(:adaptive_pricing) => adaptive_pricing,
                optional(:automatic_tax) => automatic_tax,
                optional(:cancel_url) => binary,
                optional(:wallet_options) => wallet_options,
                optional(:customer_creation) => :always | :if_required,
                optional(:expires_at) => integer,
                optional(:subscription_data) => subscription_data,
                optional(:return_url) => binary,
                optional(:after_expiration) => after_expiration,
                optional(:billing_address_collection) => :auto | :required,
                optional(:customer) => binary,
                optional(:expand) => list(binary),
                optional(:payment_method_data) => payment_method_data,
                optional(:origin_context) => :mobile_app | :web,
                optional(:ui_mode) => :custom | :embedded | :hosted,
                optional(:mode) => :payment | :setup | :subscription,
                optional(:consent_collection) => consent_collection,
                optional(:allow_promotion_codes) => boolean,
                optional(:success_url) => binary,
                optional(:line_items) => list(line_items),
                optional(:customer_update) => customer_update
              },
              opts :: Keyword.t()
            ) ::
              {:ok, Stripe.Checkout.Session.t()}
              | {:error, Stripe.ApiErrors.t()}
              | {:error, term()}
      def create(params \\ %{}, opts \\ []) do
        path = Stripe.OpenApi.Path.replace_path_params("/v1/checkout/sessions", [], [])

        Stripe.Request.new_request(opts)
        |> Stripe.Request.put_endpoint(path)
        |> Stripe.Request.put_params(params)
        |> Stripe.Request.put_method(:post)
        |> Stripe.Request.make_request()
      end
    )
  )

  (
    nil

    @doc "<p>Updates a Checkout Session object.</p>\n\n<p>Related guide: <a href=\"/payments/checkout/dynamic-updates\">Dynamically update Checkout</a></p>\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/checkout/sessions/{session}`\n"
    (
      @spec update(
              session :: binary(),
              params :: %{
                optional(:collected_information) => collected_information,
                optional(:expand) => list(binary),
                optional(:metadata) => %{optional(binary) => binary} | binary,
                optional(:shipping_options) => list(shipping_options) | binary
              },
              opts :: Keyword.t()
            ) ::
              {:ok, Stripe.Checkout.Session.t()}
              | {:error, Stripe.ApiErrors.t()}
              | {:error, term()}
      def update(session, params \\ %{}, opts \\ []) do
        path =
          Stripe.OpenApi.Path.replace_path_params(
            "/v1/checkout/sessions/{session}",
            [
              %{
                __struct__: OpenApiGen.Blueprint.Parameter,
                in: "path",
                name: "session",
                required: true,
                schema: %{
                  __struct__: OpenApiGen.Blueprint.Parameter.Schema,
                  any_of: [],
                  items: [],
                  name: "session",
                  properties: [],
                  title: nil,
                  type: "string"
                }
              }
            ],
            [session]
          )

        Stripe.Request.new_request(opts)
        |> Stripe.Request.put_endpoint(path)
        |> Stripe.Request.put_params(params)
        |> Stripe.Request.put_method(:post)
        |> Stripe.Request.make_request()
      end
    )
  )

  (
    nil

    @doc "<p>A Checkout Session can be expired when it is in one of these statuses: <code>open</code> </p>\n\n<p>After it expires, a customer can’t complete a Checkout Session and customers loading the Checkout Session see a message saying the Checkout Session is expired.</p>\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/checkout/sessions/{session}/expire`\n"
    (
      @spec expire(
              session :: binary(),
              params :: %{optional(:expand) => list(binary)},
              opts :: Keyword.t()
            ) ::
              {:ok, Stripe.Checkout.Session.t()}
              | {:error, Stripe.ApiErrors.t()}
              | {:error, term()}
      def expire(session, params \\ %{}, opts \\ []) do
        path =
          Stripe.OpenApi.Path.replace_path_params(
            "/v1/checkout/sessions/{session}/expire",
            [
              %{
                __struct__: OpenApiGen.Blueprint.Parameter,
                in: "path",
                name: "session",
                required: true,
                schema: %{
                  __struct__: OpenApiGen.Blueprint.Parameter.Schema,
                  any_of: [],
                  items: [],
                  name: "session",
                  properties: [],
                  title: nil,
                  type: "string"
                }
              }
            ],
            [session]
          )

        Stripe.Request.new_request(opts)
        |> Stripe.Request.put_endpoint(path)
        |> Stripe.Request.put_params(params)
        |> Stripe.Request.put_method(:post)
        |> Stripe.Request.make_request()
      end
    )
  )
end