---
title: "BillingCustomerStripeCreateCheckoutSessionRequest"
url: "https://nov18-dev.movespot.fyi/apis/konnect-metering-billing-0/versions/1801ac42-b9c2-4bc2-8094-1177df9ed25c/schemas/BillingCustomerStripeCreateCheckoutSessionRequest"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-metering-billing-0/versions/1801ac42-b9c2-4bc2-8094-1177df9ed25c.md

# BillingCustomerStripeCreateCheckoutSessionRequest

Request to create a Stripe Checkout Session for the customer. Checkout Sessions are used to collect payment method information from customers in a secure, Stripe-hosted interface. This integration uses setup mode to collect payment methods that can be charged later for subscription billing.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Metering & Billing
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
components:
  schemas:
    BillingCustomerStripeCreateCheckoutSessionRequest:
      description: >-
        Request to create a Stripe Checkout Session for the customer.


        Checkout Sessions are used to collect payment method information from
        customers

        in a secure, Stripe-hosted interface. This integration uses setup mode
        to collect

        payment methods that can be charged later for subscription billing.
      type: object
      properties:
        stripe_options:
          description: >-
            Options for configuring the Stripe Checkout Session.


            These options are passed directly to Stripe's [checkout session
            creation API](https://docs.stripe.com/api/checkout/sessions/create).
          type: object
          properties:
            billing_address_collection:
              description: >-
                Whether to collect the customer's billing address.


                Defaults to auto, which only collects the address when necessary
                for tax calculation.
              type: string
              default: auto
              enum:
                - auto
                - required
            cancel_url:
              description: |-
                URL to redirect customers who cancel the checkout session.

                Not allowed when ui_mode is "embedded".
              type: string
            client_reference_id:
              description: >-
                Unique reference string for reconciling sessions with internal
                systems.


                Can be a customer ID, cart ID, or any other identifier.
              type: string
            customer_update:
              description: Controls which customer fields can be updated by the checkout
                session.
              type: object
              properties:
                address:
                  description: |-
                    Whether to save the billing address to customer.address.

                    Defaults to "never".
                  type: string
                  default: never
                  enum:
                    - auto
                    - never
                name:
                  description: |-
                    Whether to save the customer name to customer.name.

                    Defaults to "never".
                  type: string
                  default: never
                  enum:
                    - auto
                    - never
                shipping:
                  description: |-
                    Whether to save shipping information to customer.shipping.

                    Defaults to "never".
                  type: string
                  default: never
                  enum:
                    - auto
                    - never
            consent_collection:
              description: Configuration for collecting customer consent during checkout.
              type: object
              properties:
                payment_method_reuse_agreement:
                  description: Controls the visibility of payment method reuse agreement.
                  type: object
                  properties:
                    position:
                      description: Position and visibility of the payment method reuse agreement.
                      type: string
                      enum:
                        - auto
                        - hidden
                promotions:
                  description: >-
                    Enables collection of promotional communication consent.


                    Only available to US merchants. When set to "auto", Checkout
                    determines

                    whether to show the option based on the customer's locale.
                  type: string
                  enum:
                    - auto
                    - none
                terms_of_service:
                  description: >-
                    Requires customers to accept terms of service before
                    payment.


                    Requires a valid terms of service URL in your Stripe
                    Dashboard settings.
                  type: string
                  enum:
                    - none
                    - required
            currency:
              description: >-
                Three-letter ISO 4217 currency code in uppercase.


                Required for payment mode sessions. Optional for setup mode
                sessions.
              type: string
              example: USD
              maxLength: 3
              minLength: 3
              pattern: ^[A-Z]{3}$
            custom_text:
              description: Custom text to display during checkout at various stages.
              type: object
              properties:
                after_submit:
                  description: Text displayed after the payment confirmation button.
                  type: object
                  properties:
                    message:
                      description: The custom message text (max 1200 characters).
                      type: string
                      maxLength: 1200
                shipping_address:
                  description: Text displayed alongside shipping address collection.
                  type: object
                  properties:
                    message:
                      description: The custom message text (max 1200 characters).
                      type: string
                      maxLength: 1200
                submit:
                  description: Text displayed alongside the payment confirmation button.
                  type: object
                  properties:
                    message:
                      description: The custom message text (max 1200 characters).
                      type: string
                      maxLength: 1200
                terms_of_service_acceptance:
                  description: Text replacing the default terms of service agreement text.
                  type: object
                  properties:
                    message:
                      description: The custom message text (max 1200 characters).
                      type: string
                      maxLength: 1200
            expires_at:
              description: >-
                Unix timestamp when the checkout session expires.


                Can be 30 minutes to 24 hours from creation. Defaults to 24
                hours.
              type: integer
              format: int64
            locale:
              description: >-
                IETF language tag for the checkout UI locale.


                If blank or "auto", uses the browser's locale. Example: "en",
                "fr", "de".
              type: string
            metadata:
              description: |-
                Set of key-value pairs to attach to the checkout session.

                Useful for storing additional structured information.
              type: object
              additionalProperties:
                type: string
            return_url:
              description: >-
                Return URL for embedded checkout sessions after payment
                authentication.


                Required if ui_mode is "embedded" and redirect-based payment
                methods are enabled.
              type: string
            success_url:
              description: >-
                Success URL to redirect customers after completing payment or
                setup.


                Not allowed when ui_mode is "embedded".

                See:
                https://docs.stripe.com/payments/checkout/custom-success-page
              type: string
            ui_mode:
              description: >-
                The UI mode for the checkout session.


                "hosted" displays a Stripe-hosted page. "embedded" integrates
                directly into your app.

                Defaults to "hosted".
              type: string
              default: hosted
              enum:
                - embedded
                - hosted
            payment_method_types:
              description: >-
                List of payment method types to enable (e.g., "card",
                "us_bank_account").


                If not specified, Stripe enables all relevant payment methods.
              type: array
              items:
                type: string
            redirect_on_completion:
              description: |-
                Redirect behavior for embedded checkout sessions.

                Controls when to redirect users after completion.
                See: https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form
              type: string
              enum:
                - always
                - if_required
                - never
            tax_id_collection:
              description: Configuration for collecting tax IDs during checkout.
              type: object
              properties:
                enabled:
                  description: |-
                    Enable tax ID collection during checkout.

                    Defaults to false.
                  type: boolean
                  default: false
                required:
                  description: |-
                    Whether tax ID collection is required.

                    Defaults to "never".
                  type: string
                  default: never
                  enum:
                    - if_supported
                    - never
      required:
        - stripe_options
```
