openapi: 3.0.0
info:
  title: Stripe Accounts Account Post API
  description: This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.
  contact:
    email: dev-platform@stripe.com
    name: Stripe Dev Platform Team
    url: https://stripe.com
  termsOfService: https://stripe.com/us/terms/
  version: '2023-10-16'
  x-stripeSpecFilename: spec3
servers:
- url: https://api.stripe.com/
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Post
paths:
  /v1/apps/secrets:
    post:
      description: <p>Create or replace a secret in the secret store.</p>
      operationId: postAppsSecrets
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              scope:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              properties:
                expand:
                  description: Specifies which fields in the response should be expanded.
                  items:
                    maxLength: 5000
                    type: string
                  type: array
                expires_at:
                  description: The Unix timestamp for the expiry time of the secret, after which the secret deletes.
                  format: unix-time
                  type: integer
                name:
                  description: A name for the secret that's unique within the scope.
                  maxLength: 5000
                  type: string
                payload:
                  description: The plaintext secret value to be stored.
                  maxLength: 5000
                  type: string
                scope:
                  description: Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
                  properties:
                    type:
                      enum:
                      - account
                      - user
                      type: string
                    user:
                      maxLength: 5000
                      type: string
                  required:
                  - type
                  title: scope_param
                  type: object
              required:
              - name
              - payload
              - scope
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apps.secret'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post Apps Secrets
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/apps/secrets/delete:
    post:
      description: <p>Deletes a secret from the secret store by name and scope.</p>
      operationId: postAppsSecretsDelete
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              scope:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              properties:
                expand:
                  description: Specifies which fields in the response should be expanded.
                  items:
                    maxLength: 5000
                    type: string
                  type: array
                name:
                  description: A name for the secret that's unique within the scope.
                  maxLength: 5000
                  type: string
                scope:
                  description: Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
                  properties:
                    type:
                      enum:
                      - account
                      - user
                      type: string
                    user:
                      maxLength: 5000
                      type: string
                  required:
                  - type
                  title: scope_param
                  type: object
              required:
              - name
              - scope
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apps.secret'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post Apps Secrets Delete
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/billing_portal/configurations:
    post:
      description: <p>Creates a configuration that describes the functionality and behavior of a PortalSession</p>
      operationId: postBillingPortalConfigurations
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              business_profile:
                explode: true
                style: deepObject
              default_return_url:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              features:
                explode: true
                style: deepObject
              login_page:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostBillingPortalConfigurationsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/billing_portal.configuration'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Billing Portal Configurations
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/billing_portal/configurations/{configuration}:
    post:
      description: <p>Updates a configuration that describes the functionality of the customer portal.</p>
      operationId: postBillingPortalConfigurationsConfiguration
      parameters:
      - in: path
        name: configuration
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              business_profile:
                explode: true
                style: deepObject
              default_return_url:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              features:
                explode: true
                style: deepObject
              login_page:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostBillingPortalConfigurationsConfigurationRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/billing_portal.configuration'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Billing Portal Configurations Configuration
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/billing_portal/sessions:
    post:
      description: <p>Creates a session of the customer portal.</p>
      operationId: postBillingPortalSessions
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              flow_data:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostBillingPortalSessionsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/billing_portal.session'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Billing Portal Sessions
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/checkout/sessions:
    post:
      description: <p>Creates a Session object.</p>
      operationId: postCheckoutSessions
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              after_expiration:
                explode: true
                style: deepObject
              automatic_tax:
                explode: true
                style: deepObject
              consent_collection:
                explode: true
                style: deepObject
              custom_fields:
                explode: true
                style: deepObject
              custom_text:
                explode: true
                style: deepObject
              customer_update:
                explode: true
                style: deepObject
              discounts:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              invoice_creation:
                explode: true
                style: deepObject
              line_items:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              payment_intent_data:
                explode: true
                style: deepObject
              payment_method_options:
                explode: true
                style: deepObject
              payment_method_types:
                explode: true
                style: deepObject
              phone_number_collection:
                explode: true
                style: deepObject
              setup_intent_data:
                explode: true
                style: deepObject
              shipping_address_collection:
                explode: true
                style: deepObject
              shipping_options:
                explode: true
                style: deepObject
              subscription_data:
                explode: true
                style: deepObject
              tax_id_collection:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCheckoutSessionsRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkout.session'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Checkout Sessions
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/checkout/sessions/{session}/expire:
    post:
      description: '<p>A Session can be expired when it is in one of these statuses: <code>open</code> </p>


        <p>After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.</p>'
      operationId: postCheckoutSessionsSessionExpire
      parameters:
      - in: path
        name: session
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCheckoutSessionsSessionExpireRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkout.session'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Checkout Sessions Session Expire
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/coupons:
    post:
      description: '<p>You can create coupons easily via the <a href="https://dashboard.stripe.com/coupons">coupon management</a> page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.</p>


        <p>A coupon has either a <code>percent_off</code> or an <code>amount_off</code> and <code>currency</code>. If you set an <code>amount_off</code>, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of <currency>100</currency> will have a final total of <currency>0</currency> if a coupon with an <code>amount_off</code> of <amount>200</amount> is applied to it and an invoice with a subtotal of <currency>300</currency> will have a final total of <currency>100</currency> if a coupon with an <code>amount_off</code> of <amount>200</amount> is applied to it.</p>'
      operationId: postCoupons
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              applies_to:
                explode: true
                style: deepObject
              currency_options:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCouponsRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/coupon'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Coupons
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        PullTagsFromSummary: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/coupons/{coupon}:
    post:
      description: <p>Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.</p>
      operationId: postCouponsCoupon
      parameters:
      - in: path
        name: coupon
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              currency_options:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCouponsCouponRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/coupon'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Coupons Coupon
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        PullTagsFromSummary: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/credit_notes:
    post:
      description: '<p>Issue a credit note to adjust the amount of a finalized invoice. For a <code>status=open</code> invoice, a credit note reduces

        its <code>amount_due</code>. For a <code>status=paid</code> invoice, a credit note does not affect its <code>amount_due</code>. Instead, it can result

        in any combination of the following:</p>


        <ul>

        <li>Refund: create a new refund (using <code>refund_amount</code>) or link an existing refund (using <code>refund</code>).</li>

        <li>Customer balance credit: credit the customer’s balance (using <code>credit_amount</code>) which will be automatically applied to their next invoice when it’s finalized.</li>

        <li>Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using <code>out_of_band_amount</code>).</li>

        </ul>


        <p>For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.</p>


        <p>You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s <code>pre_payment_credit_notes_amount</code>

        or <code>post_payment_credit_notes_amount</code> depending on its <code>status</code> at the time of credit note creation.</p>'
      operationId: postCreditNotes
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              lines:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              shipping_cost:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCreditNotesRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/credit_note'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Credit Notes
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/credit_notes/{id}:
    post:
      description: <p>Updates an existing credit note.</p>
      operationId: postCreditNotesId
      parameters:
      - in: path
        name: id
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCreditNotesIdRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/credit_note'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Credit Notes Id
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/credit_notes/{id}/void:
    post:
      description: <p>Marks a credit note as void. Learn more about <a href="/docs/billing/invoices/credit-notes#voiding">voiding credit notes</a>.</p>
      operationId: postCreditNotesIdVoid
      parameters:
      - in: path
        name: id
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCreditNotesIdVoidRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/credit_note'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Credit Notes Id Void
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers:
    post:
      description: <p>Creates a new customer object.</p>
      operationId: postCustomers
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              address:
                explode: true
                style: deepObject
              cash_balance:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              invoice_settings:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              preferred_locales:
                explode: true
                style: deepObject
              shipping:
                explode: true
                style: deepObject
              tax:
                explode: true
                style: deepObject
              tax_id_data:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customer'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}:
    post:
      description: '<p>Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the <strong>source</strong> parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the <strong>source</strong> parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the <code>past_due</code> state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the <strong>default_source</strong> for a customer will not trigger this behavior.</p>


        <p>This request accepts mostly the same arguments as the customer creation call.</p>'
      operationId: postCustomersCustomer
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              address:
                explode: true
                style: deepObject
              bank_account:
                explode: true
                style: deepObject
              card:
                explode: true
                style: deepObject
              cash_balance:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              invoice_settings:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              preferred_locales:
                explode: true
                style: deepObject
              shipping:
                explode: true
                style: deepObject
              tax:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customer'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}/balance_transactions:
    post:
      description: <p>Creates an immutable transaction that updates the customer’s credit <a href="/docs/billing/customer/balance">balance</a>.</p>
      operationId: postCustomersCustomerBalanceTransactions
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerBalanceTransactionsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customer_balance_transaction'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer Balance Transactions
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}/balance_transactions/{transaction}:
    post:
      description: <p>Most credit balance transaction fields are immutable, but you may update its <code>description</code> and <code>metadata</code>.</p>
      operationId: postCustomersCustomerBalanceTransactionsTransaction
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      - in: path
        name: transaction
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerBalanceTransactionsTransactionRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customer_balance_transaction'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer Balance Transactions Transaction
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}/bank_accounts:
    post:
      description: '<p>When you create a new credit card, you must specify a customer or recipient on which to create it.</p>


        <p>If the card’s owner has no default card, then the new card will become the default.

        However, if the owner already has a default, then it will not change.

        To change the default, you should <a href="/docs/api#update_customer">update the customer</a> to have a new <code>default_source</code>.</p>'
      operationId: postCustomersCustomerBankAccounts
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              bank_account:
                explode: true
                style: deepObject
              card:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerBankAccountsRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_source'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer Bank Accounts
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}/bank_accounts/{id}:
    post:
      description: <p>Update a specified source for a given customer.</p>
      operationId: postCustomersCustomerBankAccountsId
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              owner:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerBankAccountsIdRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/card'
                - $ref: '#/components/schemas/bank_account'
                - $ref: '#/components/schemas/source'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer Bank Accounts Id
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}/bank_accounts/{id}/verify:
    post:
      description: <p>Verify a specified bank account for a given customer.</p>
      operationId: postCustomersCustomerBankAccountsIdVerify
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              amounts:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerBankAccountsIdVerifyRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bank_account'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer Bank Accounts Id Verify
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}/cards:
    post:
      description: '<p>When you create a new credit card, you must specify a customer or recipient on which to create it.</p>


        <p>If the card’s owner has no default card, then the new card will become the default.

        However, if the owner already has a default, then it will not change.

        To change the default, you should <a href="/docs/api#update_customer">update the customer</a> to have a new <code>default_source</code>.</p>'
      operationId: postCustomersCustomerCards
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              bank_account:
                explode: true
                style: deepObject
              card:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerCardsRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_source'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer Cards
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}/cards/{id}:
    post:
      description: <p>Update a specified source for a given customer.</p>
      operationId: postCustomersCustomerCardsId
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              owner:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerCardsIdRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/card'
                - $ref: '#/components/schemas/bank_account'
                - $ref: '#/components/schemas/source'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer Cards Id
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}/cash_balance:
    post:
      description: <p>Changes the settings on a customer’s cash balance.</p>
      operationId: postCustomersCustomerCashBalance
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              settings:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerCashBalanceRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cash_balance'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer Cash Balance
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}/funding_instructions:
    post:
      description: '<p>Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new

        funding instructions will be created. If funding instructions have already been created for a given customer, the same

        funding instructions will be retrieved. In other words, we will return the same funding instructions each time.</p>'
      operationId: postCustomersCustomerFundingInstructions
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              bank_transfer:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerFundingInstructionsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/funding_instructions'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer Funding Instructions
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}/sources:
    post:
      description: '<p>When you create a new credit card, you must specify a customer or recipient on which to create it.</p>


        <p>If the card’s owner has no default card, then the new card will become the default.

        However, if the owner already has a default, then it will not change.

        To change the default, you should <a href="/docs/api#update_customer">update the customer</a> to have a new <code>default_source</code>.</p>'
      operationId: postCustomersCustomerSources
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              bank_account:
                explode: true
                style: deepObject
              card:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerSourcesRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_source'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer Sources
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}/sources/{id}:
    post:
      description: <p>Update a specified source for a given customer.</p>
      operationId: postCustomersCustomerSourcesId
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              owner:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerSourcesIdRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/card'
                - $ref: '#/components/schemas/bank_account'
                - $ref: '#/components/schemas/source'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer Sources Id
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}/sources/{id}/verify:
    post:
      description: <p>Verify a specified bank account for a given customer.</p>
      operationId: postCustomersCustomerSourcesIdVerify
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              amounts:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerSourcesIdVerifyRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bank_account'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer Sources Id Verify
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}/subscriptions:
    post:
      description: <p>Creates a new subscription on an existing customer.</p>
      operationId: postCustomersCustomerSubscriptions
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              add_invoice_items:
                explode: true
                style: deepObject
              automatic_tax:
                explode: true
                style: deepObject
              billing_thresholds:
                explode: true
                style: deepObject
              default_tax_rates:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              items:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              payment_settings:
                explode: true
                style: deepObject
              pending_invoice_item_interval:
                explode: true
                style: deepObject
              transfer_data:
                explode: true
                style: deepObject
              trial_end:
                explode: true
                style: deepObject
              trial_settings:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerSubscriptionsRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subscription'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer Subscriptions
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}/subscriptions/{subscription_exposed_id}:
    post:
      description: <p>Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the <a href="#upcoming_invoice">upcoming invoice</a> endpoint.</p>
      operationId: postCustomersCustomerSubscriptionsSubscriptionExposedId
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      - in: path
        name: subscription_exposed_id
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              add_invoice_items:
                explode: true
                style: deepObject
              automatic_tax:
                explode: true
                style: deepObject
              billing_thresholds:
                explode: true
                style: deepObject
              cancel_at:
                explode: true
                style: deepObject
              cancellation_details:
                explode: true
                style: deepObject
              default_source:
                explode: true
                style: deepObject
              default_tax_rates:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              items:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              pause_collection:
                explode: true
                style: deepObject
              payment_settings:
                explode: true
                style: deepObject
              pending_invoice_item_interval:
                explode: true
                style: deepObject
              transfer_data:
                explode: true
                style: deepObject
              trial_end:
                explode: true
                style: deepObject
              trial_settings:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subscription'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer Subscriptions Subscription Exposed Id
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/customers/{customer}/tax_ids:
    post:
      description: <p>Creates a new <code>tax_id</code> object for a customer.</p>
      operationId: postCustomersCustomerTaxIds
      parameters:
      - in: path
        name: customer
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostCustomersCustomerTaxIdsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tax_id'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Customers Customer Tax Ids
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/disputes/{dispute}:
    post:
      description: '<p>When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your <a href="https://dashboard.stripe.com/disputes">dashboard</a>, but if you prefer, you can use the API to submit evidence programmatically.</p>


        <p>Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our <a href="/docs/disputes/categories">guide to dispute types</a>.</p>'
      operationId: postDisputesDispute
      parameters:
      - in: path
        name: dispute
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              evidence:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostDisputesDisputeRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dispute'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Disputes Dispute
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/disputes/{dispute}/close:
    post:
      description: '<p>Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.</p>


        <p>The status of the dispute will change from <code>needs_response</code> to <code>lost</code>. <em>Closing a dispute is irreversible</em>.</p>'
      operationId: postDisputesDisputeClose
      parameters:
      - in: path
        name: dispute
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostDisputesDisputeCloseRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dispute'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Disputes Dispute Close
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/ephemeral_keys:
    post:
      description: <p>Creates a short-lived API key for a given resource.</p>
      operationId: postEphemeralKeys
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostEphemeralKeysRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ephemeral_key'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Ephemeral Keys
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/files:
    post:
      description: '<p>To upload a file to Stripe, you need to send a request of type <code>multipart/form-data</code>. Include the file you want to upload in the request, and the parameters for creating a file.</p>


        <p>All of Stripe’s officially supported Client libraries support sending <code>multipart/form-data</code>.</p>'
      operationId: postFiles
      requestBody:
        content:
          multipart/form-data:
            encoding:
              expand:
                explode: true
                style: deepObject
              file_link_data:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostFilesRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/file'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      servers:
      - url: https://files.stripe.com/
      summary: Stripe Post   Files
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/financial_connections/accounts/{account}/disconnect:
    post:
      description: <p>Disables your access to a Financial Connections <code>Account</code>. You will no longer be able to access data associated with the account (e.g. balances, transactions).</p>
      operationId: postFinancialConnectionsAccountsAccountDisconnect
      parameters:
      - in: path
        name: account
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostFinancialConnectionsAccountsAccountDisconnectRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/financial_connections.account'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Financial Connections Accounts Disconnect
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/financial_connections/accounts/{account}/refresh:
    post:
      description: <p>Refreshes the data associated with a Financial Connections <code>Account</code>.</p>
      operationId: postFinancialConnectionsAccountsAccountRefresh
      parameters:
      - in: path
        name: account
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              features:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostFinancialConnectionsAccountsAccountRefreshRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/financial_connections.account'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Financial Connections Accounts Refresh
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/financial_connections/accounts/{account}/subscribe:
    post:
      description: <p>Subscribes to periodic refreshes of data associated with a Financial Connections <code>Account</code>.</p>
      operationId: postFinancialConnectionsAccountsAccountSubscribe
      parameters:
      - in: path
        name: account
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              features:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostFinancialConnectionsAccountsAccountSubscribeRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/financial_connections.account'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Financial Connections Accounts Subscribe
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/financial_connections/accounts/{account}/unsubscribe:
    post:
      description: <p>Unsubscribes from periodic refreshes of data associated with a Financial Connections <code>Account</code>.</p>
      operationId: postFinancialConnectionsAccountsAccountUnsubscribe
      parameters:
      - in: path
        name: account
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              features:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostFinancialConnectionsAccountsAccountUnsubscribeRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/financial_connections.account'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Financial Connections Accounts Unsubscribe
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/financial_connections/sessions:
    post:
      description: <p>To launch the Financial Connections authorization flow, create a <code>Session</code>. The session’s <code>client_secret</code> can be used to launch the flow using Stripe.js.</p>
      operationId: postFinancialConnectionsSessions
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              account_holder:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              filters:
                explode: true
                style: deepObject
              permissions:
                explode: true
                style: deepObject
              prefetch:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostFinancialConnectionsSessionsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/financial_connections.session'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Financial Connections Sessions
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/identity/verification_sessions:
    post:
      description: '<p>Creates a VerificationSession object.</p>


        <p>After the VerificationSession is created, display a verification modal using the session <code>client_secret</code> or send your users to the session’s <code>url</code>.</p>


        <p>If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.</p>


        <p>Related guide: <a href="/docs/identity/verify-identity-documents">Verify your users’ identity documents</a></p>'
      operationId: postIdentityVerificationSessions
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              options:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIdentityVerificationSessionsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identity.verification_session'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Identity Verification Sessions
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/identity/verification_sessions/{session}:
    post:
      description: '<p>Updates a VerificationSession object.</p>


        <p>When the session status is <code>requires_input</code>, you can use this method to update the

        verification check and options.</p>'
      operationId: postIdentityVerificationSessionsSession
      parameters:
      - in: path
        name: session
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              options:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIdentityVerificationSessionsSessionRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identity.verification_session'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Identity Verification Sessions Session
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/identity/verification_sessions/{session}/cancel:
    post:
      description: '<p>A VerificationSession object can be canceled when it is in <code>requires_input</code> <a href="/docs/identity/how-sessions-work">status</a>.</p>


        <p>Once canceled, future submission attempts are disabled. This cannot be undone. <a href="/docs/identity/verification-sessions#cancel">Learn more</a>.</p>'
      operationId: postIdentityVerificationSessionsSessionCancel
      parameters:
      - in: path
        name: session
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIdentityVerificationSessionsSessionCancelRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identity.verification_session'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Identity Verification Sessions Session Cancel
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/identity/verification_sessions/{session}/redact:
    post:
      description: '<p>Redact a VerificationSession to remove all collected information from Stripe. This will redact

        the VerificationSession and all objects related to it, including VerificationReports, Events,

        request logs, etc.</p>


        <p>A VerificationSession object can be redacted when it is in <code>requires_input</code> or <code>verified</code>

        <a href="/docs/identity/how-sessions-work">status</a>. Redacting a VerificationSession in <code>requires_action</code>

        state will automatically cancel it.</p>


        <p>The redaction process may take up to four days. When the redaction process is in progress, the

        VerificationSession’s <code>redaction.status</code> field will be set to <code>processing</code>; when the process is

        finished, it will change to <code>redacted</code> and an <code>identity.verification_session.redacted</code> event

        will be emitted.</p>


        <p>Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the

        fields that contain personal data will be replaced by the string <code>[redacted]</code> or a similar

        placeholder. The <code>metadata</code> field will also be erased. Redacted objects cannot be updated or

        used for any purpose.</p>


        <p><a href="/docs/identity/verification-sessions#redact">Learn more</a>.</p>'
      operationId: postIdentityVerificationSessionsSessionRedact
      parameters:
      - in: path
        name: session
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIdentityVerificationSessionsSessionRedactRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identity.verification_session'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Identity Verification Sessions Session Redact
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/Invoice Items:
    post:
      description: <p>Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.</p>
      operationId: postInvoice Items
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              discounts:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              period:
                explode: true
                style: deepObject
              price_data:
                explode: true
                style: deepObject
              tax_code:
                explode: true
                style: deepObject
              tax_rates:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostInvoice ItemsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/invoiceitem'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Invoice Items
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/Invoice Items/{invoiceitem}:
    post:
      description: <p>Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.</p>
      operationId: postInvoice ItemsInvoiceitem
      parameters:
      - in: path
        name: invoiceitem
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              discounts:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              period:
                explode: true
                style: deepObject
              price_data:
                explode: true
                style: deepObject
              tax_code:
                explode: true
                style: deepObject
              tax_rates:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostInvoice ItemsInvoiceitemRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/invoiceitem'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Invoice Items
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/invoices:
    post:
      description: <p>This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you <a href="#finalize_invoice">finalize</a> the invoice, which allows you to <a href="#pay_invoice">pay</a> or <a href="#send_invoice">send</a> the invoice to your customers.</p>
      operationId: postInvoices
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              account_tax_ids:
                explode: true
                style: deepObject
              automatic_tax:
                explode: true
                style: deepObject
              custom_fields:
                explode: true
                style: deepObject
              default_tax_rates:
                explode: true
                style: deepObject
              discounts:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              from_invoice:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              payment_settings:
                explode: true
                style: deepObject
              rendering:
                explode: true
                style: deepObject
              shipping_cost:
                explode: true
                style: deepObject
              shipping_details:
                explode: true
                style: deepObject
              transfer_data:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostInvoicesRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/invoice'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Invoices
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/invoices/{invoice}:
    post:
      description: '<p>Draft invoices are fully editable. Once an invoice is <a href="/docs/billing/invoices/workflow#finalized">finalized</a>,

        monetary values, as well as <code>collection_method</code>, become uneditable.</p>


        <p>If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,

        sending reminders for, or <a href="/docs/billing/invoices/reconciliation">automatically reconciling</a> invoices, pass

        <code>auto_advance=false</code>.</p>'
      operationId: postInvoicesInvoice
      parameters:
      - in: path
        name: invoice
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              account_tax_ids:
                explode: true
                style: deepObject
              automatic_tax:
                explode: true
                style: deepObject
              custom_fields:
                explode: true
                style: deepObject
              default_source:
                explode: true
                style: deepObject
              default_tax_rates:
                explode: true
                style: deepObject
              discounts:
                explode: true
                style: deepObject
              effective_at:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              on_behalf_of:
                explode: true
                style: deepObject
              payment_settings:
                explode: true
                style: deepObject
              rendering:
                explode: true
                style: deepObject
              shipping_cost:
                explode: true
                style: deepObject
              shipping_details:
                explode: true
                style: deepObject
              transfer_data:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostInvoicesInvoiceRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/invoice'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Invoices Invoice
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/invoices/{invoice}/finalize:
    post:
      description: <p>Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.</p>
      operationId: postInvoicesInvoiceFinalize
      parameters:
      - in: path
        name: invoice
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostInvoicesInvoiceFinalizeRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/invoice'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Invoices Invoice Finalize
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/invoices/{invoice}/lines/{line_item_id}:
    post:
      description: '<p>Updates an invoice’s line item. Some fields, such as <code>tax_amounts</code>, only live on the invoice line item,

        so they can only be updated through this endpoint. Other fields, such as <code>amount</code>, live on both the invoice

        item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.

        Updating an invoice’s line item is only possible before the invoice is finalized.</p>'
      operationId: postInvoicesInvoiceLinesLineItemId
      parameters:
      - description: Invoice ID of line item
        in: path
        name: invoice
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      - description: Invoice line item ID
        in: path
        name: line_item_id
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              discounts:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              period:
                explode: true
                style: deepObject
              price_data:
                explode: true
                style: deepObject
              tax_amounts:
                explode: true
                style: deepObject
              tax_rates:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostInvoicesInvoiceLinesLineItemIdRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/line_item'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Invoices Invoice Lines Line Item Id
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/invoices/{invoice}/mark_uncollectible:
    post:
      description: <p>Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.</p>
      operationId: postInvoicesInvoiceMarkUncollectible
      parameters:
      - in: path
        name: invoice
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostInvoicesInvoiceMarkUncollectibleRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/invoice'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Invoices Invoice Mark Uncollectible
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/invoices/{invoice}/pay:
    post:
      description: <p>Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your <a href="https://dashboard.stripe.com/account/billing/automatic">subscriptions settings</a>. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.</p>
      operationId: postInvoicesInvoicePay
      parameters:
      - in: path
        name: invoice
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              mandate:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostInvoicesInvoicePayRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/invoice'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Invoices Invoice Pay
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/invoices/{invoice}/send:
    post:
      description: '<p>Stripe will automatically send invoices to customers according to your <a href="https://dashboard.stripe.com/account/billing/automatic">subscriptions settings</a>. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.</p>


        <p>Requests made in test-mode result in no emails being sent, despite sending an <code>invoice.sent</code> event.</p>'
      operationId: postInvoicesInvoiceSend
      parameters:
      - in: path
        name: invoice
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostInvoicesInvoiceSendRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/invoice'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Invoices Invoice Send
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/invoices/{invoice}/void:
    post:
      description: <p>Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to <a href="#delete_invoice">deletion</a>, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.</p>
      operationId: postInvoicesInvoiceVoid
      parameters:
      - in: path
        name: invoice
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostInvoicesInvoiceVoidRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/invoice'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Invoices Invoice Void
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/issuing/authorizations/{authorization}:
    post:
      description: <p>Updates the specified Issuing <code>Authorization</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
      operationId: postIssuingAuthorizationsAuthorization
      parameters:
      - in: path
        name: authorization
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIssuingAuthorizationsAuthorizationRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/issuing.authorization'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Issuing Authorizations
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/issuing/authorizations/{authorization}/approve:
    post:
      description: "<p>[Deprecated] Approves a pending Issuing <code>Authorization</code> object. This request should be made within the timeout window of the <a href=\"/docs/issuing/controls/real-time-authorizations\">real-time authorization</a> flow. \nThis method is deprecated. Instead, <a href=\"/docs/issuing/controls/real-time-authorizations#authorization-handling\">respond directly to the webhook request to approve an authorization</a>.</p>"
      operationId: postIssuingAuthorizationsAuthorizationApprove
      parameters:
      - in: path
        name: authorization
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIssuingAuthorizationsAuthorizationApproveRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/issuing.authorization'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Issuing Authorizations Approve
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/issuing/authorizations/{authorization}/decline:
    post:
      description: '<p>[Deprecated] Declines a pending Issuing <code>Authorization</code> object. This request should be made within the timeout window of the <a href="/docs/issuing/controls/real-time-authorizations">real time authorization</a> flow.

        This method is deprecated. Instead, <a href="/docs/issuing/controls/real-time-authorizations#authorization-handling">respond directly to the webhook request to decline an authorization</a>.</p>'
      operationId: postIssuingAuthorizationsAuthorizationDecline
      parameters:
      - in: path
        name: authorization
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIssuingAuthorizationsAuthorizationDeclineRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/issuing.authorization'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Issuing Authorizations Decline
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/issuing/cardholders:
    post:
      description: <p>Creates a new Issuing <code>Cardholder</code> object that can be issued cards.</p>
      operationId: postIssuingCardholders
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              billing:
                explode: true
                style: deepObject
              company:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              individual:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              preferred_locales:
                explode: true
                style: deepObject
              spending_controls:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIssuingCardholdersRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/issuing.cardholder'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Issuing Cardholders
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/issuing/cardholders/{cardholder}:
    post:
      description: <p>Updates the specified Issuing <code>Cardholder</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
      operationId: postIssuingCardholdersCardholder
      parameters:
      - in: path
        name: cardholder
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              billing:
                explode: true
                style: deepObject
              company:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              individual:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              preferred_locales:
                explode: true
                style: deepObject
              spending_controls:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIssuingCardholdersCardholderRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/issuing.cardholder'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Issuing Cardholders
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/issuing/cards:
    post:
      description: <p>Creates an Issuing <code>Card</code> object.</p>
      operationId: postIssuingCards
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              shipping:
                explode: true
                style: deepObject
              spending_controls:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIssuingCardsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/issuing.card'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Issuing Cards
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/issuing/cards/{card}:
    post:
      description: <p>Updates the specified Issuing <code>Card</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
      operationId: postIssuingCardsCard
      parameters:
      - in: path
        name: card
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              pin:
                explode: true
                style: deepObject
              spending_controls:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIssuingCardsCardRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/issuing.card'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Issuing Cards Card
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/issuing/disputes:
    post:
      description: <p>Creates an Issuing <code>Dispute</code> object. Individual pieces of evidence within the <code>evidence</code> object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to <a href="/docs/issuing/purchases/disputes#dispute-reasons-and-evidence">Dispute reasons and evidence</a> for more details about evidence requirements.</p>
      operationId: postIssuingDisputes
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              evidence:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              treasury:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIssuingDisputesRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/issuing.dispute'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Issuing Disputes
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/issuing/disputes/{dispute}:
    post:
      description: <p>Updates the specified Issuing <code>Dispute</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the <code>evidence</code> object can be unset by passing in an empty string.</p>
      operationId: postIssuingDisputesDispute
      parameters:
      - in: path
        name: dispute
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              evidence:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIssuingDisputesDisputeRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/issuing.dispute'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Issuing Disputes
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/issuing/disputes/{dispute}/submit:
    post:
      description: <p>Submits an Issuing <code>Dispute</code> to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see <a href="/docs/issuing/purchases/disputes#dispute-reasons-and-evidence">Dispute reasons and evidence</a>.</p>
      operationId: postIssuingDisputesDisputeSubmit
      parameters:
      - in: path
        name: dispute
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIssuingDisputesDisputeSubmitRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/issuing.dispute'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Issuing DisputesSubmit
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/issuing/settlements/{settlement}:
    post:
      description: <p>Updates the specified Issuing <code>Settlement</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
      operationId: postIssuingSettlementsSettlement
      parameters:
      - in: path
        name: settlement
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIssuingSettlementsSettlementRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/issuing.settlement'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Issuing Settlements Settlement
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/issuing/tokens/{token}:
    post:
      description: <p>Attempts to update the specified Issuing <code>Token</code> object to the status specified.</p>
      operationId: postIssuingTokensToken
      parameters:
      - in: path
        name: token
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIssuingTokensTokenRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/issuing.token'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Issuing Tokens
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/issuing/transactions/{transaction}:
    post:
      description: <p>Updates the specified Issuing <code>Transaction</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
      operationId: postIssuingTransactionsTransaction
      parameters:
      - in: path
        name: transaction
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostIssuingTransactionsTransactionRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/issuing.transaction'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Issuing Transactions
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/link_account_sessions:
    post:
      description: <p>To launch the Financial Connections authorization flow, create a <code>Session</code>. The session’s <code>client_secret</code> can be used to launch the flow using Stripe.js.</p>
      operationId: postLinkAccountSessions
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              account_holder:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              filters:
                explode: true
                style: deepObject
              permissions:
                explode: true
                style: deepObject
              prefetch:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostLinkAccountSessionsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/financial_connections.session'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Link Account Sessions
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/linked_accounts/{account}/disconnect:
    post:
      description: <p>Disables your access to a Financial Connections <code>Account</code>. You will no longer be able to access data associated with the account (e.g. balances, transactions).</p>
      operationId: postLinkedAccountsAccountDisconnect
      parameters:
      - in: path
        name: account
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostLinkedAccountsAccountDisconnectRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/financial_connections.account'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Linked Accounts Disconnect
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/linked_accounts/{account}/refresh:
    post:
      description: <p>Refreshes the data associated with a Financial Connections <code>Account</code>.</p>
      operationId: postLinkedAccountsAccountRefresh
      parameters:
      - in: path
        name: account
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              features:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostLinkedAccountsAccountRefreshRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/financial_connections.account'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Linked Accounts Refresh
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_intents:
    post:
      description: '<p>Creates a PaymentIntent object.</p>


        <p>After the PaymentIntent is created, attach a payment method and <a href="/docs/api/payment_intents/confirm">confirm</a>

        to continue the payment. Learn more about <a href="/docs/payments/payment-intents">the available payment flows

        with the Payment Intents API</a>.</p>


        <p>When you use <code>confirm=true</code> during creation, it’s equivalent to creating

        and confirming the PaymentIntent in the same call. You can use any parameters

        available in the <a href="/docs/api/payment_intents/confirm">confirm API</a> when you supply

        <code>confirm=true</code>.</p>'
      operationId: postPaymentIntents
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              automatic_payment_methods:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              mandate_data:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              off_session:
                explode: true
                style: deepObject
              payment_method_data:
                explode: true
                style: deepObject
              payment_method_options:
                explode: true
                style: deepObject
              payment_method_types:
                explode: true
                style: deepObject
              radar_options:
                explode: true
                style: deepObject
              shipping:
                explode: true
                style: deepObject
              transfer_data:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentIntentsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_intent'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Intents
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_intents/{intent}:
    post:
      description: '<p>Updates properties on a PaymentIntent object without confirming.</p>


        <p>Depending on which properties you update, you might need to confirm the

        PaymentIntent again. For example, updating the <code>payment_method</code>

        always requires you to confirm the PaymentIntent again. If you prefer to

        update and confirm at the same time, we recommend updating properties through

        the <a href="/docs/api/payment_intents/confirm">confirm API</a> instead.</p>'
      operationId: postPaymentIntentsIntent
      parameters:
      - in: path
        name: intent
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              application_fee_amount:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              payment_method_data:
                explode: true
                style: deepObject
              payment_method_options:
                explode: true
                style: deepObject
              payment_method_types:
                explode: true
                style: deepObject
              receipt_email:
                explode: true
                style: deepObject
              shipping:
                explode: true
                style: deepObject
              transfer_data:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentIntentsIntentRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_intent'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Intents
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_intents/{intent}/apply_customer_balance:
    post:
      description: <p>Manually reconcile the remaining amount for a <code>customer_balance</code> PaymentIntent.</p>
      operationId: postPaymentIntentsIntentApplyCustomerBalance
      parameters:
      - in: path
        name: intent
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentIntentsIntentApplyCustomerBalanceRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_intent'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Intents Apply Customer Balance
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_intents/{intent}/cancel:
    post:
      description: '<p>You can cancel a PaymentIntent object when it’s in one of these statuses: <code>requires_payment_method</code>, <code>requires_capture</code>, <code>requires_confirmation</code>, <code>requires_action</code> or, <a href="/docs/payments/intents">in rare cases</a>, <code>processing</code>. </p>


        <p>After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a <code>status</code> of <code>requires_capture</code>, the remaining <code>amount_capturable</code> is automatically refunded. </p>


        <p>You can’t cancel the PaymentIntent for a Checkout Session. <a href="/docs/api/checkout/sessions/expire">Expire the Checkout Session</a> instead.</p>'
      operationId: postPaymentIntentsIntentCancel
      parameters:
      - in: path
        name: intent
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentIntentsIntentCancelRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_intent'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Intents Cancel
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_intents/{intent}/capture:
    post:
      description: '<p>Capture the funds of an existing uncaptured PaymentIntent when its status is <code>requires_capture</code>.</p>


        <p>Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.</p>


        <p>Learn more about <a href="/docs/payments/capture-later">separate authorization and capture</a>.</p>'
      operationId: postPaymentIntentsIntentCapture
      parameters:
      - in: path
        name: intent
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              transfer_data:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentIntentsIntentCaptureRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_intent'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Intents Capture
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_intents/{intent}/confirm:
    post:
      description: '<p>Confirm that your customer intends to pay with current or provided

        payment method. Upon confirmation, the PaymentIntent will attempt to initiate

        a payment.

        If the selected payment method requires additional authentication steps, the

        PaymentIntent will transition to the <code>requires_action</code> status and

        suggest additional actions via <code>next_action</code>. If payment fails,

        the PaymentIntent transitions to the <code>requires_payment_method</code> status or the

        <code>canceled</code> status if the confirmation limit is reached. If

        payment succeeds, the PaymentIntent will transition to the <code>succeeded</code>

        status (or <code>requires_capture</code>, if <code>capture_method</code> is set to <code>manual</code>).

        If the <code>confirmation_method</code> is <code>automatic</code>, payment may be attempted

        using our <a href="/docs/stripe-js/reference#stripe-handle-card-payment">client SDKs</a>

        and the PaymentIntent’s <a href="#payment_intent_object-client_secret">client_secret</a>.

        After <code>next_action</code>s are handled by the client, no additional

        confirmation is required to complete the payment.

        If the <code>confirmation_method</code> is <code>manual</code>, all payment attempts must be

        initiated using a secret key.

        If any actions are required for the payment, the PaymentIntent will

        return to the <code>requires_confirmation</code> state

        after those actions are completed. Your server needs to then

        explicitly re-confirm the PaymentIntent to initiate the next payment

        attempt. Read the <a href="/docs/payments/payment-intents/web-manual">expanded documentation</a>

        to learn more about manual confirmation.</p>'
      operationId: postPaymentIntentsIntentConfirm
      parameters:
      - in: path
        name: intent
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              mandate_data:
                explode: true
                style: deepObject
              off_session:
                explode: true
                style: deepObject
              payment_method_data:
                explode: true
                style: deepObject
              payment_method_options:
                explode: true
                style: deepObject
              payment_method_types:
                explode: true
                style: deepObject
              radar_options:
                explode: true
                style: deepObject
              receipt_email:
                explode: true
                style: deepObject
              shipping:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentIntentsIntentConfirmRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_intent'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Intents Confirm
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_intents/{intent}/increment_authorization:
    post:
      description: '<p>Perform an incremental authorization on an eligible

        <a href="/docs/api/payment_intents/object">PaymentIntent</a>. To be eligible, the

        PaymentIntent’s status must be <code>requires_capture</code> and

        <a href="/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported">incremental_authorization_supported</a>

        must be <code>true</code>.</p>


        <p>Incremental authorizations attempt to increase the authorized amount on

        your customer’s card to the new, higher <code>amount</code> provided. Similar to the

        initial authorization, incremental authorizations can be declined. A

        single PaymentIntent can call this endpoint multiple times to further

        increase the authorized amount.</p>


        <p>If the incremental authorization succeeds, the PaymentIntent object

        returns with the updated

        <a href="/docs/api/payment_intents/object#payment_intent_object-amount">amount</a>.

        If the incremental authorization fails, a

        <a href="/docs/error-codes#card-declined">card_declined</a> error returns, and no other

        fields on the PaymentIntent or Charge update. The PaymentIntent

        object remains capturable for the previously authorized amount.</p>


        <p>Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.

        After it’s captured, a PaymentIntent can no longer be incremented.</p>


        <p>Learn more about <a href="/docs/terminal/features/incremental-authorizations">incremental authorizations</a>.</p>'
      operationId: postPaymentIntentsIntentIncrementAuthorization
      parameters:
      - in: path
        name: intent
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              transfer_data:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentIntentsIntentIncrementAuthorizationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_intent'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Intents Increment Authorization
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_intents/{intent}/verify_microdeposits:
    post:
      description: <p>Verifies microdeposits on a PaymentIntent object.</p>
      operationId: postPaymentIntentsIntentVerifyMicrodeposits
      parameters:
      - in: path
        name: intent
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              amounts:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentIntentsIntentVerifyMicrodepositsRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_intent'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Intents Verify Microdeposits
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_links:
    post:
      description: <p>Creates a payment link.</p>
      operationId: postPaymentLinks
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              after_completion:
                explode: true
                style: deepObject
              automatic_tax:
                explode: true
                style: deepObject
              consent_collection:
                explode: true
                style: deepObject
              custom_fields:
                explode: true
                style: deepObject
              custom_text:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              invoice_creation:
                explode: true
                style: deepObject
              line_items:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              payment_intent_data:
                explode: true
                style: deepObject
              payment_method_types:
                explode: true
                style: deepObject
              phone_number_collection:
                explode: true
                style: deepObject
              restrictions:
                explode: true
                style: deepObject
              shipping_address_collection:
                explode: true
                style: deepObject
              shipping_options:
                explode: true
                style: deepObject
              subscription_data:
                explode: true
                style: deepObject
              tax_id_collection:
                explode: true
                style: deepObject
              transfer_data:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentLinksRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_link'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Links
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_links/{payment_link}:
    post:
      description: <p>Updates a payment link.</p>
      operationId: postPaymentLinksPaymentLink
      parameters:
      - in: path
        name: payment_link
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              after_completion:
                explode: true
                style: deepObject
              automatic_tax:
                explode: true
                style: deepObject
              custom_fields:
                explode: true
                style: deepObject
              custom_text:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              inactive_message:
                explode: true
                style: deepObject
              invoice_creation:
                explode: true
                style: deepObject
              line_items:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              payment_intent_data:
                explode: true
                style: deepObject
              payment_method_types:
                explode: true
                style: deepObject
              restrictions:
                explode: true
                style: deepObject
              shipping_address_collection:
                explode: true
                style: deepObject
              subscription_data:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentLinksPaymentLinkRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_link'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Links
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_method_configurations:
    post:
      description: <p>Creates a payment method configuration</p>
      operationId: postPaymentMethodConfigurations
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              acss_debit:
                explode: true
                style: deepObject
              affirm:
                explode: true
                style: deepObject
              afterpay_clearpay:
                explode: true
                style: deepObject
              alipay:
                explode: true
                style: deepObject
              apple_pay:
                explode: true
                style: deepObject
              apple_pay_later:
                explode: true
                style: deepObject
              au_becs_debit:
                explode: true
                style: deepObject
              bacs_debit:
                explode: true
                style: deepObject
              bancontact:
                explode: true
                style: deepObject
              blik:
                explode: true
                style: deepObject
              boleto:
                explode: true
                style: deepObject
              card:
                explode: true
                style: deepObject
              cartes_bancaires:
                explode: true
                style: deepObject
              cashapp:
                explode: true
                style: deepObject
              eps:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              fpx:
                explode: true
                style: deepObject
              giropay:
                explode: true
                style: deepObject
              google_pay:
                explode: true
                style: deepObject
              grabpay:
                explode: true
                style: deepObject
              ideal:
                explode: true
                style: deepObject
              jcb:
                explode: true
                style: deepObject
              klarna:
                explode: true
                style: deepObject
              konbini:
                explode: true
                style: deepObject
              link:
                explode: true
                style: deepObject
              oxxo:
                explode: true
                style: deepObject
              p24:
                explode: true
                style: deepObject
              paynow:
                explode: true
                style: deepObject
              paypal:
                explode: true
                style: deepObject
              promptpay:
                explode: true
                style: deepObject
              revolut_pay:
                explode: true
                style: deepObject
              sepa_debit:
                explode: true
                style: deepObject
              sofort:
                explode: true
                style: deepObject
              us_bank_account:
                explode: true
                style: deepObject
              wechat_pay:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentMethodConfigurationsRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_method_configuration'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Method Configurations
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_method_configurations/{configuration}:
    post:
      description: <p>Update payment method configuration</p>
      operationId: postPaymentMethodConfigurationsConfiguration
      parameters:
      - in: path
        name: configuration
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              acss_debit:
                explode: true
                style: deepObject
              affirm:
                explode: true
                style: deepObject
              afterpay_clearpay:
                explode: true
                style: deepObject
              alipay:
                explode: true
                style: deepObject
              apple_pay:
                explode: true
                style: deepObject
              apple_pay_later:
                explode: true
                style: deepObject
              au_becs_debit:
                explode: true
                style: deepObject
              bacs_debit:
                explode: true
                style: deepObject
              bancontact:
                explode: true
                style: deepObject
              blik:
                explode: true
                style: deepObject
              boleto:
                explode: true
                style: deepObject
              card:
                explode: true
                style: deepObject
              cartes_bancaires:
                explode: true
                style: deepObject
              cashapp:
                explode: true
                style: deepObject
              eps:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              fpx:
                explode: true
                style: deepObject
              giropay:
                explode: true
                style: deepObject
              google_pay:
                explode: true
                style: deepObject
              grabpay:
                explode: true
                style: deepObject
              ideal:
                explode: true
                style: deepObject
              jcb:
                explode: true
                style: deepObject
              klarna:
                explode: true
                style: deepObject
              konbini:
                explode: true
                style: deepObject
              link:
                explode: true
                style: deepObject
              oxxo:
                explode: true
                style: deepObject
              p24:
                explode: true
                style: deepObject
              paynow:
                explode: true
                style: deepObject
              paypal:
                explode: true
                style: deepObject
              promptpay:
                explode: true
                style: deepObject
              revolut_pay:
                explode: true
                style: deepObject
              sepa_debit:
                explode: true
                style: deepObject
              sofort:
                explode: true
                style: deepObject
              us_bank_account:
                explode: true
                style: deepObject
              wechat_pay:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentMethodConfigurationsConfigurationRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_method_configuration'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Method Configurations
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_method_domains:
    post:
      description: <p>Creates a payment method domain.</p>
      operationId: postPaymentMethodDomains
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentMethodDomainsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_method_domain'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Method Domains
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_method_domains/{payment_method_domain}:
    post:
      description: <p>Updates an existing payment method domain.</p>
      operationId: postPaymentMethodDomainsPaymentMethodDomain
      parameters:
      - in: path
        name: payment_method_domain
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentMethodDomainsPaymentMethodDomainRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_method_domain'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Method Domains
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_method_domains/{payment_method_domain}/validate:
    post:
      description: '<p>Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain.

        The payment method doesn’t appear in Elements for this domain until it is active.</p>


        <p>To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.</p>


        <p>Related guides: <a href="/docs/payments/payment-methods/pmd-registration">Payment method domains</a>.</p>'
      operationId: postPaymentMethodDomainsPaymentMethodDomainValidate
      parameters:
      - in: path
        name: payment_method_domain
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentMethodDomainsPaymentMethodDomainValidateRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_method_domain'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Method Domains Validate
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_methods:
    post:
      description: '<p>Creates a PaymentMethod object. Read the <a href="/docs/stripe-js/reference#stripe-create-payment-method">Stripe.js reference</a> to learn how to create PaymentMethods via Stripe.js.</p>


        <p>Instead of creating a PaymentMethod directly, we recommend using the <a href="/docs/payments/accept-a-payment">PaymentIntents</a> API to accept a payment immediately or the <a href="/docs/payments/save-and-reuse">SetupIntent</a> API to collect payment method details ahead of a future payment.</p>'
      operationId: postPaymentMethods
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              acss_debit:
                explode: true
                style: deepObject
              affirm:
                explode: true
                style: deepObject
              afterpay_clearpay:
                explode: true
                style: deepObject
              alipay:
                explode: true
                style: deepObject
              au_becs_debit:
                explode: true
                style: deepObject
              bacs_debit:
                explode: true
                style: deepObject
              bancontact:
                explode: true
                style: deepObject
              billing_details:
                explode: true
                style: deepObject
              blik:
                explode: true
                style: deepObject
              boleto:
                explode: true
                style: deepObject
              card:
                explode: true
                style: deepObject
              cashapp:
                explode: true
                style: deepObject
              customer_balance:
                explode: true
                style: deepObject
              eps:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              fpx:
                explode: true
                style: deepObject
              giropay:
                explode: true
                style: deepObject
              grabpay:
                explode: true
                style: deepObject
              ideal:
                explode: true
                style: deepObject
              interac_present:
                explode: true
                style: deepObject
              klarna:
                explode: true
                style: deepObject
              konbini:
                explode: true
                style: deepObject
              link:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              oxxo:
                explode: true
                style: deepObject
              p24:
                explode: true
                style: deepObject
              paynow:
                explode: true
                style: deepObject
              paypal:
                explode: true
                style: deepObject
              pix:
                explode: true
                style: deepObject
              promptpay:
                explode: true
                style: deepObject
              radar_options:
                explode: true
                style: deepObject
              revolut_pay:
                explode: true
                style: deepObject
              sepa_debit:
                explode: true
                style: deepObject
              sofort:
                explode: true
                style: deepObject
              us_bank_account:
                explode: true
                style: deepObject
              wechat_pay:
                explode: true
                style: deepObject
              zip:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentMethodsRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_method'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Methods
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_methods/{payment_method}:
    post:
      description: <p>Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.</p>
      operationId: postPaymentMethodsPaymentMethod
      parameters:
      - in: path
        name: payment_method
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              billing_details:
                explode: true
                style: deepObject
              card:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              link:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              us_bank_account:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentMethodsPaymentMethodRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_method'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Methods
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_methods/{payment_method}/attach:
    post:
      description: '<p>Attaches a PaymentMethod object to a Customer.</p>


        <p>To attach a new PaymentMethod to a customer for future payments, we recommend you use a <a href="/docs/api/setup_intents">SetupIntent</a>

        or a PaymentIntent with <a href="/docs/api/payment_intents/create#create_payment_intent-setup_future_usage">setup_future_usage</a>.

        These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the <code>/v1/payment_methods/:id/attach</code>

        endpoint without first using a SetupIntent or PaymentIntent with <code>setup_future_usage</code> does not optimize the PaymentMethod for

        future use, which makes later declines and payment friction more likely.

        See <a href="/docs/payments/payment-intents#future-usage">Optimizing cards for future payments</a> for more information about setting up

        future payments.</p>


        <p>To use this PaymentMethod as the default for invoice or subscription payments,

        set <a href="/docs/api/customers/update#update_customer-invoice_settings-default_payment_method"><code>invoice_settings.default_payment_method</code></a>,

        on the Customer to the PaymentMethod’s ID.</p>'
      operationId: postPaymentMethodsPaymentMethodAttach
      parameters:
      - in: path
        name: payment_method
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentMethodsPaymentMethodAttachRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_method'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Methods Attach
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payment_methods/{payment_method}/detach:
    post:
      description: <p>Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.</p>
      operationId: postPaymentMethodsPaymentMethodDetach
      parameters:
      - in: path
        name: payment_method
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentMethodsPaymentMethodDetachRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_method'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Methods Detach
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payouts:
    post:
      description: '<p>To send funds to your own bank account, create a new payout object. Your <a href="#balance">Stripe balance</a> must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.</p>


        <p>If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.</p>


        <p>If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The <a href="#balance_object">balance object</a> details available and pending amounts by source type.</p>'
      operationId: postPayouts
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPayoutsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payout'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payouts
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payouts/{payout}:
    post:
      description: <p>Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.</p>
      operationId: postPayoutsPayout
      parameters:
      - in: path
        name: payout
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPayoutsPayoutRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payout'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payouts
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payouts/{payout}/cancel:
    post:
      description: <p>You can cancel a previously created payout if it hasn’t been paid out yet. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.</p>
      operationId: postPayoutsPayoutCancel
      parameters:
      - in: path
        name: payout
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPayoutsPayoutCancelRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payout'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payouts Cancel
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/payouts/{payout}/reverse:
    post:
      description: '<p>Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is in the <code>pending</code> status, use <code>/v1/payouts/:id/cancel</code> instead.</p>


        <p>By requesting a reversal through <code>/v1/payouts/:id/reverse</code>, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.</p>'
      operationId: postPayoutsPayoutReverse
      parameters:
      - in: path
        name: payout
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPayoutsPayoutReverseRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payout'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payouts Reverse
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/plans:
    post:
      description: <p>You can now model subscriptions more flexibly using the <a href="#prices">Prices API</a>. It replaces the Plans API and is backwards compatible to simplify your migration.</p>
      operationId: postPlans
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              product:
                explode: true
                style: deepObject
              tiers:
                explode: true
                style: deepObject
              transform_usage:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPlansRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/plan'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Plans
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/plans/{plan}:
    post:
      description: <p>Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.</p>
      operationId: postPlansPlan
      parameters:
      - in: path
        name: plan
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPlansPlanRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/plan'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Plans
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/prices:
    post:
      description: <p>Creates a new price for an existing product. The price can be recurring or one-time.</p>
      operationId: postPrices
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              currency_options:
                explode: true
                style: deepObject
              custom_unit_amount:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
              product_data:
                explode: true
                style: deepObject
              recurring:
                explode: true
                style: deepObject
              tiers:
                explode: true
                style: deepObject
              transform_quantity:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPricesRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/price'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Prices
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
  /v1/prices/{price}:
    post:
      description: <p>Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.</p>
      operationId: postPricesPrice
      parameters:
      - in: path
        name: price
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              currency_options:
                explode: true
                style: deepObject
              expand:
                explode: true
                style: deepObject
              metadata:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPricesPriceRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/price'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Prices
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Post
components:
  schemas:
    payment_method_configuration:
      description: 'PaymentMethodConfigurations control which payment methods are displayed to your customers when you don''t explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.


        There are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://stripe.com/docs/connect/charges):


        **Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.


        **Child** configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter.


        Child configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API.


        Related guides:

        - [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations)

        - [Multiple configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs)

        - [Multiple configurations for your Connect accounts](https://stripe.com/docs/connect/multiple-payment-method-configurations)'
      properties:
        acss_debit:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        active:
          description: Whether the configuration can be used for new payments.
          type: boolean
        affirm:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        afterpay_clearpay:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        alipay:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        apple_pay:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        application:
          description: For child configs, the Connect application associated with the configuration.
          maxLength: 5000
          nullable: true
          type: string
        au_becs_debit:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        bacs_debit:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        bancontact:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        blik:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        boleto:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        card:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        cartes_bancaires:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        cashapp:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        eps:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        fpx:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        giropay:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        google_pay:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        grabpay:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        ideal:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        is_default:
          description: The default configuration is used whenever a payment method configuration is not specified.
          type: boolean
        jcb:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        klarna:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        konbini:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        link:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        name:
          description: The configuration's name.
          maxLength: 5000
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - payment_method_configuration
          type: string
        oxxo:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        p24:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        parent:
          description: For child configs, the configuration's parent configuration.
          maxLength: 5000
          nullable: true
          type: string
        paynow:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        paypal:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        promptpay:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        revolut_pay:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        sepa_debit:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        sofort:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        us_bank_account:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
        wechat_pay:
          $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties'
      required:
      - active
      - id
      - is_default
      - livemode
      - name
      - object
      title: PaymentMethodConfigResourcePaymentMethodConfiguration
      type: object
      x-expandableFields:
      - acss_debit
      - affirm
      - afterpay_clearpay
      - alipay
      - apple_pay
      - au_becs_debit
      - bacs_debit
      - bancontact
      - blik
      - boleto
      - card
      - cartes_bancaires
      - cashapp
      - eps
      - fpx
      - giropay
      - google_pay
      - grabpay
      - ideal
      - jcb
      - klarna
      - konbini
      - link
      - oxxo
      - p24
      - paynow
      - paypal
      - promptpay
      - revolut_pay
      - sepa_debit
      - sofort
      - us_bank_account
      - wechat_pay
      x-resourceId: payment_method_configuration
    PostInvoicesInvoiceSendRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostPaymentLinksRequest:
      type: object
      required:
      - line_items
      properties:
        after_completion:
          description: Behavior after the purchase is complete.
          properties:
            hosted_confirmation:
              properties:
                custom_message:
                  maxLength: 500
                  type: string
              title: after_completion_confirmation_page_params
              type: object
            redirect:
              properties:
                url:
                  maxLength: 2048
                  type: string
              required:
              - url
              title: after_completion_redirect_params
              type: object
            type:
              enum:
              - hosted_confirmation
              - redirect
              type: string
          required:
          - type
          title: after_completion_params
          type: object
        allow_promotion_codes:
          description: Enables user redeemable promotion codes.
          type: boolean
        application_fee_amount:
          description: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Can only be applied when there are no line items with recurring prices.
          type: integer
        application_fee_percent:
          description: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.
          type: number
        automatic_tax:
          description: Configuration for automatic tax collection.
          properties:
            enabled:
              type: boolean
          required:
          - enabled
          title: automatic_tax_params
          type: object
        billing_address_collection:
          description: Configuration for collecting the customer's billing address.
          enum:
          - auto
          - required
          type: string
        consent_collection:
          description: Configure fields to gather active consent from customers.
          properties:
            payment_method_reuse_agreement:
              properties:
                position:
                  enum:
                  - auto
                  - hidden
                  type: string
              required:
              - position
              title: payment_method_reuse_agreement_params
              type: object
            promotions:
              enum:
              - auto
              - none
              type: string
            terms_of_service:
              enum:
              - none
              - required
              type: string
          title: consent_collection_params
          type: object
        currency:
          description: 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) and supported by each line item's price.
          type: string
        custom_fields:
          description: Collect additional information from your customer using custom fields. Up to 2 fields are supported.
          items:
            properties:
              dropdown:
                properties:
                  options:
                    items:
                      properties:
                        label:
                          maxLength: 100
                          type: string
                        value:
                          maxLength: 100
                          type: string
                      required:
                      - label
                      - value
                      title: custom_field_option_param
                      type: object
                    type: array
                required:
                - options
                title: custom_field_dropdown_param
                type: object
              key:
                maxLength: 200
                type: string
              label:
                properties:
                  custom:
                    maxLength: 50
                    type: string
                  type:
                    enum:
                    - custom
                    type: string
                required:
                - custom
                - type
                title: custom_field_label_param
                type: object
              numeric:
                properties:
                  maximum_length:
                    type: integer
                  minimum_length:
                    type: integer
                title: custom_field_numeric_param
                type: object
              optional:
                type: boolean
              text:
                properties:
                  maximum_length:
                    type: integer
                  minimum_length:
                    type: integer
                title: custom_field_text_param
                type: object
              type:
                enum:
                - dropdown
                - numeric
                - text
                type: string
            required:
            - key
            - label
            - type
            title: custom_field_param
            type: object
          type: array
        custom_text:
          description: Display additional text for your customers using custom text.
          properties:
            after_submit:
              anyOf:
              - properties:
                  message:
                    maxLength: 1200
                    type: string
                required:
                - message
                title: custom_text_position_param
                type: object
              - enum:
                - ''
                type: string
            shipping_address:
              anyOf:
              - properties:
                  message:
                    maxLength: 1200
                    type: string
                required:
                - message
                title: custom_text_position_param
                type: object
              - enum:
                - ''
                type: string
            submit:
              anyOf:
              - properties:
                  message:
                    maxLength: 1200
                    type: string
                required:
                - message
                title: custom_text_position_param
                type: object
              - enum:
                - ''
                type: string
            terms_of_service_acceptance:
              anyOf:
              - properties:
                  message:
                    maxLength: 1200
                    type: string
                required:
                - message
                title: custom_text_position_param
                type: object
              - enum:
                - ''
                type: string
          title: custom_text_param
          type: object
        customer_creation:
          description: Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).
          enum:
          - always
          - if_required
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        inactive_message:
          description: The custom message to be displayed to a customer when a payment link is no longer active.
          maxLength: 500
          type: string
        invoice_creation:
          description: Generate a post-purchase Invoice for one-time payments.
          properties:
            enabled:
              type: boolean
            invoice_data:
              properties:
                account_tax_ids:
                  anyOf:
                  - items:
                      maxLength: 5000
                      type: string
                    type: array
                  - enum:
                    - ''
                    type: string
                custom_fields:
                  anyOf:
                  - items:
                      properties:
                        name:
                          maxLength: 30
                          type: string
                        value:
                          maxLength: 30
                          type: string
                      required:
                      - name
                      - value
                      title: custom_field_params
                      type: object
                    type: array
                  - enum:
                    - ''
                    type: string
                description:
                  maxLength: 1500
                  type: string
                footer:
                  maxLength: 5000
                  type: string
                metadata:
                  anyOf:
                  - additionalProperties:
                      type: string
                    type: object
                  - enum:
                    - ''
                    type: string
                rendering_options:
                  anyOf:
                  - properties:
                      amount_tax_display:
                        enum:
                        - ''
                        - exclude_tax
                        - include_inclusive_tax
                        type: string
                    title: rendering_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
              title: invoice_settings_params
              type: object
          required:
          - enabled
          title: invoice_creation_create_params
          type: object
        line_items:
          description: The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
          items:
            properties:
              adjustable_quantity:
                properties:
                  enabled:
                    type: boolean
                  maximum:
                    type: integer
                  minimum:
                    type: integer
                required:
                - enabled
                title: adjustable_quantity_params
                type: object
              price:
                maxLength: 5000
                type: string
              quantity:
                type: integer
            required:
            - price
            - quantity
            title: line_items_create_params
            type: object
          type: array
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
          type: object
        on_behalf_of:
          description: The account on behalf of which to charge.
          type: string
        payment_intent_data:
          description: A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
          properties:
            capture_method:
              enum:
              - automatic
              - automatic_async
              - manual
              type: string
            description:
              maxLength: 1000
              type: string
            metadata:
              additionalProperties:
                type: string
              type: object
            setup_future_usage:
              enum:
              - off_session
              - on_session
              type: string
            statement_descriptor:
              maxLength: 22
              type: string
            statement_descriptor_suffix:
              maxLength: 22
              type: string
            transfer_group:
              maxLength: 5000
              type: string
          title: payment_intent_data_params
          type: object
        payment_method_collection:
          description: 'Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.


            Can only be set in `subscription` mode.


            If you''d like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).'
          enum:
          - always
          - if_required
          type: string
        payment_method_types:
          description: The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)).
          items:
            enum:
            - affirm
            - afterpay_clearpay
            - alipay
            - au_becs_debit
            - bacs_debit
            - bancontact
            - blik
            - boleto
            - card
            - cashapp
            - eps
            - fpx
            - giropay
            - grabpay
            - ideal
            - klarna
            - konbini
            - link
            - oxxo
            - p24
            - paynow
            - paypal
            - pix
            - promptpay
            - sepa_debit
            - sofort
            - us_bank_account
            - wechat_pay
            type: string
            x-stripeBypassValidation: true
          type: array
        phone_number_collection:
          description: 'Controls phone number collection settings during checkout.


            We recommend that you review your privacy policy and check with your legal contacts.'
          properties:
            enabled:
              type: boolean
          required:
          - enabled
          title: phone_number_collection_params
          type: object
        restrictions:
          description: Settings that restrict the usage of a payment link.
          properties:
            completed_sessions:
              properties:
                limit:
                  type: integer
              required:
              - limit
              title: completed_sessions_params
              type: object
          required:
          - completed_sessions
          title: restrictions_params
          type: object
        shipping_address_collection:
          description: Configuration for collecting the customer's shipping address.
          properties:
            allowed_countries:
              items:
                enum:
                - 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
                - 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
                type: string
              type: array
          required:
          - allowed_countries
          title: shipping_address_collection_params
          type: object
        shipping_options:
          description: The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
          items:
            properties:
              shipping_rate:
                maxLength: 5000
                type: string
            title: shipping_option_params
            type: object
          type: array
        submit_type:
          description: 'Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).'
          enum:
          - auto
          - book
          - donate
          - pay
          type: string
        subscription_data:
          description: When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
          properties:
            description:
              maxLength: 500
              type: string
            metadata:
              additionalProperties:
                type: string
              type: object
            trial_period_days:
              type: integer
            trial_settings:
              properties:
                end_behavior:
                  properties:
                    missing_payment_method:
                      enum:
                      - cancel
                      - create_invoice
                      - pause
                      type: string
                  required:
                  - missing_payment_method
                  title: end_behavior
                  type: object
              required:
              - end_behavior
              title: trial_settings_config
              type: object
          title: subscription_data_params
          type: object
        tax_id_collection:
          description: Controls tax ID collection during checkout.
          properties:
            enabled:
              type: boolean
          required:
          - enabled
          title: tax_id_collection_params
          type: object
        transfer_data:
          description: The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
          properties:
            amount:
              type: integer
            destination:
              type: string
          required:
          - destination
          title: transfer_data_params
          type: object
    PostInvoicesInvoiceVoidRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    coupon:
      description: 'A coupon contains information about a percent-off or amount-off discount you

        might want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),

        [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).'
      properties:
        amount_off:
          description: Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.
          nullable: true
          type: integer
        applies_to:
          $ref: '#/components/schemas/coupon_applies_to'
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off.
          nullable: true
          type: string
        currency_options:
          additionalProperties:
            $ref: '#/components/schemas/coupon_currency_option'
          description: Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
          type: object
        duration:
          description: One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount.
          enum:
          - forever
          - once
          - repeating
          type: string
          x-stripeBypassValidation: true
        duration_in_months:
          description: If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.
          nullable: true
          type: integer
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        max_redemptions:
          description: Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
          nullable: true
          type: integer
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          nullable: true
          type: object
        name:
          description: Name of the coupon displayed to customers on for instance invoices or receipts.
          maxLength: 5000
          nullable: true
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - coupon
          type: string
        percent_off:
          description: Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.
          nullable: true
          type: number
        redeem_by:
          description: Date after which the coupon can no longer be redeemed.
          format: unix-time
          nullable: true
          type: integer
        times_redeemed:
          description: Number of times this coupon has been applied to a customer.
          type: integer
        valid:
          description: Taking account of the above properties, whether this coupon can still be applied to a customer.
          type: boolean
      required:
      - created
      - duration
      - id
      - livemode
      - object
      - times_redeemed
      - valid
      title: Coupon
      type: object
      x-expandableFields:
      - applies_to
      - currency_options
      x-resourceId: coupon
    PostIssuingCardsCardRequest:
      type: object
      properties:
        cancellation_reason:
          description: Reason why the `status` of this card is `canceled`.
          enum:
          - lost
          - stolen
          type: string
          x-stripeBypassValidation: true
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        pin:
          description: The desired new PIN for this card.
          properties:
            encrypted_number:
              maxLength: 5000
              type: string
          title: encrypted_pin_param
          type: object
        spending_controls:
          description: Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
          properties:
            allowed_categories:
              items:
                enum:
                - ac_refrigeration_repair
                - accounting_bookkeeping_services
                - advertising_services
                - agricultural_cooperative
                - airlines_air_carriers
                - airports_flying_fields
                - ambulance_services
                - amusement_parks_carnivals
                - antique_reproductions
                - antique_shops
                - aquariums
                - architectural_surveying_services
                - art_dealers_and_galleries
                - artists_supply_and_craft_shops
                - auto_and_home_supply_stores
                - auto_body_repair_shops
                - auto_paint_shops
                - auto_service_shops
                - automated_cash_disburse
                - automated_fuel_dispensers
                - automobile_associations
                - automotive_parts_and_accessories_stores
                - automotive_tire_stores
                - bail_and_bond_payments
                - bakeries
                - bands_orchestras
                - barber_and_beauty_shops
                - betting_casino_gambling
                - bicycle_shops
                - billiard_pool_establishments
                - boat_dealers
                - boat_rentals_and_leases
                - book_stores
                - books_periodicals_and_newspapers
                - bowling_alleys
                - bus_lines
                - business_secretarial_schools
                - buying_shopping_services
                - cable_satellite_and_other_pay_television_and_radio
                - camera_and_photographic_supply_stores
                - candy_nut_and_confectionery_stores
                - car_and_truck_dealers_new_used
                - car_and_truck_dealers_used_only
                - car_rental_agencies
                - car_washes
                - carpentry_services
                - carpet_upholstery_cleaning
                - caterers
                - charitable_and_social_service_organizations_fundraising
                - chemicals_and_allied_products
                - child_care_services
                - childrens_and_infants_wear_stores
                - chiropodists_podiatrists
                - chiropractors
                - cigar_stores_and_stands
                - civic_social_fraternal_associations
                - cleaning_and_maintenance
                - clothing_rental
                - colleges_universities
                - commercial_equipment
                - commercial_footwear
                - commercial_photography_art_and_graphics
                - commuter_transport_and_ferries
                - computer_network_services
                - computer_programming
                - computer_repair
                - computer_software_stores
                - computers_peripherals_and_software
                - concrete_work_services
                - construction_materials
                - consulting_public_relations
                - correspondence_schools
                - cosmetic_stores
                - counseling_services
                - country_clubs
                - courier_services
                - court_costs
                - credit_reporting_agencies
                - cruise_lines
                - dairy_products_stores
                - dance_hall_studios_schools
                - dating_escort_services
                - dentists_orthodontists
                - department_stores
                - detective_agencies
                - digital_goods_applications
                - digital_goods_games
                - digital_goods_large_volume
                - digital_goods_media
                - direct_marketing_catalog_merchant
                - direct_marketing_combination_catalog_and_retail_merchant
                - direct_marketing_inbound_telemarketing
                - direct_marketing_insurance_services
                - direct_marketing_other
                - direct_marketing_outbound_telemarketing
                - direct_marketing_subscription
                - direct_marketing_travel
                - discount_stores
                - doctors
                - door_to_door_sales
                - drapery_window_covering_and_upholstery_stores
                - drinking_places
                - drug_stores_and_pharmacies
                - drugs_drug_proprietaries_and_druggist_sundries
                - dry_cleaners
                - durable_goods
                - duty_free_stores
                - eating_places_restaurants
                - educational_services
                - electric_razor_stores
                - electric_vehicle_charging
                - electrical_parts_and_equipment
                - electrical_services
                - electronics_repair_shops
                - electronics_stores
                - elementary_secondary_schools
                - emergency_services_gcas_visa_use_only
                - employment_temp_agencies
                - equipment_rental
                - exterminating_services
                - family_clothing_stores
                - fast_food_restaurants
                - financial_institutions
                - fines_government_administrative_entities
                - fireplace_fireplace_screens_and_accessories_stores
                - floor_covering_stores
                - florists
                - florists_supplies_nursery_stock_and_flowers
                - freezer_and_locker_meat_provisioners
                - fuel_dealers_non_automotive
                - funeral_services_crematories
                - furniture_home_furnishings_and_equipment_stores_except_appliances
                - furniture_repair_refinishing
                - furriers_and_fur_shops
                - general_services
                - gift_card_novelty_and_souvenir_shops
                - glass_paint_and_wallpaper_stores
                - glassware_crystal_stores
                - golf_courses_public
                - government_licensed_horse_dog_racing_us_region_only
                - government_licensed_online_casions_online_gambling_us_region_only
                - government_owned_lotteries_non_us_region
                - government_owned_lotteries_us_region_only
                - government_services
                - grocery_stores_supermarkets
                - hardware_equipment_and_supplies
                - hardware_stores
                - health_and_beauty_spas
                - hearing_aids_sales_and_supplies
                - heating_plumbing_a_c
                - hobby_toy_and_game_shops
                - home_supply_warehouse_stores
                - hospitals
                - hotels_motels_and_resorts
                - household_appliance_stores
                - industrial_supplies
                - information_retrieval_services
                - insurance_default
                - insurance_underwriting_premiums
                - intra_company_purchases
                - jewelry_stores_watches_clocks_and_silverware_stores
                - landscaping_services
                - laundries
                - laundry_cleaning_services
                - legal_services_attorneys
                - luggage_and_leather_goods_stores
                - lumber_building_materials_stores
                - manual_cash_disburse
                - marinas_service_and_supplies
                - marketplaces
                - masonry_stonework_and_plaster
                - massage_parlors
                - medical_and_dental_labs
                - medical_dental_ophthalmic_and_hospital_equipment_and_supplies
                - medical_services
                - membership_organizations
                - mens_and_boys_clothing_and_accessories_stores
                - mens_womens_clothing_stores
                - metal_service_centers
                - miscellaneous
                - miscellaneous_apparel_and_accessory_shops
                - miscellaneous_auto_dealers
                - miscellaneous_business_services
                - miscellaneous_food_stores
                - miscellaneous_general_merchandise
                - miscellaneous_general_services
                - miscellaneous_home_furnishing_specialty_stores
                - miscellaneous_publishing_and_printing
                - miscellaneous_recreation_services
                - miscellaneous_repair_shops
                - miscellaneous_specialty_retail
                - mobile_home_dealers
                - motion_picture_theaters
                - motor_freight_carriers_and_trucking
                - motor_homes_dealers
                - motor_vehicle_supplies_and_new_parts
                - motorcycle_shops_and_dealers
                - motorcycle_shops_dealers
                - music_stores_musical_instruments_pianos_and_sheet_music
                - news_dealers_and_newsstands
                - non_fi_money_orders
                - non_fi_stored_value_card_purchase_load
                - nondurable_goods
                - nurseries_lawn_and_garden_supply_stores
                - nursing_personal_care
                - office_and_commercial_furniture
                - opticians_eyeglasses
                - optometrists_ophthalmologist
                - orthopedic_goods_prosthetic_devices
                - osteopaths
                - package_stores_beer_wine_and_liquor
                - paints_varnishes_and_supplies
                - parking_lots_garages
                - passenger_railways
                - pawn_shops
                - pet_shops_pet_food_and_supplies
                - petroleum_and_petroleum_products
                - photo_developing
                - photographic_photocopy_microfilm_equipment_and_supplies
                - photographic_studios
                - picture_video_production
                - piece_goods_notions_and_other_dry_goods
                - plumbing_heating_equipment_and_supplies
                - political_organizations
                - postal_services_government_only
                - precious_stones_and_metals_watches_and_jewelry
                - professional_services
                - public_warehousing_and_storage
                - quick_copy_repro_and_blueprint
                - railroads
                - real_estate_agents_and_managers_rentals
                - record_stores
                - recreational_vehicle_rentals
                - religious_goods_stores
                - religious_organizations
                - roofing_siding_sheet_metal
                - secretarial_support_services
                - security_brokers_dealers
                - service_stations
                - sewing_needlework_fabric_and_piece_goods_stores
                - shoe_repair_hat_cleaning
                - shoe_stores
                - small_appliance_repair
                - snowmobile_dealers
                - special_trade_services
                - specialty_cleaning
                - sporting_goods_stores
                - sporting_recreation_camps
                - sports_and_riding_apparel_stores
                - sports_clubs_fields
                - stamp_and_coin_stores
                - stationary_office_supplies_printing_and_writing_paper
                - stationery_stores_office_and_school_supply_stores
                - swimming_pools_sales
                - t_ui_travel_germany
                - tailors_alterations
                - tax_payments_government_agencies
                - tax_preparation_services
                - taxicabs_limousines
                - telecommunication_equipment_and_telephone_sales
                - telecommunication_services
                - telegraph_services
                - tent_and_awning_shops
                - testing_laboratories
                - theatrical_ticket_agencies
                - timeshares
                - tire_retreading_and_repair
                - tolls_bridge_fees
                - tourist_attractions_and_exhibits
                - towing_services
                - trailer_parks_campgrounds
                - transportation_services
                - travel_agencies_tour_operators
                - truck_stop_iteration
                - truck_utility_trailer_rentals
                - typesetting_plate_making_and_related_services
                - typewriter_stores
                - u_s_federal_government_agencies_or_departments
                - uniforms_commercial_clothing
                - used_merchandise_and_secondhand_stores
                - utilities
                - variety_stores
                - veterinary_services
                - video_amusement_game_supplies
                - video_game_arcades
                - video_tape_rental_stores
                - vocational_trade_schools
                - watch_jewelry_repair
                - welding_repair
                - wholesale_clubs
                - wig_and_toupee_stores
                - wires_money_orders
                - womens_accessory_and_specialty_shops
                - womens_ready_to_wear_stores
                - wrecking_and_salvage_yards
                maxLength: 5000
                type: string
              type: array
            blocked_categories:
              items:
                enum:
                - ac_refrigeration_repair
                - accounting_bookkeeping_services
                - advertising_services
                - agricultural_cooperative
                - airlines_air_carriers
                - airports_flying_fields
                - ambulance_services
                - amusement_parks_carnivals
                - antique_reproductions
                - antique_shops
                - aquariums
                - architectural_surveying_services
                - art_dealers_and_galleries
                - artists_supply_and_craft_shops
                - auto_and_home_supply_stores
                - auto_body_repair_shops
                - auto_paint_shops
                - auto_service_shops
                - automated_cash_disburse
                - automated_fuel_dispensers
                - automobile_associations
                - automotive_parts_and_accessories_stores
                - automotive_tire_stores
                - bail_and_bond_payments
                - bakeries
                - bands_orchestras
                - barber_and_beauty_shops
                - betting_casino_gambling
                - bicycle_shops
                - billiard_pool_establishments
                - boat_dealers
                - boat_rentals_and_leases
                - book_stores
                - books_periodicals_and_newspapers
                - bowling_alleys
                - bus_lines
                - business_secretarial_schools
                - buying_shopping_services
                - cable_satellite_and_other_pay_television_and_radio
                - camera_and_photographic_supply_stores
                - candy_nut_and_confectionery_stores
                - car_and_truck_dealers_new_used
                - car_and_truck_dealers_used_only
                - car_rental_agencies
                - car_washes
                - carpentry_services
                - carpet_upholstery_cleaning
                - caterers
                - charitable_and_social_service_organizations_fundraising
                - chemicals_and_allied_products
                - child_care_services
                - childrens_and_infants_wear_stores
                - chiropodists_podiatrists
                - chiropractors
                - cigar_stores_and_stands
                - civic_social_fraternal_associations
                - cleaning_and_maintenance
                - clothing_rental
                - colleges_universities
                - commercial_equipment
                - commercial_footwear
                - commercial_photography_art_and_graphics
                - commuter_transport_and_ferries
                - computer_network_services
                - computer_programming
                - computer_repair
                - computer_software_stores
                - computers_peripherals_and_software
                - concrete_work_services
                - construction_materials
                - consulting_public_relations
                - correspondence_schools
                - cosmetic_stores
                - counseling_services
                - country_clubs
                - courier_services
                - court_costs
                - credit_reporting_agencies
                - cruise_lines
                - dairy_products_stores
                - dance_hall_studios_schools
                - dating_escort_services
                - dentists_orthodontists
                - department_stores
                - detective_agencies
                - digital_goods_applications
                - digital_goods_games
                - digital_goods_large_volume
                - digital_goods_media
                - direct_marketing_catalog_merchant
                - direct_marketing_combination_catalog_and_retail_merchant
                - direct_marketing_inbound_telemarketing
                - direct_marketing_insurance_services
                - direct_marketing_other
                - direct_marketing_outbound_telemarketing
                - direct_marketing_subscription
                - direct_marketing_travel
                - discount_stores
                - doctors
                - door_to_door_sales
                - drapery_window_covering_and_upholstery_stores
                - drinking_places
                - drug_stores_and_pharmacies
                - drugs_drug_proprietaries_and_druggist_sundries
                - dry_cleaners
                - durable_goods
                - duty_free_stores
                - eating_places_restaurants
                - educational_services
                - electric_razor_stores
                - electric_vehicle_charging
                - electrical_parts_and_equipment
                - electrical_services
                - electronics_repair_shops
                - electronics_stores
                - elementary_secondary_schools
                - emergency_services_gcas_visa_use_only
                - employment_temp_agencies
                - equipment_rental
                - exterminating_services
                - family_clothing_stores
                - fast_food_restaurants
                - financial_institutions
                - fines_government_administrative_entities
                - fireplace_fireplace_screens_and_accessories_stores
                - floor_covering_stores
                - florists
                - florists_supplies_nursery_stock_and_flowers
                - freezer_and_locker_meat_provisioners
                - fuel_dealers_non_automotive
                - funeral_services_crematories
                - furniture_home_furnishings_and_equipment_stores_except_appliances
                - furniture_repair_refinishing
                - furriers_and_fur_shops
                - general_services
                - gift_card_novelty_and_souvenir_shops
                - glass_paint_and_wallpaper_stores
                - glassware_crystal_stores
                - golf_courses_public
                - government_licensed_horse_dog_racing_us_region_only
                - government_licensed_online_casions_online_gambling_us_region_only
                - government_owned_lotteries_non_us_region
                - government_owned_lotteries_us_region_only
                - government_services
                - grocery_stores_supermarkets
                - hardware_equipment_and_supplies
                - hardware_stores
                - health_and_beauty_spas
                - hearing_aids_sales_and_supplies
                - heating_plumbing_a_c
                - hobby_toy_and_game_shops
                - home_supply_warehouse_stores
                - hospitals
                - hotels_motels_and_resorts
                - household_appliance_stores
                - industrial_supplies
                - information_retrieval_services
                - insurance_default
                - insurance_underwriting_premiums
                - intra_company_purchases
                - jewelry_stores_watches_clocks_and_silverware_stores
                - landscaping_services
                - laundries
                - laundry_cleaning_services
                - legal_services_attorneys
                - luggage_and_leather_goods_stores
                - lumber_building_materials_stores
                - manual_cash_disburse
                - marinas_service_and_supplies
                - marketplaces
                - masonry_stonework_and_plaster
                - massage_parlors
                - medical_and_dental_labs
                - medical_dental_ophthalmic_and_hospital_equipment_and_supplies
                - medical_services
                - membership_organizations
                - mens_and_boys_clothing_and_accessories_stores
                - mens_womens_clothing_stores
                - metal_service_centers
                - miscellaneous
                - miscellaneous_apparel_and_accessory_shops
                - miscellaneous_auto_dealers
                - miscellaneous_business_services
                - miscellaneous_food_stores
                - miscellaneous_general_merchandise
                - miscellaneous_general_services
                - miscellaneous_home_furnishing_specialty_stores
                - miscellaneous_publishing_and_printing
                - miscellaneous_recreation_services
                - miscellaneous_repair_shops
                - miscellaneous_specialty_retail
                - mobile_home_dealers
                - motion_picture_theaters
                - motor_freight_carriers_and_trucking
                - motor_homes_dealers
                - motor_vehicle_supplies_and_new_parts
                - motorcycle_shops_and_dealers
                - motorcycle_shops_dealers
                - music_stores_musical_instruments_pianos_and_sheet_music
                - news_dealers_and_newsstands
                - non_fi_money_orders
                - non_fi_stored_value_card_purchase_load
                - nondurable_goods
                - nurseries_lawn_and_garden_supply_stores
                - nursing_personal_care
                - office_and_commercial_furniture
                - opticians_eyeglasses
                - optometrists_ophthalmologist
                - orthopedic_goods_prosthetic_devices
                - osteopaths
                - package_stores_beer_wine_and_liquor
                - paints_varnishes_and_supplies
                - parking_lots_garages
                - passenger_railways
                - pawn_shops
                - pet_shops_pet_food_and_supplies
                - petroleum_and_petroleum_products
                - photo_developing
                - photographic_photocopy_microfilm_equipment_and_supplies
                - photographic_studios
                - picture_video_production
                - piece_goods_notions_and_other_dry_goods
                - plumbing_heating_equipment_and_supplies
                - political_organizations
                - postal_services_government_only
                - precious_stones_and_metals_watches_and_jewelry
                - professional_services
                - public_warehousing_and_storage
                - quick_copy_repro_and_blueprint
                - railroads
                - real_estate_agents_and_managers_rentals
                - record_stores
                - recreational_vehicle_rentals
                - religious_goods_stores
                - religious_organizations
                - roofing_siding_sheet_metal
                - secretarial_support_services
                - security_brokers_dealers
                - service_stations
                - sewing_needlework_fabric_and_piece_goods_stores
                - shoe_repair_hat_cleaning
                - shoe_stores
                - small_appliance_repair
                - snowmobile_dealers
                - special_trade_services
                - specialty_cleaning
                - sporting_goods_stores
                - sporting_recreation_camps
                - sports_and_riding_apparel_stores
                - sports_clubs_fields
                - stamp_and_coin_stores
                - stationary_office_supplies_printing_and_writing_paper
                - stationery_stores_office_and_school_supply_stores
                - swimming_pools_sales
                - t_ui_travel_germany
                - tailors_alterations
                - tax_payments_government_agencies
                - tax_preparation_services
                - taxicabs_limousines
                - telecommunication_equipment_and_telephone_sales
                - telecommunication_services
                - telegraph_services
                - tent_and_awning_shops
                - testing_laboratories
                - theatrical_ticket_agencies
                - timeshares
                - tire_retreading_and_repair
                - tolls_bridge_fees
                - tourist_attractions_and_exhibits
                - towing_services
                - trailer_parks_campgrounds
                - transportation_services
                - travel_agencies_tour_operators
                - truck_stop_iteration
                - truck_utility_trailer_rentals
                - typesetting_plate_making_and_related_services
                - typewriter_stores
                - u_s_federal_government_agencies_or_departments
                - uniforms_commercial_clothing
                - used_merchandise_and_secondhand_stores
                - utilities
                - variety_stores
                - veterinary_services
                - video_amusement_game_supplies
                - video_game_arcades
                - video_tape_rental_stores
                - vocational_trade_schools
                - watch_jewelry_repair
                - welding_repair
                - wholesale_clubs
                - wig_and_toupee_stores
                - wires_money_orders
                - womens_accessory_and_specialty_shops
                - womens_ready_to_wear_stores
                - wrecking_and_salvage_yards
                maxLength: 5000
                type: string
              type: array
            spending_limits:
              items:
                properties:
                  amount:
                    type: integer
                  categories:
                    items:
                      enum:
                      - ac_refrigeration_repair
                      - accounting_bookkeeping_services
                      - advertising_services
                      - agricultural_cooperative
                      - airlines_air_carriers
                      - airports_flying_fields
                      - ambulance_services
                      - amusement_parks_carnivals
                      - antique_reproductions
                      - antique_shops
                      - aquariums
                      - architectural_surveying_services
                      - art_dealers_and_galleries
                      - artists_supply_and_craft_shops
                      - auto_and_home_supply_stores
                      - auto_body_repair_shops
                      - auto_paint_shops
                      - auto_service_shops
                      - automated_cash_disburse
                      - automated_fuel_dispensers
                      - automobile_associations
                      - automotive_parts_and_accessories_stores
                      - automotive_tire_stores
                      - bail_and_bond_payments
                      - bakeries
                      - bands_orchestras
                      - barber_and_beauty_shops
                      - betting_casino_gambling
                      - bicycle_shops
                      - billiard_pool_establishments
                      - boat_dealers
                      - boat_rentals_and_leases
                      - book_stores
                      - books_periodicals_and_newspapers
                      - bowling_alleys
                      - bus_lines
                      - business_secretarial_schools
                      - buying_shopping_services
                      - cable_satellite_and_other_pay_television_and_radio
                      - camera_and_photographic_supply_stores
                      - candy_nut_and_confectionery_stores
                      - car_and_truck_dealers_new_used
                      - car_and_truck_dealers_used_only
                      - car_rental_agencies
                      - car_washes
                      - carpentry_services
                      - carpet_upholstery_cleaning
                      - caterers
                      - charitable_and_social_service_organizations_fundraising
                      - chemicals_and_allied_products
                      - child_care_services
                      - childrens_and_infants_wear_stores
                      - chiropodists_podiatrists
                      - chiropractors
                      - cigar_stores_and_stands
                      - civic_social_fraternal_associations
                      - cleaning_and_maintenance
                      - clothing_rental
                      - colleges_universities
                      - commercial_equipment
                      - commercial_footwear
                      - commercial_photography_art_and_graphics
                      - commuter_transport_and_ferries
                      - computer_network_services
                      - computer_programming
                      - computer_repair
                      - computer_software_stores
                      - computers_peripherals_and_software
                      - concrete_work_services
                      - construction_materials
                      - consulting_public_relations
                      - correspondence_schools
                      - cosmetic_stores
                      - counseling_services
                      - country_clubs
                      - courier_services
                      - court_costs
                      - credit_reporting_agencies
                      - cruise_lines
                      - dairy_products_stores
                      - dance_hall_studios_schools
                      - dating_escort_services
                      - dentists_orthodontists
                      - department_stores
                      - detective_agencies
                      - digital_goods_applications
                      - digital_goods_games
                      - digital_goods_large_volume
                      - digital_goods_media
                      - direct_marketing_catalog_merchant
                      - direct_marketing_combination_catalog_and_retail_merchant
                      - direct_marketing_inbound_telemarketing
                      - direct_marketing_insurance_services
                      - direct_marketing_other
                      - direct_marketing_outbound_telemarketing
                      - direct_marketing_subscription
                      - direct_marketing_travel
                      - discount_stores
                      - doctors
                      - door_to_door_sales
                      - drapery_window_covering_and_upholstery_stores
                      - drinking_places
                      - drug_stores_and_pharmacies
                      - drugs_drug_proprietaries_and_druggist_sundries
                      - dry_cleaners
                      - durable_goods
                      - duty_free_stores
                      - eating_places_restaurants
                      - educational_services
                      - electric_razor_stores
                      - electric_vehicle_charging
                      - electrical_parts_and_equipment
                      - electrical_services
                      - electronics_repair_shops
                      - electronics_stores
                      - elementary_secondary_schools
                      - emergency_services_gcas_visa_use_only
                      - employment_temp_agencies
                      - equipment_rental
                      - exterminating_services
                      - family_clothing_stores
                      - fast_food_restaurants
                      - financial_institutions
                      - fines_government_administrative_entities
                      - fireplace_fireplace_screens_and_accessories_stores
                      - floor_covering_stores
                      - florists
                      - florists_supplies_nursery_stock_and_flowers
                      - freezer_and_locker_meat_provisioners
                      - fuel_dealers_non_automotive
                      - funeral_services_crematories
                      - furniture_home_furnishings_and_equipment_stores_except_appliances
                      - furniture_repair_refinishing
                      - furriers_and_fur_shops
                      - general_services
                      - gift_card_novelty_and_souvenir_shops
                      - glass_paint_and_wallpaper_stores
                      - glassware_crystal_stores
                      - golf_courses_public
                      - government_licensed_horse_dog_racing_us_region_only
                      - government_licensed_online_casions_online_gambling_us_region_only
                      - government_owned_lotteries_non_us_region
                      - government_owned_lotteries_us_region_only
                      - government_services
                      - grocery_stores_supermarkets
                      - hardware_equipment_and_supplies
                      - hardware_stores
                      - health_and_beauty_spas
                      - hearing_aids_sales_and_supplies
                      - heating_plumbing_a_c
                      - hobby_toy_and_game_shops
                      - home_supply_warehouse_stores
                      - hospitals
                      - hotels_motels_and_resorts
                      - household_appliance_stores
                      - industrial_supplies
                      - information_retrieval_services
                      - insurance_default
                      - insurance_underwriting_premiums
                      - intra_company_purchases
                      - jewelry_stores_watches_clocks_and_silverware_stores
                      - landscaping_services
                      - laundries
                      - laundry_cleaning_services
                      - legal_services_attorneys
                      - luggage_and_leather_goods_stores
                      - lumber_building_materials_stores
                      - manual_cash_disburse
                      - marinas_service_and_supplies
                      - marketplaces
                      - masonry_stonework_and_plaster
                      - massage_parlors
                      - medical_and_dental_labs
                      - medical_dental_ophthalmic_and_hospital_equipment_and_supplies
                      - medical_services
                      - membership_organizations
                      - mens_and_boys_clothing_and_accessories_stores
                      - mens_womens_clothing_stores
                      - metal_service_centers
                      - miscellaneous
                      - miscellaneous_apparel_and_accessory_shops
                      - miscellaneous_auto_dealers
                      - miscellaneous_business_services
                      - miscellaneous_food_stores
                      - miscellaneous_general_merchandise
                      - miscellaneous_general_services
                      - miscellaneous_home_furnishing_specialty_stores
                      - miscellaneous_publishing_and_printing
                      - miscellaneous_recreation_services
                      - miscellaneous_repair_shops
                      - miscellaneous_specialty_retail
                      - mobile_home_dealers
                      - motion_picture_theaters
                      - motor_freight_carriers_and_trucking
                      - motor_homes_dealers
                      - motor_vehicle_supplies_and_new_parts
                      - motorcycle_shops_and_dealers
                      - motorcycle_shops_dealers
                      - music_stores_musical_instruments_pianos_and_sheet_music
                      - news_dealers_and_newsstands
                      - non_fi_money_orders
                      - non_fi_stored_value_card_purchase_load
                      - nondurable_goods
                      - nurseries_lawn_and_garden_supply_stores
                      - nursing_personal_care
                      - office_and_commercial_furniture
                      - opticians_eyeglasses
                      - optometrists_ophthalmologist
                      - orthopedic_goods_prosthetic_devices
                      - osteopaths
                      - package_stores_beer_wine_and_liquor
                      - paints_varnishes_and_supplies
                      - parking_lots_garages
                      - passenger_railways
                      - pawn_shops
                      - pet_shops_pet_food_and_supplies
                      - petroleum_and_petroleum_products
                      - photo_developing
                      - photographic_photocopy_microfilm_equipment_and_supplies
                      - photographic_studios
                      - picture_video_production
                      - piece_goods_notions_and_other_dry_goods
                      - plumbing_heating_equipment_and_supplies
                      - political_organizations
                      - postal_services_government_only
                      - precious_stones_and_metals_watches_and_jewelry
                      - professional_services
                      - public_warehousing_and_storage
                      - quick_copy_repro_and_blueprint
                      - railroads
                      - real_estate_agents_and_managers_rentals
                      - record_stores
                      - recreational_vehicle_rentals
                      - religious_goods_stores
                      - religious_organizations
                      - roofing_siding_sheet_metal
                      - secretarial_support_services
                      - security_brokers_dealers
                      - service_stations
                      - sewing_needlework_fabric_and_piece_goods_stores
                      - shoe_repair_hat_cleaning
                      - shoe_stores
                      - small_appliance_repair
                      - snowmobile_dealers
                      - special_trade_services
                      - specialty_cleaning
                      - sporting_goods_stores
                      - sporting_recreation_camps
                      - sports_and_riding_apparel_stores
                      - sports_clubs_fields
                      - stamp_and_coin_stores
                      - stationary_office_supplies_printing_and_writing_paper
                      - stationery_stores_office_and_school_supply_stores
                      - swimming_pools_sales
                      - t_ui_travel_germany
                      - tailors_alterations
                      - tax_payments_government_agencies
                      - tax_preparation_services
                      - taxicabs_limousines
                      - telecommunication_equipment_and_telephone_sales
                      - telecommunication_services
                      - telegraph_services
                      - tent_and_awning_shops
                      - testing_laboratories
                      - theatrical_ticket_agencies
                      - timeshares
                      - tire_retreading_and_repair
                      - tolls_bridge_fees
                      - tourist_attractions_and_exhibits
                      - towing_services
                      - trailer_parks_campgrounds
                      - transportation_services
                      - travel_agencies_tour_operators
                      - truck_stop_iteration
                      - truck_utility_trailer_rentals
                      - typesetting_plate_making_and_related_services
                      - typewriter_stores
                      - u_s_federal_government_agencies_or_departments
                      - uniforms_commercial_clothing
                      - used_merchandise_and_secondhand_stores
                      - utilities
                      - variety_stores
                      - veterinary_services
                      - video_amusement_game_supplies
                      - video_game_arcades
                      - video_tape_rental_stores
                      - vocational_trade_schools
                      - watch_jewelry_repair
                      - welding_repair
                      - wholesale_clubs
                      - wig_and_toupee_stores
                      - wires_money_orders
                      - womens_accessory_and_specialty_shops
                      - womens_ready_to_wear_stores
                      - wrecking_and_salvage_yards
                      maxLength: 5000
                      type: string
                    type: array
                  interval:
                    enum:
                    - all_time
                    - daily
                    - monthly
                    - per_authorization
                    - weekly
                    - yearly
                    type: string
                required:
                - amount
                - interval
                title: spending_limits_param
                type: object
              type: array
          title: authorization_controls_param
          type: object
        status:
          description: Dictates whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`.
          enum:
          - active
          - canceled
          - inactive
          type: string
          x-stripeBypassValidation: true
    PostCustomersCustomerSourcesIdVerifyRequest:
      type: object
      properties:
        amounts:
          description: Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.
          items:
            type: integer
          type: array
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostCustomersCustomerSourcesIdRequest:
      type: object
      properties:
        account_holder_name:
          description: The name of the person or business that owns the bank account.
          maxLength: 5000
          type: string
        account_holder_type:
          description: The type of entity that holds the account. This can be either `individual` or `company`.
          enum:
          - company
          - individual
          maxLength: 5000
          type: string
        address_city:
          description: City/District/Suburb/Town/Village.
          maxLength: 5000
          type: string
        address_country:
          description: Billing address country, if provided when creating card.
          maxLength: 5000
          type: string
        address_line1:
          description: Address line 1 (Street address/PO Box/Company name).
          maxLength: 5000
          type: string
        address_line2:
          description: Address line 2 (Apartment/Suite/Unit/Building).
          maxLength: 5000
          type: string
        address_state:
          description: State/County/Province/Region.
          maxLength: 5000
          type: string
        address_zip:
          description: ZIP or postal code.
          maxLength: 5000
          type: string
        exp_month:
          description: Two digit number representing the card’s expiration month.
          maxLength: 5000
          type: string
        exp_year:
          description: Four digit number representing the card’s expiration year.
          maxLength: 5000
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        name:
          description: Cardholder name.
          maxLength: 5000
          type: string
        owner:
          properties:
            address:
              properties:
                city:
                  maxLength: 5000
                  type: string
                country:
                  maxLength: 5000
                  type: string
                line1:
                  maxLength: 5000
                  type: string
                line2:
                  maxLength: 5000
                  type: string
                postal_code:
                  maxLength: 5000
                  type: string
                state:
                  maxLength: 5000
                  type: string
              title: source_address
              type: object
            email:
              type: string
            name:
              maxLength: 5000
              type: string
            phone:
              maxLength: 5000
              type: string
          title: owner
          type: object
    checkout.session:
      description: 'A Checkout Session represents your customer''s session as they pay for

        one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)

        or [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a

        new Session each time your customer attempts to pay.


        Once payment is successful, the Checkout Session will contain a reference

        to the [Customer](https://stripe.com/docs/api/customers), and either the successful

        [PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active

        [Subscription](https://stripe.com/docs/api/subscriptions).


        You can create a Checkout Session on your server and redirect to its URL

        to begin Checkout.


        Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)'
      properties:
        after_expiration:
          anyOf:
          - $ref: '#/components/schemas/payment_pages_checkout_session_after_expiration'
          description: When set, provides configuration for actions to take if this Checkout Session expires.
          nullable: true
        allow_promotion_codes:
          description: Enables user redeemable promotion codes.
          nullable: true
          type: boolean
        amount_subtotal:
          description: Total of all items before discounts or taxes are applied.
          nullable: true
          type: integer
        amount_total:
          description: Total of all items after discounts and taxes are applied.
          nullable: true
          type: integer
        automatic_tax:
          $ref: '#/components/schemas/payment_pages_checkout_session_automatic_tax'
        billing_address_collection:
          description: Describes whether Checkout should collect the customer's billing address.
          enum:
          - auto
          - required
          nullable: true
          type: string
        cancel_url:
          description: 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.
          maxLength: 5000
          nullable: true
          type: string
        client_reference_id:
          description: 'A unique string to reference the Checkout Session. This can be a

            customer ID, a cart ID, or similar, and can be used to reconcile the

            Session with your internal systems.'
          maxLength: 5000
          nullable: true
          type: string
        client_secret:
          description: Client secret to be used when initializing Stripe.js embedded checkout.
          maxLength: 5000
          nullable: true
          type: string
        consent:
          anyOf:
          - $ref: '#/components/schemas/payment_pages_checkout_session_consent'
          description: Results of `consent_collection` for this session.
          nullable: true
        consent_collection:
          anyOf:
          - $ref: '#/components/schemas/payment_pages_checkout_session_consent_collection'
          description: When set, provides configuration for the Checkout Session to gather active consent from customers.
          nullable: true
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: 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).
          nullable: true
          type: string
        currency_conversion:
          anyOf:
          - $ref: '#/components/schemas/payment_pages_checkout_session_currency_conversion'
          description: Currency conversion details for automatic currency conversion sessions
          nullable: true
        custom_fields:
          description: Collect additional information from your customer using custom fields. Up to 2 fields are supported.
          items:
            $ref: '#/components/schemas/payment_pages_checkout_session_custom_fields'
          type: array
        custom_text:
          $ref: '#/components/schemas/payment_pages_checkout_session_custom_text'
        customer:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/customer'
          - $ref: '#/components/schemas/deleted_customer'
          description: 'The ID of the customer for this Session.

            For Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout

            will create a new customer object based on information provided

            during the payment flow unless an existing customer was provided when

            the Session was created.'
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/customer'
            - $ref: '#/components/schemas/deleted_customer'
        customer_creation:
          description: Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
          enum:
          - always
          - if_required
          nullable: true
          type: string
        customer_details:
          anyOf:
          - $ref: '#/components/schemas/payment_pages_checkout_session_customer_details'
          description: The customer details including the customer's tax exempt status and the customer's tax IDs. Only the customer's email is present on Sessions in `setup` mode.
          nullable: true
        customer_email:
          description: 'If provided, this value will be used when the Customer object is created.

            If not provided, customers will be asked to enter their email address.

            Use this parameter to prefill customer data if you already have an email

            on file. To access information about the customer once the payment flow is

            complete, use the `customer` attribute.'
          maxLength: 5000
          nullable: true
          type: string
        expires_at:
          description: The timestamp at which the Checkout Session will expire.
          format: unix-time
          type: integer
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        invoice:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/invoice'
          description: ID of the invoice created by the Checkout Session, if it exists.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/invoice'
        invoice_creation:
          anyOf:
          - $ref: '#/components/schemas/payment_pages_checkout_session_invoice_creation'
          description: Details on the state of invoice creation for the Checkout Session.
          nullable: true
        line_items:
          description: The line items purchased by the customer.
          properties:
            data:
              description: Details about each object.
              items:
                $ref: '#/components/schemas/item'
              type: array
            has_more:
              description: True if this list has another page of items after this one that can be fetched.
              type: boolean
            object:
              description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
              enum:
              - list
              type: string
            url:
              description: The URL where this list can be accessed.
              maxLength: 5000
              type: string
          required:
          - data
          - has_more
          - object
          - url
          title: PaymentPagesCheckoutSessionListLineItems
          type: object
          x-expandableFields:
          - data
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        locale:
          description: The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
          enum:
          - 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
          nullable: true
          type: string
          x-stripeBypassValidation: true
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          nullable: true
          type: object
        mode:
          description: The mode of the Checkout Session.
          enum:
          - payment
          - setup
          - subscription
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - checkout.session
          type: string
        payment_intent:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/payment_intent'
          description: The ID of the PaymentIntent for Checkout Sessions in `payment` mode.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/payment_intent'
        payment_link:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/payment_link'
          description: The ID of the Payment Link that created this Session.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/payment_link'
        payment_method_collection:
          description: Configure whether a Checkout Session should collect a payment method.
          enum:
          - always
          - if_required
          nullable: true
          type: string
        payment_method_configuration_details:
          anyOf:
          - $ref: '#/components/schemas/payment_method_config_biz_payment_method_configuration_details'
          description: Information about the payment method configuration used for this Checkout session if using dynamic payment methods.
          nullable: true
        payment_method_options:
          anyOf:
          - $ref: '#/components/schemas/checkout_session_payment_method_options'
          description: Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
          nullable: true
        payment_method_types:
          description: 'A list of the types of payment methods (e.g. card) this Checkout

            Session is allowed to accept.'
          items:
            maxLength: 5000
            type: string
          type: array
        payment_status:
          description: 'The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.

            You can use this value to decide when to fulfill your customer''s order.'
          enum:
          - no_payment_required
          - paid
          - unpaid
          type: string
        phone_number_collection:
          $ref: '#/components/schemas/payment_pages_checkout_session_phone_number_collection'
        recovered_from:
          description: The ID of the original expired Checkout Session that triggered the recovery flow.
          maxLength: 5000
          nullable: true
          type: string
        redirect_on_completion:
          description: 'Applies to Checkout Sessions with `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: ''if_required''`, then we will only redirect if your user chooses a redirect-based payment method.'
          enum:
          - always
          - if_required
          - never
          type: string
        return_url:
          description: 'Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method''s app or site.'
          maxLength: 5000
          type: string
        setup_intent:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/setup_intent'
          description: The ID of the SetupIntent for Checkout Sessions in `setup` mode.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/setup_intent'
        shipping_address_collection:
          anyOf:
          - $ref: '#/components/schemas/payment_pages_checkout_session_shipping_address_collection'
          description: When set, provides configuration for Checkout to collect a shipping address from a customer.
          nullable: true
        shipping_cost:
          anyOf:
          - $ref: '#/components/schemas/payment_pages_checkout_session_shipping_cost'
          description: The details of the customer cost of shipping, including the customer chosen ShippingRate.
          nullable: true
        shipping_details:
          anyOf:
          - $ref: '#/components/schemas/shipping'
          description: Shipping information for this Checkout Session.
          nullable: true
        shipping_options:
          description: The shipping rate options applied to this Session.
          items:
            $ref: '#/components/schemas/payment_pages_checkout_session_shipping_option'
          type: array
        status:
          description: The status of the Checkout Session, one of `open`, `complete`, or `expired`.
          enum:
          - complete
          - expired
          - open
          nullable: true
          type: string
        submit_type:
          description: 'Describes the type of transaction being performed by Checkout in order to customize

            relevant text on the page, such as the submit button. `submit_type` can only be

            specified on Checkout Sessions in `payment` mode, but not Checkout Sessions

            in `subscription` or `setup` mode. Possible values are `auto`, `pay`, `book`, `donate`. If blank or `auto`, `pay` is used.'
          enum:
          - auto
          - book
          - donate
          - pay
          nullable: true
          type: string
        subscription:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/subscription'
          description: The ID of the subscription for Checkout Sessions in `subscription` mode.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/subscription'
        success_url:
          description: 'The URL the customer will be directed to after the payment or

            subscription creation is successful.'
          maxLength: 5000
          nullable: true
          type: string
        tax_id_collection:
          $ref: '#/components/schemas/payment_pages_checkout_session_tax_id_collection'
        total_details:
          anyOf:
          - $ref: '#/components/schemas/payment_pages_checkout_session_total_details'
          description: Tax and discount details for the computed total amount.
          nullable: true
        ui_mode:
          description: The UI mode of the Session. Can be `hosted` (default) or `embedded`.
          enum:
          - embedded
          - hosted
          nullable: true
          type: string
          x-stripeBypassValidation: true
        url:
          description: 'The URL to the Checkout Session. 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.`

            This value is only present when the session is active.'
          maxLength: 5000
          nullable: true
          type: string
      required:
      - automatic_tax
      - created
      - custom_fields
      - custom_text
      - expires_at
      - id
      - livemode
      - mode
      - object
      - payment_method_types
      - payment_status
      - shipping_options
      title: Session
      type: object
      x-expandableFields:
      - after_expiration
      - automatic_tax
      - consent
      - consent_collection
      - currency_conversion
      - custom_fields
      - custom_text
      - customer
      - customer_details
      - invoice
      - invoice_creation
      - line_items
      - payment_intent
      - payment_link
      - payment_method_configuration_details
      - payment_method_options
      - phone_number_collection
      - setup_intent
      - shipping_address_collection
      - shipping_cost
      - shipping_details
      - shipping_options
      - subscription
      - tax_id_collection
      - total_details
      x-resourceId: checkout.session
    PostIdentityVerificationSessionsSessionRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        options:
          description: A set of options for the session’s verification checks.
          properties:
            document:
              anyOf:
              - properties:
                  allowed_types:
                    items:
                      enum:
                      - driving_license
                      - id_card
                      - passport
                      type: string
                    type: array
                  require_id_number:
                    type: boolean
                  require_live_capture:
                    type: boolean
                  require_matching_selfie:
                    type: boolean
                title: document_options
                type: object
              - enum:
                - ''
                type: string
          title: session_options_param
          type: object
        type:
          description: The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
          enum:
          - document
          - id_number
          type: string
          x-stripeBypassValidation: true
    financial_connections.session:
      description: A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.
      properties:
        account_holder:
          anyOf:
          - $ref: '#/components/schemas/bank_connections_resource_accountholder'
          description: The account holder for whom accounts are collected in this session.
          nullable: true
        accounts:
          description: The accounts that were collected as part of this Session.
          properties:
            data:
              description: Details about each object.
              items:
                $ref: '#/components/schemas/financial_connections.account'
              type: array
            has_more:
              description: True if this list has another page of items after this one that can be fetched.
              type: boolean
            object:
              description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
              enum:
              - list
              type: string
            url:
              description: The URL where this list can be accessed.
              maxLength: 5000
              pattern: ^/v1/financial_connections/accounts
              type: string
          required:
          - data
          - has_more
          - object
          - url
          title: BankConnectionsResourceLinkedAccountList
          type: object
          x-expandableFields:
          - data
        client_secret:
          description: A value that will be passed to the client to launch the authentication flow.
          maxLength: 5000
          type: string
        filters:
          $ref: '#/components/schemas/bank_connections_resource_link_account_session_filters'
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - financial_connections.session
          type: string
        permissions:
          description: Permissions requested for accounts collected during this session.
          items:
            enum:
            - balances
            - ownership
            - payment_method
            - transactions
            type: string
            x-stripeBypassValidation: true
          type: array
        prefetch:
          description: Data features requested to be retrieved upon account creation.
          items:
            enum:
            - balances
            - ownership
            - transactions
            type: string
            x-stripeBypassValidation: true
          nullable: true
          type: array
        return_url:
          description: For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
          maxLength: 5000
          type: string
      required:
      - accounts
      - client_secret
      - id
      - livemode
      - object
      - permissions
      title: BankConnectionsResourceLinkAccountSession
      type: object
      x-expandableFields:
      - account_holder
      - accounts
      - filters
      x-resourceId: financial_connections.session
    PostCustomersCustomerCardsIdRequest:
      type: object
      properties:
        account_holder_name:
          description: The name of the person or business that owns the bank account.
          maxLength: 5000
          type: string
        account_holder_type:
          description: The type of entity that holds the account. This can be either `individual` or `company`.
          enum:
          - company
          - individual
          maxLength: 5000
          type: string
        address_city:
          description: City/District/Suburb/Town/Village.
          maxLength: 5000
          type: string
        address_country:
          description: Billing address country, if provided when creating card.
          maxLength: 5000
          type: string
        address_line1:
          description: Address line 1 (Street address/PO Box/Company name).
          maxLength: 5000
          type: string
        address_line2:
          description: Address line 2 (Apartment/Suite/Unit/Building).
          maxLength: 5000
          type: string
        address_state:
          description: State/County/Province/Region.
          maxLength: 5000
          type: string
        address_zip:
          description: ZIP or postal code.
          maxLength: 5000
          type: string
        exp_month:
          description: Two digit number representing the card’s expiration month.
          maxLength: 5000
          type: string
        exp_year:
          description: Four digit number representing the card’s expiration year.
          maxLength: 5000
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        name:
          description: Cardholder name.
          maxLength: 5000
          type: string
        owner:
          properties:
            address:
              properties:
                city:
                  maxLength: 5000
                  type: string
                country:
                  maxLength: 5000
                  type: string
                line1:
                  maxLength: 5000
                  type: string
                line2:
                  maxLength: 5000
                  type: string
                postal_code:
                  maxLength: 5000
                  type: string
                state:
                  maxLength: 5000
                  type: string
              title: source_address
              type: object
            email:
              type: string
            name:
              maxLength: 5000
              type: string
            phone:
              maxLength: 5000
              type: string
          title: owner
          type: object
    PostInvoicesInvoiceLinesLineItemIdRequest:
      type: object
      properties:
        amount:
          description: The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
          type: integer
        description:
          description: An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
          maxLength: 5000
          type: string
        discountable:
          description: Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
          type: boolean
        discounts:
          anyOf:
          - items:
              properties:
                coupon:
                  maxLength: 5000
                  type: string
                discount:
                  maxLength: 5000
                  type: string
              title: discounts_data_param
              type: object
            type: array
          - enum:
            - ''
            type: string
          description: The coupons & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        period:
          description: The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
          properties:
            end:
              format: unix-time
              type: integer
            start:
              format: unix-time
              type: integer
          required:
          - end
          - start
          title: period
          type: object
        price:
          description: The ID of the price object.
          maxLength: 5000
          type: string
        price_data:
          description: Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
          properties:
            currency:
              type: string
            product:
              maxLength: 5000
              type: string
            product_data:
              properties:
                description:
                  maxLength: 40000
                  type: string
                images:
                  items:
                    type: string
                  type: array
                metadata:
                  additionalProperties:
                    type: string
                  type: object
                name:
                  maxLength: 5000
                  type: string
                tax_code:
                  maxLength: 5000
                  type: string
              required:
              - name
              title: product_data
              type: object
            tax_behavior:
              enum:
              - exclusive
              - inclusive
              - unspecified
              type: string
            unit_amount:
              type: integer
            unit_amount_decimal:
              format: decimal
              type: string
          required:
          - currency
          title: one_time_price_data_with_product_data
          type: object
        quantity:
          description: Non-negative integer. The quantity of units for the line item.
          type: integer
        tax_amounts:
          anyOf:
          - items:
              properties:
                amount:
                  type: integer
                tax_rate_data:
                  properties:
                    country:
                      maxLength: 5000
                      type: string
                    description:
                      maxLength: 5000
                      type: string
                    display_name:
                      maxLength: 50
                      type: string
                    inclusive:
                      type: boolean
                    jurisdiction:
                      maxLength: 50
                      type: string
                    percentage:
                      type: number
                    state:
                      maxLength: 2
                      type: string
                    tax_type:
                      enum:
                      - amusement_tax
                      - communications_tax
                      - gst
                      - hst
                      - igst
                      - jct
                      - lease_tax
                      - pst
                      - qst
                      - rst
                      - sales_tax
                      - service_tax
                      - vat
                      type: string
                  required:
                  - display_name
                  - inclusive
                  - percentage
                  title: tax_rate_data_param
                  type: object
                taxable_amount:
                  type: integer
              required:
              - amount
              - tax_rate_data
              - taxable_amount
              title: tax_amount_param
              type: object
            type: array
          - enum:
            - ''
            type: string
          description: A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
        tax_rates:
          anyOf:
          - items:
              maxLength: 5000
              type: string
            type: array
          - enum:
            - ''
            type: string
          description: The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
    PostPayoutsPayoutCancelRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostPaymentLinksPaymentLinkRequest:
      type: object
      properties:
        active:
          description: Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.
          type: boolean
        after_completion:
          description: Behavior after the purchase is complete.
          properties:
            hosted_confirmation:
              properties:
                custom_message:
                  maxLength: 500
                  type: string
              title: after_completion_confirmation_page_params
              type: object
            redirect:
              properties:
                url:
                  maxLength: 2048
                  type: string
              required:
              - url
              title: after_completion_redirect_params
              type: object
            type:
              enum:
              - hosted_confirmation
              - redirect
              type: string
          required:
          - type
          title: after_completion_params
          type: object
        allow_promotion_codes:
          description: Enables user redeemable promotion codes.
          type: boolean
        automatic_tax:
          description: Configuration for automatic tax collection.
          properties:
            enabled:
              type: boolean
          required:
          - enabled
          title: automatic_tax_params
          type: object
        billing_address_collection:
          description: Configuration for collecting the customer's billing address.
          enum:
          - auto
          - required
          type: string
        custom_fields:
          anyOf:
          - items:
              properties:
                dropdown:
                  properties:
                    options:
                      items:
                        properties:
                          label:
                            maxLength: 100
                            type: string
                          value:
                            maxLength: 100
                            type: string
                        required:
                        - label
                        - value
                        title: custom_field_option_param
                        type: object
                      type: array
                  required:
                  - options
                  title: custom_field_dropdown_param
                  type: object
                key:
                  maxLength: 200
                  type: string
                label:
                  properties:
                    custom:
                      maxLength: 50
                      type: string
                    type:
                      enum:
                      - custom
                      type: string
                  required:
                  - custom
                  - type
                  title: custom_field_label_param
                  type: object
                numeric:
                  properties:
                    maximum_length:
                      type: integer
                    minimum_length:
                      type: integer
                  title: custom_field_numeric_param
                  type: object
                optional:
                  type: boolean
                text:
                  properties:
                    maximum_length:
                      type: integer
                    minimum_length:
                      type: integer
                  title: custom_field_text_param
                  type: object
                type:
                  enum:
                  - dropdown
                  - numeric
                  - text
                  type: string
              required:
              - key
              - label
              - type
              title: custom_field_param
              type: object
            type: array
          - enum:
            - ''
            type: string
          description: Collect additional information from your customer using custom fields. Up to 2 fields are supported.
        custom_text:
          description: Display additional text for your customers using custom text.
          properties:
            after_submit:
              anyOf:
              - properties:
                  message:
                    maxLength: 1200
                    type: string
                required:
                - message
                title: custom_text_position_param
                type: object
              - enum:
                - ''
                type: string
            shipping_address:
              anyOf:
              - properties:
                  message:
                    maxLength: 1200
                    type: string
                required:
                - message
                title: custom_text_position_param
                type: object
              - enum:
                - ''
                type: string
            submit:
              anyOf:
              - properties:
                  message:
                    maxLength: 1200
                    type: string
                required:
                - message
                title: custom_text_position_param
                type: object
              - enum:
                - ''
                type: string
            terms_of_service_acceptance:
              anyOf:
              - properties:
                  message:
                    maxLength: 1200
                    type: string
                required:
                - message
                title: custom_text_position_param
                type: object
              - enum:
                - ''
                type: string
          title: custom_text_param
          type: object
        customer_creation:
          description: Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).
          enum:
          - always
          - if_required
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        inactive_message:
          anyOf:
          - maxLength: 500
            type: string
          - enum:
            - ''
            type: string
          description: The custom message to be displayed to a customer when a payment link is no longer active.
        invoice_creation:
          description: Generate a post-purchase Invoice for one-time payments.
          properties:
            enabled:
              type: boolean
            invoice_data:
              properties:
                account_tax_ids:
                  anyOf:
                  - items:
                      maxLength: 5000
                      type: string
                    type: array
                  - enum:
                    - ''
                    type: string
                custom_fields:
                  anyOf:
                  - items:
                      properties:
                        name:
                          maxLength: 30
                          type: string
                        value:
                          maxLength: 30
                          type: string
                      required:
                      - name
                      - value
                      title: custom_field_params
                      type: object
                    type: array
                  - enum:
                    - ''
                    type: string
                description:
                  maxLength: 1500
                  type: string
                footer:
                  maxLength: 5000
                  type: string
                metadata:
                  anyOf:
                  - additionalProperties:
                      type: string
                    type: object
                  - enum:
                    - ''
                    type: string
                rendering_options:
                  anyOf:
                  - properties:
                      amount_tax_display:
                        enum:
                        - ''
                        - exclude_tax
                        - include_inclusive_tax
                        type: string
                    title: rendering_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
              title: invoice_settings_params
              type: object
          required:
          - enabled
          title: invoice_creation_update_params
          type: object
        line_items:
          description: The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
          items:
            properties:
              adjustable_quantity:
                properties:
                  enabled:
                    type: boolean
                  maximum:
                    type: integer
                  minimum:
                    type: integer
                required:
                - enabled
                title: adjustable_quantity_params
                type: object
              id:
                maxLength: 5000
                type: string
              quantity:
                type: integer
            required:
            - id
            title: line_items_update_params
            type: object
          type: array
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
          type: object
        payment_intent_data:
          description: A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
          properties:
            description:
              anyOf:
              - maxLength: 1000
                type: string
              - enum:
                - ''
                type: string
            metadata:
              anyOf:
              - additionalProperties:
                  type: string
                type: object
              - enum:
                - ''
                type: string
            statement_descriptor:
              anyOf:
              - maxLength: 22
                type: string
              - enum:
                - ''
                type: string
            statement_descriptor_suffix:
              anyOf:
              - maxLength: 22
                type: string
              - enum:
                - ''
                type: string
            transfer_group:
              anyOf:
              - maxLength: 5000
                type: string
              - enum:
                - ''
                type: string
          title: payment_intent_data_update_params
          type: object
        payment_method_collection:
          description: 'Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.


            Can only be set in `subscription` mode.


            If you''d like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).'
          enum:
          - always
          - if_required
          type: string
        payment_method_types:
          anyOf:
          - items:
              enum:
              - affirm
              - afterpay_clearpay
              - alipay
              - au_becs_debit
              - bacs_debit
              - bancontact
              - blik
              - boleto
              - card
              - cashapp
              - eps
              - fpx
              - giropay
              - grabpay
              - ideal
              - klarna
              - konbini
              - link
              - oxxo
              - p24
              - paynow
              - paypal
              - pix
              - promptpay
              - sepa_debit
              - sofort
              - us_bank_account
              - wechat_pay
              type: string
              x-stripeBypassValidation: true
            type: array
          - enum:
            - ''
            type: string
          description: The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
        restrictions:
          anyOf:
          - properties:
              completed_sessions:
                properties:
                  limit:
                    type: integer
                required:
                - limit
                title: completed_sessions_params
                type: object
            required:
            - completed_sessions
            title: restrictions_params
            type: object
          - enum:
            - ''
            type: string
          description: Settings that restrict the usage of a payment link.
        shipping_address_collection:
          anyOf:
          - properties:
              allowed_countries:
                items:
                  enum:
                  - 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
                  - 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
                  type: string
                type: array
            required:
            - allowed_countries
            title: shipping_address_collection_params
            type: object
          - enum:
            - ''
            type: string
          description: Configuration for collecting the customer's shipping address.
        subscription_data:
          description: When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
          properties:
            metadata:
              anyOf:
              - additionalProperties:
                  type: string
                type: object
              - enum:
                - ''
                type: string
            trial_settings:
              anyOf:
              - properties:
                  end_behavior:
                    properties:
                      missing_payment_method:
                        enum:
                        - cancel
                        - create_invoice
                        - pause
                        type: string
                    required:
                    - missing_payment_method
                    title: end_behavior
                    type: object
                required:
                - end_behavior
                title: trial_settings_config
                type: object
              - enum:
                - ''
                type: string
          title: subscription_data_update_params
          type: object
    PostCustomersCustomerFundingInstructionsRequest:
      type: object
      required:
      - bank_transfer
      - currency
      - funding_type
      properties:
        bank_transfer:
          description: Additional parameters for `bank_transfer` funding types
          properties:
            eu_bank_transfer:
              properties:
                country:
                  maxLength: 5000
                  type: string
              required:
              - country
              title: eu_bank_account_params
              type: object
            requested_address_types:
              items:
                enum:
                - iban
                - sort_code
                - spei
                - zengin
                type: string
                x-stripeBypassValidation: true
              type: array
            type:
              enum:
              - eu_bank_transfer
              - gb_bank_transfer
              - jp_bank_transfer
              - mx_bank_transfer
              - us_bank_transfer
              type: string
              x-stripeBypassValidation: true
          required:
          - type
          title: bank_transfer_params
          type: object
        currency:
          description: 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).
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        funding_type:
          description: The `funding_type` to get the instructions for.
          enum:
          - bank_transfer
          type: string
    PostPlansPlanRequest:
      type: object
      properties:
        active:
          description: Whether the plan is currently available for new subscriptions.
          type: boolean
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        nickname:
          description: A brief description of the plan, hidden from customers.
          maxLength: 5000
          type: string
        product:
          description: The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.
          maxLength: 5000
          type: string
        trial_period_days:
          description: Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
          type: integer
    PostCustomersCustomerRequest:
      type: object
      properties:
        address:
          anyOf:
          - properties:
              city:
                maxLength: 5000
                type: string
              country:
                maxLength: 5000
                type: string
              line1:
                maxLength: 5000
                type: string
              line2:
                maxLength: 5000
                type: string
              postal_code:
                maxLength: 5000
                type: string
              state:
                maxLength: 5000
                type: string
            title: optional_fields_address
            type: object
          - enum:
            - ''
            type: string
          description: The customer's address.
        balance:
          description: An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
          type: integer
        bank_account:
          anyOf:
          - properties:
              account_holder_name:
                maxLength: 5000
                type: string
              account_holder_type:
                enum:
                - company
                - individual
                maxLength: 5000
                type: string
              account_number:
                maxLength: 5000
                type: string
              country:
                maxLength: 5000
                type: string
              currency:
                type: string
              object:
                enum:
                - bank_account
                maxLength: 5000
                type: string
              routing_number:
                maxLength: 5000
                type: string
            required:
            - account_number
            - country
            title: customer_payment_source_bank_account
            type: object
          - maxLength: 5000
            type: string
          description: Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details.
        card:
          anyOf:
          - properties:
              address_city:
                maxLength: 5000
                type: string
              address_country:
                maxLength: 5000
                type: string
              address_line1:
                maxLength: 5000
                type: string
              address_line2:
                maxLength: 5000
                type: string
              address_state:
                maxLength: 5000
                type: string
              address_zip:
                maxLength: 5000
                type: string
              cvc:
                maxLength: 5000
                type: string
              exp_month:
                type: integer
              exp_year:
                type: integer
              metadata:
                additionalProperties:
                  type: string
                type: object
              name:
                maxLength: 5000
                type: string
              number:
                maxLength: 5000
                type: string
              object:
                enum:
                - card
                maxLength: 5000
                type: string
            required:
            - exp_month
            - exp_year
            - number
            title: customer_payment_source_card
            type: object
          - maxLength: 5000
            type: string
          description: A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).
          x-stripeBypassValidation: true
        cash_balance:
          description: Balance information and default balance settings for this customer.
          properties:
            settings:
              properties:
                reconciliation_mode:
                  enum:
                  - automatic
                  - manual
                  - merchant_default
                  type: string
              title: balance_settings_param
              type: object
          title: cash_balance_param
          type: object
        coupon:
          maxLength: 5000
          type: string
        default_alipay_account:
          description: ID of Alipay account to make the customer's new default for invoice payments.
          maxLength: 500
          type: string
        default_bank_account:
          description: ID of bank account to make the customer's new default for invoice payments.
          maxLength: 500
          type: string
        default_card:
          description: ID of card to make the customer's new default for invoice payments.
          maxLength: 500
          type: string
        default_source:
          description: 'If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter.


            Provide the ID of a payment source already attached to this customer to make it this customer''s default payment source.


            If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property.'
          maxLength: 500
          type: string
        description:
          description: An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
          maxLength: 5000
          type: string
        email:
          description: Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.
          maxLength: 512
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        invoice_prefix:
          description: The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
          maxLength: 5000
          type: string
        invoice_settings:
          description: Default invoice settings for this customer.
          properties:
            custom_fields:
              anyOf:
              - items:
                  properties:
                    name:
                      maxLength: 30
                      type: string
                    value:
                      maxLength: 30
                      type: string
                  required:
                  - name
                  - value
                  title: custom_field_params
                  type: object
                type: array
              - enum:
                - ''
                type: string
            default_payment_method:
              maxLength: 5000
              type: string
            footer:
              maxLength: 5000
              type: string
            rendering_options:
              anyOf:
              - properties:
                  amount_tax_display:
                    enum:
                    - ''
                    - exclude_tax
                    - include_inclusive_tax
                    type: string
                title: rendering_options_param
                type: object
              - enum:
                - ''
                type: string
          title: customer_param
          type: object
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        name:
          description: The customer's full name or business name.
          maxLength: 256
          type: string
        next_invoice_sequence:
          description: The sequence to be used on the customer's next invoice. Defaults to 1.
          type: integer
        phone:
          description: The customer's phone number.
          maxLength: 20
          type: string
        preferred_locales:
          description: Customer's preferred languages, ordered by preference.
          items:
            maxLength: 5000
            type: string
          type: array
        promotion_code:
          description: The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
          maxLength: 5000
          type: string
        shipping:
          anyOf:
          - properties:
              address:
                properties:
                  city:
                    maxLength: 5000
                    type: string
                  country:
                    maxLength: 5000
                    type: string
                  line1:
                    maxLength: 5000
                    type: string
                  line2:
                    maxLength: 5000
                    type: string
                  postal_code:
                    maxLength: 5000
                    type: string
                  state:
                    maxLength: 5000
                    type: string
                title: optional_fields_address
                type: object
              name:
                maxLength: 5000
                type: string
              phone:
                maxLength: 5000
                type: string
            required:
            - address
            - name
            title: customer_shipping
            type: object
          - enum:
            - ''
            type: string
          description: The customer's shipping information. Appears on invoices emailed to this customer.
        source:
          maxLength: 5000
          type: string
          x-stripeBypassValidation: true
        tax:
          description: Tax details about the customer.
          properties:
            ip_address:
              anyOf:
              - type: string
              - enum:
                - ''
                type: string
            validate_location:
              enum:
              - deferred
              - immediately
              type: string
          title: tax_param
          type: object
        tax_exempt:
          description: The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
          enum:
          - ''
          - exempt
          - none
          - reverse
          type: string
    PostCreditNotesRequest:
      type: object
      required:
      - invoice
      properties:
        amount:
          description: The integer amount in cents (or local equivalent) representing the total amount of the credit note.
          type: integer
        credit_amount:
          description: The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
          type: integer
        effective_at:
          description: The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
          format: unix-time
          type: integer
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        invoice:
          description: ID of the invoice.
          maxLength: 5000
          type: string
        lines:
          description: Line items that make up the credit note.
          items:
            properties:
              amount:
                type: integer
              description:
                maxLength: 5000
                type: string
              invoice_line_item:
                maxLength: 5000
                type: string
              quantity:
                type: integer
              tax_amounts:
                anyOf:
                - items:
                    properties:
                      amount:
                        type: integer
                      tax_rate:
                        maxLength: 5000
                        type: string
                      taxable_amount:
                        type: integer
                    required:
                    - amount
                    - tax_rate
                    - taxable_amount
                    title: tax_amount_with_tax_rate_param
                    type: object
                  type: array
                - enum:
                  - ''
                  type: string
              tax_rates:
                anyOf:
                - items:
                    maxLength: 5000
                    type: string
                  type: array
                - enum:
                  - ''
                  type: string
              type:
                enum:
                - custom_line_item
                - invoice_line_item
                type: string
              unit_amount:
                type: integer
              unit_amount_decimal:
                format: decimal
                type: string
            required:
            - type
            title: credit_note_line_item_params
            type: object
          type: array
        memo:
          description: The credit note's memo appears on the credit note PDF.
          maxLength: 5000
          type: string
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        out_of_band_amount:
          description: The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
          type: integer
        reason:
          description: Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
          enum:
          - duplicate
          - fraudulent
          - order_change
          - product_unsatisfactory
          type: string
        refund:
          description: ID of an existing refund to link this credit note to.
          type: string
        refund_amount:
          description: The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
          type: integer
        shipping_cost:
          description: When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
          properties:
            shipping_rate:
              maxLength: 5000
              type: string
          title: credit_note_shipping_cost
          type: object
    PostDisputesDisputeCloseRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostIdentityVerificationSessionsSessionCancelRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostFinancialConnectionsAccountsAccountRefreshRequest:
      type: object
      required:
      - features
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        features:
          description: The list of account features that you would like to refresh.
          items:
            enum:
            - balance
            - ownership
            - transactions
            type: string
            x-stripeBypassValidation: true
          type: array
    financial_connections.account:
      description: A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.
      properties:
        account_holder:
          anyOf:
          - $ref: '#/components/schemas/bank_connections_resource_accountholder'
          description: The account holder that this account belongs to.
          nullable: true
        balance:
          anyOf:
          - $ref: '#/components/schemas/bank_connections_resource_balance'
          description: The most recent information about the account's balance.
          nullable: true
        balance_refresh:
          anyOf:
          - $ref: '#/components/schemas/bank_connections_resource_balance_refresh'
          description: The state of the most recent attempt to refresh the account balance.
          nullable: true
        category:
          description: The type of the account. Account category is further divided in `subcategory`.
          enum:
          - cash
          - credit
          - investment
          - other
          type: string
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        display_name:
          description: A human-readable name that has been assigned to this account, either by the account holder or by the institution.
          maxLength: 5000
          nullable: true
          type: string
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        institution_name:
          description: The name of the institution that holds this account.
          maxLength: 5000
          type: string
        last4:
          description: The last 4 digits of the account number. If present, this will be 4 numeric characters.
          maxLength: 5000
          nullable: true
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - financial_connections.account
          type: string
        ownership:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/financial_connections.account_ownership'
          description: The most recent information about the account's owners.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/financial_connections.account_ownership'
        ownership_refresh:
          anyOf:
          - $ref: '#/components/schemas/bank_connections_resource_ownership_refresh'
          description: The state of the most recent attempt to refresh the account owners.
          nullable: true
        permissions:
          description: The list of permissions granted by this account.
          items:
            enum:
            - balances
            - ownership
            - payment_method
            - transactions
            type: string
          nullable: true
          type: array
        status:
          description: The status of the link to the account.
          enum:
          - active
          - disconnected
          - inactive
          type: string
        subcategory:
          description: "If `category` is `cash`, one of:\n\n - `checking`\n - `savings`\n - `other`\n\nIf `category` is `credit`, one of:\n\n - `mortgage`\n - `line_of_credit`\n - `credit_card`\n - `other`\n\nIf `category` is `investment` or `other`, this will be `other`."
          enum:
          - checking
          - credit_card
          - line_of_credit
          - mortgage
          - other
          - savings
          type: string
        subscriptions:
          description: The list of data refresh subscriptions requested on this account.
          items:
            enum:
            - transactions
            type: string
            x-stripeBypassValidation: true
          nullable: true
          type: array
        supported_payment_method_types:
          description: The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
          items:
            enum:
            - link
            - us_bank_account
            type: string
          type: array
        transaction_refresh:
          anyOf:
          - $ref: '#/components/schemas/bank_connections_resource_transaction_refresh'
          description: The state of the most recent attempt to refresh the account transactions.
          nullable: true
      required:
      - category
      - created
      - id
      - institution_name
      - livemode
      - object
      - status
      - subcategory
      - supported_payment_method_types
      title: BankConnectionsResourceLinkedAccount
      type: object
      x-expandableFields:
      - account_holder
      - balance
      - balance_refresh
      - ownership
      - ownership_refresh
      - transaction_refresh
      x-resourceId: financial_connections.account
    PostPricesRequest:
      type: object
      required:
      - currency
      properties:
        active:
          description: Whether the price can be used for new purchases. Defaults to `true`.
          type: boolean
        billing_scheme:
          description: Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
          enum:
          - per_unit
          - tiered
          type: string
        currency:
          description: 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).
          type: string
        currency_options:
          additionalProperties:
            properties:
              custom_unit_amount:
                properties:
                  enabled:
                    type: boolean
                  maximum:
                    type: integer
                  minimum:
                    type: integer
                  preset:
                    type: integer
                required:
                - enabled
                title: custom_unit_amount
                type: object
              tax_behavior:
                enum:
                - exclusive
                - inclusive
                - unspecified
                type: string
              tiers:
                items:
                  properties:
                    flat_amount:
                      type: integer
                    flat_amount_decimal:
                      format: decimal
                      type: string
                    unit_amount:
                      type: integer
                    unit_amount_decimal:
                      format: decimal
                      type: string
                    up_to:
                      anyOf:
                      - enum:
                        - inf
                        maxLength: 5000
                        type: string
                      - type: integer
                  required:
                  - up_to
                  title: tier
                  type: object
                type: array
              unit_amount:
                type: integer
              unit_amount_decimal:
                format: decimal
                type: string
            title: currency_option
            type: object
          description: Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
          type: object
        custom_unit_amount:
          description: When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
          properties:
            enabled:
              type: boolean
            maximum:
              type: integer
            minimum:
              type: integer
            preset:
              type: integer
          required:
          - enabled
          title: custom_unit_amount
          type: object
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        lookup_key:
          description: A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
          maxLength: 200
          type: string
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        nickname:
          description: A brief description of the price, hidden from customers.
          maxLength: 5000
          type: string
        product:
          description: The ID of the product that this price will belong to.
          maxLength: 5000
          type: string
        product_data:
          description: These fields can be used to create a new product that this price will belong to.
          properties:
            active:
              type: boolean
            id:
              maxLength: 5000
              type: string
            metadata:
              additionalProperties:
                type: string
              type: object
            name:
              maxLength: 5000
              type: string
            statement_descriptor:
              maxLength: 22
              type: string
            tax_code:
              maxLength: 5000
              type: string
            unit_label:
              maxLength: 12
              type: string
          required:
          - name
          title: inline_product_params
          type: object
        recurring:
          description: The recurring components of a price such as `interval` and `usage_type`.
          properties:
            aggregate_usage:
              enum:
              - last_during_period
              - last_ever
              - max
              - sum
              type: string
            interval:
              enum:
              - day
              - month
              - week
              - year
              type: string
            interval_count:
              type: integer
            usage_type:
              enum:
              - licensed
              - metered
              type: string
          required:
          - interval
          title: recurring
          type: object
        tax_behavior:
          description: Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
          enum:
          - exclusive
          - inclusive
          - unspecified
          type: string
        tiers:
          description: Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
          items:
            properties:
              flat_amount:
                type: integer
              flat_amount_decimal:
                format: decimal
                type: string
              unit_amount:
                type: integer
              unit_amount_decimal:
                format: decimal
                type: string
              up_to:
                anyOf:
                - enum:
                  - inf
                  maxLength: 5000
                  type: string
                - type: integer
            required:
            - up_to
            title: tier
            type: object
          type: array
        tiers_mode:
          description: Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.
          enum:
          - graduated
          - volume
          type: string
        transfer_lookup_key:
          description: If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
          type: boolean
        transform_quantity:
          description: Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
          properties:
            divide_by:
              type: integer
            round:
              enum:
              - down
              - up
              type: string
          required:
          - divide_by
          - round
          title: transform_usage_param
          type: object
        unit_amount:
          description: A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount` or `custom_unit_amount` is required, unless `billing_scheme=tiered`.
          type: integer
        unit_amount_decimal:
          description: Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
          format: decimal
          type: string
    PostInvoicesInvoiceMarkUncollectibleRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostIdentityVerificationSessionsSessionRedactRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostCheckoutSessionsRequest:
      type: object
      properties:
        after_expiration:
          description: Configure actions after a Checkout Session has expired.
          properties:
            recovery:
              properties:
                allow_promotion_codes:
                  type: boolean
                enabled:
                  type: boolean
              required:
              - enabled
              title: recovery_params
              type: object
          title: after_expiration_params
          type: object
        allow_promotion_codes:
          description: Enables user redeemable promotion codes.
          type: boolean
        automatic_tax:
          description: Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
          properties:
            enabled:
              type: boolean
          required:
          - enabled
          title: automatic_tax_params
          type: object
        billing_address_collection:
          description: Specify whether Checkout should collect the customer's billing address.
          enum:
          - auto
          - required
          type: string
        cancel_url:
          description: 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.
          maxLength: 5000
          type: string
        client_reference_id:
          description: 'A unique string to reference the Checkout Session. This can be a

            customer ID, a cart ID, or similar, and can be used to reconcile the

            session with your internal systems.'
          maxLength: 200
          type: string
        consent_collection:
          description: Configure fields for the Checkout Session to gather active consent from customers.
          properties:
            payment_method_reuse_agreement:
              properties:
                position:
                  enum:
                  - auto
                  - hidden
                  type: string
              required:
              - position
              title: payment_method_reuse_agreement_params
              type: object
            promotions:
              enum:
              - auto
              - none
              type: string
            terms_of_service:
              enum:
              - none
              - required
              type: string
          title: consent_collection_params
          type: object
        currency:
          description: 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). Required in `setup` mode when `payment_method_types` is not set.
          type: string
        custom_fields:
          description: Collect additional information from your customer using custom fields. Up to 2 fields are supported.
          items:
            properties:
              dropdown:
                properties:
                  options:
                    items:
                      properties:
                        label:
                          maxLength: 100
                          type: string
                        value:
                          maxLength: 100
                          type: string
                      required:
                      - label
                      - value
                      title: custom_field_option_param
                      type: object
                    type: array
                required:
                - options
                title: custom_field_dropdown_param
                type: object
              key:
                maxLength: 200
                type: string
              label:
                properties:
                  custom:
                    maxLength: 50
                    type: string
                  type:
                    enum:
                    - custom
                    type: string
                required:
                - custom
                - type
                title: custom_field_label_param
                type: object
              numeric:
                properties:
                  maximum_length:
                    type: integer
                  minimum_length:
                    type: integer
                title: custom_field_numeric_param
                type: object
              optional:
                type: boolean
              text:
                properties:
                  maximum_length:
                    type: integer
                  minimum_length:
                    type: integer
                title: custom_field_text_param
                type: object
              type:
                enum:
                - dropdown
                - numeric
                - text
                type: string
            required:
            - key
            - label
            - type
            title: custom_field_param
            type: object
          type: array
        custom_text:
          description: Display additional text for your customers using custom text.
          properties:
            after_submit:
              anyOf:
              - properties:
                  message:
                    maxLength: 1200
                    type: string
                required:
                - message
                title: custom_text_position_param
                type: object
              - enum:
                - ''
                type: string
            shipping_address:
              anyOf:
              - properties:
                  message:
                    maxLength: 1200
                    type: string
                required:
                - message
                title: custom_text_position_param
                type: object
              - enum:
                - ''
                type: string
            submit:
              anyOf:
              - properties:
                  message:
                    maxLength: 1200
                    type: string
                required:
                - message
                title: custom_text_position_param
                type: object
              - enum:
                - ''
                type: string
            terms_of_service_acceptance:
              anyOf:
              - properties:
                  message:
                    maxLength: 1200
                    type: string
                required:
                - message
                title: custom_text_position_param
                type: object
              - enum:
                - ''
                type: string
          title: custom_text_param
          type: object
        customer:
          description: 'ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card

            payment method will be used to prefill the email, name, card details, and billing address

            on the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)

            will be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer''s card details.


            If the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.

            If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.


            If blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow.


            You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.'
          maxLength: 5000
          type: string
        customer_creation:
          description: 'Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.


            When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout

            with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).


            Sessions that don''t create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)

            in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.


            Can only be set in `payment` and `setup` mode.'
          enum:
          - always
          - if_required
          type: string
        customer_email:
          description: 'If provided, this value will be used when the Customer object is created.

            If not provided, customers will be asked to enter their email address.

            Use this parameter to prefill customer data if you already have an email

            on file. To access information about the customer once a session is

            complete, use the `customer` field.'
          type: string
        customer_update:
          description: Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
          properties:
            address:
              enum:
              - auto
              - never
              type: string
              x-stripeBypassValidation: true
            name:
              enum:
              - auto
              - never
              type: string
              x-stripeBypassValidation: true
            shipping:
              enum:
              - auto
              - never
              type: string
              x-stripeBypassValidation: true
          title: customer_update_params
          type: object
        discounts:
          description: The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
          items:
            properties:
              coupon:
                maxLength: 5000
                type: string
              promotion_code:
                maxLength: 5000
                type: string
            title: discount_params
            type: object
          type: array
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        expires_at:
          description: The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
          format: unix-time
          type: integer
        invoice_creation:
          description: Generate a post-purchase Invoice for one-time payments.
          properties:
            enabled:
              type: boolean
            invoice_data:
              properties:
                account_tax_ids:
                  anyOf:
                  - items:
                      maxLength: 5000
                      type: string
                    type: array
                  - enum:
                    - ''
                    type: string
                custom_fields:
                  anyOf:
                  - items:
                      properties:
                        name:
                          maxLength: 30
                          type: string
                        value:
                          maxLength: 30
                          type: string
                      required:
                      - name
                      - value
                      title: custom_field_params
                      type: object
                    type: array
                  - enum:
                    - ''
                    type: string
                description:
                  maxLength: 1500
                  type: string
                footer:
                  maxLength: 5000
                  type: string
                metadata:
                  additionalProperties:
                    type: string
                  type: object
                rendering_options:
                  anyOf:
                  - properties:
                      amount_tax_display:
                        enum:
                        - ''
                        - exclude_tax
                        - include_inclusive_tax
                        type: string
                    title: rendering_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
              title: invoice_data_params
              type: object
          required:
          - enabled
          title: invoice_creation_params
          type: object
        line_items:
          description: 'A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).


            For `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.


            For `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.'
          items:
            properties:
              adjustable_quantity:
                properties:
                  enabled:
                    type: boolean
                  maximum:
                    type: integer
                  minimum:
                    type: integer
                required:
                - enabled
                title: adjustable_quantity_params
                type: object
              dynamic_tax_rates:
                items:
                  maxLength: 5000
                  type: string
                type: array
              price:
                maxLength: 5000
                type: string
              price_data:
                properties:
                  currency:
                    type: string
                  product:
                    maxLength: 5000
                    type: string
                  product_data:
                    properties:
                      description:
                        maxLength: 40000
                        type: string
                      images:
                        items:
                          type: string
                        type: array
                      metadata:
                        additionalProperties:
                          type: string
                        type: object
                      name:
                        maxLength: 5000
                        type: string
                      tax_code:
                        maxLength: 5000
                        type: string
                    required:
                    - name
                    title: product_data
                    type: object
                  recurring:
                    properties:
                      interval:
                        enum:
                        - day
                        - month
                        - week
                        - year
                        type: string
                      interval_count:
                        type: integer
                    required:
                    - interval
                    title: recurring_adhoc
                    type: object
                  tax_behavior:
                    enum:
                    - exclusive
                    - inclusive
                    - unspecified
                    type: string
                  unit_amount:
                    type: integer
                  unit_amount_decimal:
                    format: decimal
                    type: string
                required:
                - currency
                title: price_data_with_product_data
                type: object
              quantity:
                type: integer
              tax_rates:
                items:
                  maxLength: 5000
                  type: string
                type: array
            title: line_item_params
            type: object
          type: array
        locale:
          description: The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
          enum:
          - 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
          type: string
          x-stripeBypassValidation: true
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        mode:
          description: The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
          enum:
          - payment
          - setup
          - subscription
          type: string
        payment_intent_data:
          description: A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
          properties:
            application_fee_amount:
              type: integer
            capture_method:
              enum:
              - automatic
              - automatic_async
              - manual
              type: string
            description:
              maxLength: 1000
              type: string
            metadata:
              additionalProperties:
                type: string
              type: object
            on_behalf_of:
              type: string
            receipt_email:
              type: string
            setup_future_usage:
              enum:
              - off_session
              - on_session
              type: string
            shipping:
              properties:
                address:
                  properties:
                    city:
                      maxLength: 5000
                      type: string
                    country:
                      maxLength: 5000
                      type: string
                    line1:
                      maxLength: 5000
                      type: string
                    line2:
                      maxLength: 5000
                      type: string
                    postal_code:
                      maxLength: 5000
                      type: string
                    state:
                      maxLength: 5000
                      type: string
                  required:
                  - line1
                  title: address
                  type: object
                carrier:
                  maxLength: 5000
                  type: string
                name:
                  maxLength: 5000
                  type: string
                phone:
                  maxLength: 5000
                  type: string
                tracking_number:
                  maxLength: 5000
                  type: string
              required:
              - address
              - name
              title: shipping
              type: object
            statement_descriptor:
              maxLength: 22
              type: string
            statement_descriptor_suffix:
              maxLength: 22
              type: string
            transfer_data:
              properties:
                amount:
                  type: integer
                destination:
                  type: string
              required:
              - destination
              title: transfer_data_params
              type: object
            transfer_group:
              type: string
          title: payment_intent_data_params
          type: object
        payment_method_collection:
          description: 'Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.

            This may occur if the Checkout Session includes a free trial or a discount.


            Can only be set in `subscription` mode.


            If you''d like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).'
          enum:
          - always
          - if_required
          type: string
        payment_method_configuration:
          description: The ID of the payment method configuration to use with this Checkout session.
          maxLength: 100
          type: string
        payment_method_options:
          description: Payment-method-specific configuration.
          properties:
            acss_debit:
              properties:
                currency:
                  enum:
                  - cad
                  - usd
                  type: string
                mandate_options:
                  properties:
                    custom_mandate_url:
                      anyOf:
                      - type: string
                      - enum:
                        - ''
                        type: string
                    default_for:
                      items:
                        enum:
                        - invoice
                        - subscription
                        type: string
                      type: array
                    interval_description:
                      maxLength: 500
                      type: string
                    payment_schedule:
                      enum:
                      - combined
                      - interval
                      - sporadic
                      type: string
                    transaction_type:
                      enum:
                      - business
                      - personal
                      type: string
                  title: mandate_options_param
                  type: object
                setup_future_usage:
                  enum:
                  - none
                  - off_session
                  - on_session
                  type: string
                verification_method:
                  enum:
                  - automatic
                  - instant
                  - microdeposits
                  type: string
                  x-stripeBypassValidation: true
              title: payment_method_options_param
              type: object
            affirm:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            afterpay_clearpay:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            alipay:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            au_becs_debit:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            bacs_debit:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  - off_session
                  - on_session
                  type: string
              title: payment_method_options_param
              type: object
            bancontact:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            boleto:
              properties:
                expires_after_days:
                  type: integer
                setup_future_usage:
                  enum:
                  - none
                  - off_session
                  - on_session
                  type: string
              title: payment_method_options_param
              type: object
            card:
              properties:
                installments:
                  properties:
                    enabled:
                      type: boolean
                  title: installments_param
                  type: object
                setup_future_usage:
                  enum:
                  - off_session
                  - on_session
                  type: string
                statement_descriptor_suffix_kana:
                  maxLength: 22
                  type: string
                statement_descriptor_suffix_kanji:
                  maxLength: 17
                  type: string
              title: payment_method_options_param
              type: object
            cashapp:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  - off_session
                  - on_session
                  type: string
              title: payment_method_options_param
              type: object
            customer_balance:
              properties:
                bank_transfer:
                  properties:
                    eu_bank_transfer:
                      properties:
                        country:
                          maxLength: 5000
                          type: string
                      required:
                      - country
                      title: eu_bank_transfer_params
                      type: object
                    requested_address_types:
                      items:
                        enum:
                        - aba
                        - iban
                        - sepa
                        - sort_code
                        - spei
                        - swift
                        - zengin
                        type: string
                        x-stripeBypassValidation: true
                      type: array
                    type:
                      enum:
                      - eu_bank_transfer
                      - gb_bank_transfer
                      - jp_bank_transfer
                      - mx_bank_transfer
                      - us_bank_transfer
                      type: string
                      x-stripeBypassValidation: true
                  required:
                  - type
                  title: bank_transfer_param
                  type: object
                funding_type:
                  enum:
                  - bank_transfer
                  type: string
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            eps:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            fpx:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            giropay:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            grabpay:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            ideal:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            klarna:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            konbini:
              properties:
                expires_after_days:
                  type: integer
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            link:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  - off_session
                  type: string
              title: payment_method_options_param
              type: object
            oxxo:
              properties:
                expires_after_days:
                  type: integer
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            p24:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  type: string
                tos_shown_and_accepted:
                  type: boolean
              title: payment_method_options_param
              type: object
            paynow:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            paypal:
              properties:
                capture_method:
                  enum:
                  - ''
                  - manual
                  type: string
                preferred_locale:
                  enum:
                  - 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
                  type: string
                  x-stripeBypassValidation: true
                reference:
                  maxLength: 127
                  type: string
                risk_correlation_id:
                  maxLength: 32
                  type: string
                setup_future_usage:
                  enum:
                  - ''
                  - none
                  - off_session
                  type: string
              title: payment_method_options_param
              type: object
            pix:
              properties:
                expires_after_seconds:
                  type: integer
              title: payment_method_options_param
              type: object
            revolut_pay:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  - off_session
                  type: string
              title: payment_method_options_param
              type: object
            sepa_debit:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  - off_session
                  - on_session
                  type: string
              title: payment_method_options_param
              type: object
            sofort:
              properties:
                setup_future_usage:
                  enum:
                  - none
                  type: string
              title: payment_method_options_param
              type: object
            us_bank_account:
              properties:
                financial_connections:
                  properties:
                    permissions:
                      items:
                        enum:
                        - balances
                        - ownership
                        - payment_method
                        - transactions
                        maxLength: 5000
                        type: string
                        x-stripeBypassValidation: true
                      type: array
                    prefetch:
                      items:
                        enum:
                        - balances
                        - transactions
                        type: string
                        x-stripeBypassValidation: true
                      type: array
                  title: linked_account_options_param
                  type: object
                setup_future_usage:
                  enum:
                  - none
                  - off_session
                  - on_session
                  type: string
                verification_method:
                  enum:
                  - automatic
                  - instant
                  type: string
                  x-stripeBypassValidation: true
              title: payment_method_options_param
              type: object
            wechat_pay:
              properties:
                app_id:
                  maxLength: 5000
                  type: string
                client:
                  enum:
                  - android
                  - ios
                  - web
                  type: string
                  x-stripeBypassValidation: true
                setup_future_usage:
                  enum:
                  - none
                  type: string
              required:
              - client
              title: payment_method_options_param
              type: object
          title: payment_method_options_param
          type: object
        payment_method_types:
          description: 'A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.


            You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).

            See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.


            Read more about the supported payment methods and their requirements in our [payment

            method details guide](/docs/payments/checkout/payment-methods).


            If multiple payment methods are passed, Checkout will dynamically reorder them to

            prioritize the most relevant payment methods based on the customer''s location and

            other characteristics.'
          items:
            enum:
            - acss_debit
            - affirm
            - afterpay_clearpay
            - alipay
            - au_becs_debit
            - bacs_debit
            - bancontact
            - blik
            - boleto
            - card
            - cashapp
            - customer_balance
            - eps
            - fpx
            - giropay
            - grabpay
            - ideal
            - klarna
            - konbini
            - link
            - oxxo
            - p24
            - paynow
            - paypal
            - pix
            - promptpay
            - revolut_pay
            - sepa_debit
            - sofort
            - us_bank_account
            - wechat_pay
            - zip
            type: string
            x-stripeBypassValidation: true
          type: array
        phone_number_collection:
          description: 'Controls phone number collection settings for the session.


            We recommend that you review your privacy policy and check with your legal contacts

            before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).'
          properties:
            enabled:
              type: boolean
          required:
          - enabled
          title: phone_number_collection_params
          type: object
        redirect_on_completion:
          description: 'This parameter applies to `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: ''if_required''`, then we will only redirect if your user chooses a redirect-based payment method.'
          enum:
          - always
          - if_required
          - never
          type: string
        return_url:
          description: 'The URL to redirect your customer back to after they authenticate or cancel their payment on the

            payment method''s app or site. This parameter is required if ui_mode is `embedded`

            and redirect-based payment methods are enabled on the session.'
          type: string
        setup_intent_data:
          description: A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
          properties:
            description:
              maxLength: 1000
              type: string
            metadata:
              additionalProperties:
                type: string
              type: object
            on_behalf_of:
              type: string
          title: setup_intent_data_param
          type: object
        shipping_address_collection:
          description: When set, provides configuration for Checkout to collect a shipping address from a customer.
          properties:
            allowed_countries:
              items:
                enum:
                - 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
                - 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
                type: string
              type: array
          required:
          - allowed_countries
          title: shipping_address_collection_params
          type: object
        shipping_options:
          description: The shipping rate options to apply to this Session. Up to a maximum of 5.
          items:
            properties:
              shipping_rate:
                maxLength: 5000
                type: string
              shipping_rate_data:
                properties:
                  delivery_estimate:
                    properties:
                      maximum:
                        properties:
                          unit:
                            enum:
                            - business_day
                            - day
                            - hour
                            - month
                            - week
                            type: string
                          value:
                            type: integer
                        required:
                        - unit
                        - value
                        title: delivery_estimate_bound
                        type: object
                      minimum:
                        properties:
                          unit:
                            enum:
                            - business_day
                            - day
                            - hour
                            - month
                            - week
                            type: string
                          value:
                            type: integer
                        required:
                        - unit
                        - value
                        title: delivery_estimate_bound
                        type: object
                    title: delivery_estimate
                    type: object
                  display_name:
                    maxLength: 100
                    type: string
                  fixed_amount:
                    properties:
                      amount:
                        type: integer
                      currency:
                        type: string
                      currency_options:
                        additionalProperties:
                          properties:
                            amount:
                              type: integer
                            tax_behavior:
                              enum:
                              - exclusive
                              - inclusive
                              - unspecified
                              type: string
                          required:
                          - amount
                          title: currency_option
                          type: object
                        type: object
                    required:
                    - amount
                    - currency
                    title: fixed_amount
                    type: object
                  metadata:
                    additionalProperties:
                      type: string
                    type: object
                  tax_behavior:
                    enum:
                    - exclusive
                    - inclusive
                    - unspecified
                    type: string
                  tax_code:
                    type: string
                  type:
                    enum:
                    - fixed_amount
                    type: string
                required:
                - display_name
                title: method_params
                type: object
            title: shipping_option_params
            type: object
          type: array
        submit_type:
          description: 'Describes the type of transaction being performed by Checkout in order to customize

            relevant text on the page, such as the submit button. `submit_type` can only be

            specified on Checkout Sessions in `payment` mode, but not Checkout Sessions

            in `subscription` or `setup` mode. Possible values are `auto`, `pay`, `book`, `donate`. If blank or `auto`, `pay` is used.'
          enum:
          - auto
          - book
          - donate
          - pay
          type: string
        subscription_data:
          description: A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
          properties:
            application_fee_percent:
              type: number
            billing_cycle_anchor:
              format: unix-time
              type: integer
            default_tax_rates:
              items:
                maxLength: 5000
                type: string
              type: array
            description:
              maxLength: 500
              type: string
            metadata:
              additionalProperties:
                type: string
              type: object
            on_behalf_of:
              type: string
            proration_behavior:
              enum:
              - create_prorations
              - none
              type: string
            transfer_data:
              properties:
                amount_percent:
                  type: number
                destination:
                  type: string
              required:
              - destination
              title: transfer_data_specs
              type: object
            trial_end:
              format: unix-time
              type: integer
            trial_period_days:
              type: integer
            trial_settings:
              properties:
                end_behavior:
                  properties:
                    missing_payment_method:
                      enum:
                      - cancel
                      - create_invoice
                      - pause
                      type: string
                  required:
                  - missing_payment_method
                  title: end_behavior
                  type: object
              required:
              - end_behavior
              title: trial_settings_config
              type: object
          title: subscription_data_params
          type: object
        success_url:
          description: 'The URL to which Stripe should send customers when payment or setup

            is complete.

            This parameter is not allowed if ui_mode is `embedded`. If you’d like to use

            information from the successful Checkout Session on your page, read the

            guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).'
          maxLength: 5000
          type: string
        tax_id_collection:
          description: Controls tax ID collection settings for the session.
          properties:
            enabled:
              type: boolean
          required:
          - enabled
          title: tax_id_collection_params
          type: object
        ui_mode:
          description: '`ui_mode` can be `hosted` or `embedded`. The default is `hosted`.'
          enum:
          - embedded
          - hosted
          type: string
          x-stripeBypassValidation: true
    file:
      description: 'This object represents files hosted on Stripe''s servers. You can upload

        files with the [create file](https://stripe.com/docs/api#create_file) request

        (for example, when uploading dispute evidence). Stripe also

        creates files independently (for example, the results of a [Sigma scheduled

        query](#scheduled_queries)).


        Related guide: [File upload guide](https://stripe.com/docs/file-upload)'
      properties:
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        expires_at:
          description: The file expires and isn't available at this time in epoch seconds.
          format: unix-time
          nullable: true
          type: integer
        filename:
          description: The suitable name for saving the file to a filesystem.
          maxLength: 5000
          nullable: true
          type: string
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        links:
          description: A list of [file links](https://stripe.com/docs/api#file_links) that point at this file.
          nullable: true
          properties:
            data:
              description: Details about each object.
              items:
                $ref: '#/components/schemas/file_link'
              type: array
            has_more:
              description: True if this list has another page of items after this one that can be fetched.
              type: boolean
            object:
              description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
              enum:
              - list
              type: string
            url:
              description: The URL where this list can be accessed.
              maxLength: 5000
              pattern: ^/v1/file_links
              type: string
          required:
          - data
          - has_more
          - object
          - url
          title: FileResourceFileLinkList
          type: object
          x-expandableFields:
          - data
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - file
          type: string
        purpose:
          description: The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
          enum:
          - account_requirement
          - additional_verification
          - business_icon
          - business_logo
          - customer_signature
          - dispute_evidence
          - document_provider_identity_document
          - finance_report_run
          - identity_document
          - identity_document_downloadable
          - pci_document
          - selfie
          - sigma_scheduled_query
          - tax_document_user_upload
          - terminal_reader_splashscreen
          type: string
          x-stripeBypassValidation: true
        size:
          description: The size of the file object in bytes.
          type: integer
        title:
          description: A suitable title for the document.
          maxLength: 5000
          nullable: true
          type: string
        type:
          description: The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).
          maxLength: 5000
          nullable: true
          type: string
        url:
          description: Use your live secret API key to download the file from this URL.
          maxLength: 5000
          nullable: true
          type: string
      required:
      - created
      - id
      - object
      - purpose
      - size
      title: File
      type: object
      x-expandableFields:
      - links
      x-resourceId: file
    PostIssuingCardsRequest:
      type: object
      required:
      - currency
      - type
      properties:
        cardholder:
          description: The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated.
          maxLength: 5000
          type: string
        currency:
          description: The currency for the card.
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        financial_account:
          type: string
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        replacement_for:
          description: The card this is meant to be a replacement for (if any).
          maxLength: 5000
          type: string
        replacement_reason:
          description: If `replacement_for` is specified, this should indicate why that card is being replaced.
          enum:
          - damaged
          - expired
          - lost
          - stolen
          type: string
          x-stripeBypassValidation: true
        shipping:
          description: The address where the card will be shipped.
          properties:
            address:
              properties:
                city:
                  maxLength: 5000
                  type: string
                country:
                  maxLength: 5000
                  type: string
                line1:
                  maxLength: 5000
                  type: string
                line2:
                  maxLength: 5000
                  type: string
                postal_code:
                  maxLength: 5000
                  type: string
                state:
                  maxLength: 5000
                  type: string
              required:
              - city
              - country
              - line1
              - postal_code
              title: required_address
              type: object
            customs:
              properties:
                eori_number:
                  maxLength: 5000
                  type: string
              title: customs_param
              type: object
            name:
              maxLength: 5000
              type: string
            phone_number:
              type: string
            require_signature:
              type: boolean
            service:
              enum:
              - express
              - priority
              - standard
              type: string
              x-stripeBypassValidation: true
            type:
              enum:
              - bulk
              - individual
              type: string
          required:
          - address
          - name
          title: shipping_specs
          type: object
        spending_controls:
          description: Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
          properties:
            allowed_categories:
              items:
                enum:
                - ac_refrigeration_repair
                - accounting_bookkeeping_services
                - advertising_services
                - agricultural_cooperative
                - airlines_air_carriers
                - airports_flying_fields
                - ambulance_services
                - amusement_parks_carnivals
                - antique_reproductions
                - antique_shops
                - aquariums
                - architectural_surveying_services
                - art_dealers_and_galleries
                - artists_supply_and_craft_shops
                - auto_and_home_supply_stores
                - auto_body_repair_shops
                - auto_paint_shops
                - auto_service_shops
                - automated_cash_disburse
                - automated_fuel_dispensers
                - automobile_associations
                - automotive_parts_and_accessories_stores
                - automotive_tire_stores
                - bail_and_bond_payments
                - bakeries
                - bands_orchestras
                - barber_and_beauty_shops
                - betting_casino_gambling
                - bicycle_shops
                - billiard_pool_establishments
                - boat_dealers
                - boat_rentals_and_leases
                - book_stores
                - books_periodicals_and_newspapers
                - bowling_alleys
                - bus_lines
                - business_secretarial_schools
                - buying_shopping_services
                - cable_satellite_and_other_pay_television_and_radio
                - camera_and_photographic_supply_stores
                - candy_nut_and_confectionery_stores
                - car_and_truck_dealers_new_used
                - car_and_truck_dealers_used_only
                - car_rental_agencies
                - car_washes
                - carpentry_services
                - carpet_upholstery_cleaning
                - caterers
                - charitable_and_social_service_organizations_fundraising
                - chemicals_and_allied_products
                - child_care_services
                - childrens_and_infants_wear_stores
                - chiropodists_podiatrists
                - chiropractors
                - cigar_stores_and_stands
                - civic_social_fraternal_associations
                - cleaning_and_maintenance
                - clothing_rental
                - colleges_universities
                - commercial_equipment
                - commercial_footwear
                - commercial_photography_art_and_graphics
                - commuter_transport_and_ferries
                - computer_network_services
                - computer_programming
                - computer_repair
                - computer_software_stores
                - computers_peripherals_and_software
                - concrete_work_services
                - construction_materials
                - consulting_public_relations
                - correspondence_schools
                - cosmetic_stores
                - counseling_services
                - country_clubs
                - courier_services
                - court_costs
                - credit_reporting_agencies
                - cruise_lines
                - dairy_products_stores
                - dance_hall_studios_schools
                - dating_escort_services
                - dentists_orthodontists
                - department_stores
                - detective_agencies
                - digital_goods_applications
                - digital_goods_games
                - digital_goods_large_volume
                - digital_goods_media
                - direct_marketing_catalog_merchant
                - direct_marketing_combination_catalog_and_retail_merchant
                - direct_marketing_inbound_telemarketing
                - direct_marketing_insurance_services
                - direct_marketing_other
                - direct_marketing_outbound_telemarketing
                - direct_marketing_subscription
                - direct_marketing_travel
                - discount_stores
                - doctors
                - door_to_door_sales
                - drapery_window_covering_and_upholstery_stores
                - drinking_places
                - drug_stores_and_pharmacies
                - drugs_drug_proprietaries_and_druggist_sundries
                - dry_cleaners
                - durable_goods
                - duty_free_stores
                - eating_places_restaurants
                - educational_services
                - electric_razor_stores
                - electric_vehicle_charging
                - electrical_parts_and_equipment
                - electrical_services
                - electronics_repair_shops
                - electronics_stores
                - elementary_secondary_schools
                - emergency_services_gcas_visa_use_only
                - employment_temp_agencies
                - equipment_rental
                - exterminating_services
                - family_clothing_stores
                - fast_food_restaurants
                - financial_institutions
                - fines_government_administrative_entities
                - fireplace_fireplace_screens_and_accessories_stores
                - floor_covering_stores
                - florists
                - florists_supplies_nursery_stock_and_flowers
                - freezer_and_locker_meat_provisioners
                - fuel_dealers_non_automotive
                - funeral_services_crematories
                - furniture_home_furnishings_and_equipment_stores_except_appliances
                - furniture_repair_refinishing
                - furriers_and_fur_shops
                - general_services
                - gift_card_novelty_and_souvenir_shops
                - glass_paint_and_wallpaper_stores
                - glassware_crystal_stores
                - golf_courses_public
                - government_licensed_horse_dog_racing_us_region_only
                - government_licensed_online_casions_online_gambling_us_region_only
                - government_owned_lotteries_non_us_region
                - government_owned_lotteries_us_region_only
                - government_services
                - grocery_stores_supermarkets
                - hardware_equipment_and_supplies
                - hardware_stores
                - health_and_beauty_spas
                - hearing_aids_sales_and_supplies
                - heating_plumbing_a_c
                - hobby_toy_and_game_shops
                - home_supply_warehouse_stores
                - hospitals
                - hotels_motels_and_resorts
                - household_appliance_stores
                - industrial_supplies
                - information_retrieval_services
                - insurance_default
                - insurance_underwriting_premiums
                - intra_company_purchases
                - jewelry_stores_watches_clocks_and_silverware_stores
                - landscaping_services
                - laundries
                - laundry_cleaning_services
                - legal_services_attorneys
                - luggage_and_leather_goods_stores
                - lumber_building_materials_stores
                - manual_cash_disburse
                - marinas_service_and_supplies
                - marketplaces
                - masonry_stonework_and_plaster
                - massage_parlors
                - medical_and_dental_labs
                - medical_dental_ophthalmic_and_hospital_equipment_and_supplies
                - medical_services
                - membership_organizations
                - mens_and_boys_clothing_and_accessories_stores
                - mens_womens_clothing_stores
                - metal_service_centers
                - miscellaneous
                - miscellaneous_apparel_and_accessory_shops
                - miscellaneous_auto_dealers
                - miscellaneous_business_services
                - miscellaneous_food_stores
                - miscellaneous_general_merchandise
                - miscellaneous_general_services
                - miscellaneous_home_furnishing_specialty_stores
                - miscellaneous_publishing_and_printing
                - miscellaneous_recreation_services
                - miscellaneous_repair_shops
                - miscellaneous_specialty_retail
                - mobile_home_dealers
                - motion_picture_theaters
                - motor_freight_carriers_and_trucking
                - motor_homes_dealers
                - motor_vehicle_supplies_and_new_parts
                - motorcycle_shops_and_dealers
                - motorcycle_shops_dealers
                - music_stores_musical_instruments_pianos_and_sheet_music
                - news_dealers_and_newsstands
                - non_fi_money_orders
                - non_fi_stored_value_card_purchase_load
                - nondurable_goods
                - nurseries_lawn_and_garden_supply_stores
                - nursing_personal_care
                - office_and_commercial_furniture
                - opticians_eyeglasses
                - optometrists_ophthalmologist
                - orthopedic_goods_prosthetic_devices
                - osteopaths
                - package_stores_beer_wine_and_liquor
                - paints_varnishes_and_supplies
                - parking_lots_garages
                - passenger_railways
                - pawn_shops
                - pet_shops_pet_food_and_supplies
                - petroleum_and_petroleum_products
                - photo_developing
                - photographic_photocopy_microfilm_equipment_and_supplies
                - photographic_studios
                - picture_video_production
                - piece_goods_notions_and_other_dry_goods
                - plumbing_heating_equipment_and_supplies
                - political_organizations
                - postal_services_government_only
                - precious_stones_and_metals_watches_and_jewelry
                - professional_services
                - public_warehousing_and_storage
                - quick_copy_repro_and_blueprint
                - railroads
                - real_estate_agents_and_managers_rentals
                - record_stores
                - recreational_vehicle_rentals
                - religious_goods_stores
                - religious_organizations
                - roofing_siding_sheet_metal
                - secretarial_support_services
                - security_brokers_dealers
                - service_stations
                - sewing_needlework_fabric_and_piece_goods_stores
                - shoe_repair_hat_cleaning
                - shoe_stores
                - small_appliance_repair
                - snowmobile_dealers
                - special_trade_services
                - specialty_cleaning
                - sporting_goods_stores
                - sporting_recreation_camps
                - sports_and_riding_apparel_stores
                - sports_clubs_fields
                - stamp_and_coin_stores
                - stationary_office_supplies_printing_and_writing_paper
                - stationery_stores_office_and_school_supply_stores
                - swimming_pools_sales
                - t_ui_travel_germany
                - tailors_alterations
                - tax_payments_government_agencies
                - tax_preparation_services
                - taxicabs_limousines
                - telecommunication_equipment_and_telephone_sales
                - telecommunication_services
                - telegraph_services
                - tent_and_awning_shops
                - testing_laboratories
                - theatrical_ticket_agencies
                - timeshares
                - tire_retreading_and_repair
                - tolls_bridge_fees
                - tourist_attractions_and_exhibits
                - towing_services
                - trailer_parks_campgrounds
                - transportation_services
                - travel_agencies_tour_operators
                - truck_stop_iteration
                - truck_utility_trailer_rentals
                - typesetting_plate_making_and_related_services
                - typewriter_stores
                - u_s_federal_government_agencies_or_departments
                - uniforms_commercial_clothing
                - used_merchandise_and_secondhand_stores
                - utilities
                - variety_stores
                - veterinary_services
                - video_amusement_game_supplies
                - video_game_arcades
                - video_tape_rental_stores
                - vocational_trade_schools
                - watch_jewelry_repair
                - welding_repair
                - wholesale_clubs
                - wig_and_toupee_stores
                - wires_money_orders
                - womens_accessory_and_specialty_shops
                - womens_ready_to_wear_stores
                - wrecking_and_salvage_yards
                maxLength: 5000
                type: string
              type: array
            blocked_categories:
              items:
                enum:
                - ac_refrigeration_repair
                - accounting_bookkeeping_services
                - advertising_services
                - agricultural_cooperative
                - airlines_air_carriers
                - airports_flying_fields
                - ambulance_services
                - amusement_parks_carnivals
                - antique_reproductions
                - antique_shops
                - aquariums
                - architectural_surveying_services
                - art_dealers_and_galleries
                - artists_supply_and_craft_shops
                - auto_and_home_supply_stores
                - auto_body_repair_shops
                - auto_paint_shops
                - auto_service_shops
                - automated_cash_disburse
                - automated_fuel_dispensers
                - automobile_associations
                - automotive_parts_and_accessories_stores
                - automotive_tire_stores
                - bail_and_bond_payments
                - bakeries
                - bands_orchestras
                - barber_and_beauty_shops
                - betting_casino_gambling
                - bicycle_shops
                - billiard_pool_establishments
                - boat_dealers
                - boat_rentals_and_leases
                - book_stores
                - books_periodicals_and_newspapers
                - bowling_alleys
                - bus_lines
                - business_secretarial_schools
                - buying_shopping_services
                - cable_satellite_and_other_pay_television_and_radio
                - camera_and_photographic_supply_stores
                - candy_nut_and_confectionery_stores
                - car_and_truck_dealers_new_used
                - car_and_truck_dealers_used_only
                - car_rental_agencies
                - car_washes
                - carpentry_services
                - carpet_upholstery_cleaning
                - caterers
                - charitable_and_social_service_organizations_fundraising
                - chemicals_and_allied_products
                - child_care_services
                - childrens_and_infants_wear_stores
                - chiropodists_podiatrists
                - chiropractors
                - cigar_stores_and_stands
                - civic_social_fraternal_associations
                - cleaning_and_maintenance
                - clothing_rental
                - colleges_universities
                - commercial_equipment
                - commercial_footwear
                - commercial_photography_art_and_graphics
                - commuter_transport_and_ferries
                - computer_network_services
                - computer_programming
                - computer_repair
                - computer_software_stores
                - computers_peripherals_and_software
                - concrete_work_services
                - construction_materials
                - consulting_public_relations
                - correspondence_schools
                - cosmetic_stores
                - counseling_services
                - country_clubs
                - courier_services
                - court_costs
                - credit_reporting_agencies
                - cruise_lines
                - dairy_products_stores
                - dance_hall_studios_schools
                - dating_escort_services
                - dentists_orthodontists
                - department_stores
                - detective_agencies
                - digital_goods_applications
                - digital_goods_games
                - digital_goods_large_volume
                - digital_goods_media
                - direct_marketing_catalog_merchant
                - direct_marketing_combination_catalog_and_retail_merchant
                - direct_marketing_inbound_telemarketing
                - direct_marketing_insurance_services
                - direct_marketing_other
                - direct_marketing_outbound_telemarketing
                - direct_marketing_subscription
                - direct_marketing_travel
                - discount_stores
                - doctors
                - door_to_door_sales
                - drapery_window_covering_and_upholstery_stores
                - drinking_places
                - drug_stores_and_pharmacies
                - drugs_drug_proprietaries_and_druggist_sundries
                - dry_cleaners
                - durable_goods
                - duty_free_stores
                - eating_places_restaurants
                - educational_services
                - electric_razor_stores
                - electric_vehicle_charging
                - electrical_parts_and_equipment
                - electrical_services
                - electronics_repair_shops
                - electronics_stores
                - elementary_secondary_schools
                - emergency_services_gcas_visa_use_only
                - employment_temp_agencies
                - equipment_rental
                - exterminating_services
                - family_clothing_stores
                - fast_food_restaurants
                - financial_institutions
                - fines_government_administrative_entities
                - fireplace_fireplace_screens_and_accessories_stores
                - floor_covering_stores
                - florists
                - florists_supplies_nursery_stock_and_flowers
                - freezer_and_locker_meat_provisioners
                - fuel_dealers_non_automotive
                - funeral_services_crematories
                - furniture_home_furnishings_and_equipment_stores_except_appliances
                - furniture_repair_refinishing
                - furriers_and_fur_shops
                - general_services
                - gift_card_novelty_and_souvenir_shops
                - glass_paint_and_wallpaper_stores
                - glassware_crystal_stores
                - golf_courses_public
                - government_licensed_horse_dog_racing_us_region_only
                - government_licensed_online_casions_online_gambling_us_region_only
                - government_owned_lotteries_non_us_region
                - government_owned_lotteries_us_region_only
                - government_services
                - grocery_stores_supermarkets
                - hardware_equipment_and_supplies
                - hardware_stores
                - health_and_beauty_spas
                - hearing_aids_sales_and_supplies
                - heating_plumbing_a_c
                - hobby_toy_and_game_shops
                - home_supply_warehouse_stores
                - hospitals
                - hotels_motels_and_resorts
                - household_appliance_stores
                - industrial_supplies
                - information_retrieval_services
                - insurance_default
                - insurance_underwriting_premiums
                - intra_company_purchases
                - jewelry_stores_watches_clocks_and_silverware_stores
                - landscaping_services
                - laundries
                - laundry_cleaning_services
                - legal_services_attorneys
                - luggage_and_leather_goods_stores
                - lumber_building_materials_stores
                - manual_cash_disburse
                - marinas_service_and_supplies
                - marketplaces
                - masonry_stonework_and_plaster
                - massage_parlors
                - medical_and_dental_labs
                - medical_dental_ophthalmic_and_hospital_equipment_and_supplies
                - medical_services
                - membership_organizations
                - mens_and_boys_clothing_and_accessories_stores
                - mens_womens_clothing_stores
                - metal_service_centers
                - miscellaneous
                - miscellaneous_apparel_and_accessory_shops
                - miscellaneous_auto_dealers
                - miscellaneous_business_services
                - miscellaneous_food_stores
                - miscellaneous_general_merchandise
                - miscellaneous_general_services
                - miscellaneous_home_furnishing_specialty_stores
                - miscellaneous_publishing_and_printing
                - miscellaneous_recreation_services
                - miscellaneous_repair_shops
                - miscellaneous_specialty_retail
                - mobile_home_dealers
                - motion_picture_theaters
                - motor_freight_carriers_and_trucking
                - motor_homes_dealers
                - motor_vehicle_supplies_and_new_parts
                - motorcycle_shops_and_dealers
                - motorcycle_shops_dealers
                - music_stores_musical_instruments_pianos_and_sheet_music
                - news_dealers_and_newsstands
                - non_fi_money_orders
                - non_fi_stored_value_card_purchase_load
                - nondurable_goods
                - nurseries_lawn_and_garden_supply_stores
                - nursing_personal_care
                - office_and_commercial_furniture
                - opticians_eyeglasses
                - optometrists_ophthalmologist
                - orthopedic_goods_prosthetic_devices
                - osteopaths
                - package_stores_beer_wine_and_liquor
                - paints_varnishes_and_supplies
                - parking_lots_garages
                - passenger_railways
                - pawn_shops
                - pet_shops_pet_food_and_supplies
                - petroleum_and_petroleum_products
                - photo_developing
                - photographic_photocopy_microfilm_equipment_and_supplies
                - photographic_studios
                - picture_video_production
                - piece_goods_notions_and_other_dry_goods
                - plumbing_heating_equipment_and_supplies
                - political_organizations
                - postal_services_government_only
                - precious_stones_and_metals_watches_and_jewelry
                - professional_services
                - public_warehousing_and_storage
                - quick_copy_repro_and_blueprint
                - railroads
                - real_estate_agents_and_managers_rentals
                - record_stores
                - recreational_vehicle_rentals
                - religious_goods_stores
                - religious_organizations
                - roofing_siding_sheet_metal
                - secretarial_support_services
                - security_brokers_dealers
                - service_stations
                - sewing_needlework_fabric_and_piece_goods_stores
                - shoe_repair_hat_cleaning
                - shoe_stores
                - small_appliance_repair
                - snowmobile_dealers
                - special_trade_services
                - specialty_cleaning
                - sporting_goods_stores
                - sporting_recreation_camps
                - sports_and_riding_apparel_stores
                - sports_clubs_fields
                - stamp_and_coin_stores
                - stationary_office_supplies_printing_and_writing_paper
                - stationery_stores_office_and_school_supply_stores
                - swimming_pools_sales
                - t_ui_travel_germany
                - tailors_alterations
                - tax_payments_government_agencies
                - tax_preparation_services
                - taxicabs_limousines
                - telecommunication_equipment_and_telephone_sales
                - telecommunication_services
                - telegraph_services
                - tent_and_awning_shops
                - testing_laboratories
                - theatrical_ticket_agencies
                - timeshares
                - tire_retreading_and_repair
                - tolls_bridge_fees
                - tourist_attractions_and_exhibits
                - towing_services
                - trailer_parks_campgrounds
                - transportation_services
                - travel_agencies_tour_operators
                - truck_stop_iteration
                - truck_utility_trailer_rentals
                - typesetting_plate_making_and_related_services
                - typewriter_stores
                - u_s_federal_government_agencies_or_departments
                - uniforms_commercial_clothing
                - used_merchandise_and_secondhand_stores
                - utilities
                - variety_stores
                - veterinary_services
                - video_amusement_game_supplies
                - video_game_arcades
                - video_tape_rental_stores
                - vocational_trade_schools
                - watch_jewelry_repair
                - welding_repair
                - wholesale_clubs
                - wig_and_toupee_stores
                - wires_money_orders
                - womens_accessory_and_specialty_shops
                - womens_ready_to_wear_stores
                - wrecking_and_salvage_yards
                maxLength: 5000
                type: string
              type: array
            spending_limits:
              items:
                properties:
                  amount:
                    type: integer
                  categories:
                    items:
                      enum:
                      - ac_refrigeration_repair
                      - accounting_bookkeeping_services
                      - advertising_services
                      - agricultural_cooperative
                      - airlines_air_carriers
                      - airports_flying_fields
                      - ambulance_services
                      - amusement_parks_carnivals
                      - antique_reproductions
                      - antique_shops
                      - aquariums
                      - architectural_surveying_services
                      - art_dealers_and_galleries
                      - artists_supply_and_craft_shops
                      - auto_and_home_supply_stores
                      - auto_body_repair_shops
                      - auto_paint_shops
                      - auto_service_shops
                      - automated_cash_disburse
                      - automated_fuel_dispensers
                      - automobile_associations
                      - automotive_parts_and_accessories_stores
                      - automotive_tire_stores
                      - bail_and_bond_payments
                      - bakeries
                      - bands_orchestras
                      - barber_and_beauty_shops
                      - betting_casino_gambling
                      - bicycle_shops
                      - billiard_pool_establishments
                      - boat_dealers
                      - boat_rentals_and_leases
                      - book_stores
                      - books_periodicals_and_newspapers
                      - bowling_alleys
                      - bus_lines
                      - business_secretarial_schools
                      - buying_shopping_services
                      - cable_satellite_and_other_pay_television_and_radio
                      - camera_and_photographic_supply_stores
                      - candy_nut_and_confectionery_stores
                      - car_and_truck_dealers_new_used
                      - car_and_truck_dealers_used_only
                      - car_rental_agencies
                      - car_washes
                      - carpentry_services
                      - carpet_upholstery_cleaning
                      - caterers
                      - charitable_and_social_service_organizations_fundraising
                      - chemicals_and_allied_products
                      - child_care_services
                      - childrens_and_infants_wear_stores
                      - chiropodists_podiatrists
                      - chiropractors
                      - cigar_stores_and_stands
                      - civic_social_fraternal_associations
                      - cleaning_and_maintenance
                      - clothing_rental
                      - colleges_universities
                      - commercial_equipment
                      - commercial_footwear
                      - commercial_photography_art_and_graphics
                      - commuter_transport_and_ferries
                      - computer_network_services
                      - computer_programming
                      - computer_repair
                      - computer_software_stores
                      - computers_peripherals_and_software
                      - concrete_work_services
                      - construction_materials
                      - consulting_public_relations
                      - correspondence_schools
                      - cosmetic_stores
                      - counseling_services
                      - country_clubs
                      - courier_services
                      - court_costs
                      - credit_reporting_agencies
                      - cruise_lines
                      - dairy_products_stores
                      - dance_hall_studios_schools
                      - dating_escort_services
                      - dentists_orthodontists
                      - department_stores
                      - detective_agencies
                      - digital_goods_applications
                      - digital_goods_games
                      - digital_goods_large_volume
                      - digital_goods_media
                      - direct_marketing_catalog_merchant
                      - direct_marketing_combination_catalog_and_retail_merchant
                      - direct_marketing_inbound_telemarketing
                      - direct_marketing_insurance_services
                      - direct_marketing_other
                      - direct_marketing_outbound_telemarketing
                      - direct_marketing_subscription
                      - direct_marketing_travel
                      - discount_stores
                      - doctors
                      - door_to_door_sales
                      - drapery_window_covering_and_upholstery_stores
                      - drinking_places
                      - drug_stores_and_pharmacies
                      - drugs_drug_proprietaries_and_druggist_sundries
                      - dry_cleaners
                      - durable_goods
                      - duty_free_stores
                      - eating_places_restaurants
                      - educational_services
                      - electric_razor_stores
                      - electric_vehicle_charging
                      - electrical_parts_and_equipment
                      - electrical_services
                      - electronics_repair_shops
                      - electronics_stores
                      - elementary_secondary_schools
                      - emergency_services_gcas_visa_use_only
                      - employment_temp_agencies
                      - equipment_rental
                      - exterminating_services
                      - family_clothing_stores
                      - fast_food_restaurants
                      - financial_institutions
                      - fines_government_administrative_entities
                      - fireplace_fireplace_screens_and_accessories_stores
                      - floor_covering_stores
                      - florists
                      - florists_supplies_nursery_stock_and_flowers
                      - freezer_and_locker_meat_provisioners
                      - fuel_dealers_non_automotive
                      - funeral_services_crematories
                      - furniture_home_furnishings_and_equipment_stores_except_appliances
                      - furniture_repair_refinishing
                      - furriers_and_fur_shops
                      - general_services
                      - gift_card_novelty_and_souvenir_shops
                      - glass_paint_and_wallpaper_stores
                      - glassware_crystal_stores
                      - golf_courses_public
                      - government_licensed_horse_dog_racing_us_region_only
                      - government_licensed_online_casions_online_gambling_us_region_only
                      - government_owned_lotteries_non_us_region
                      - government_owned_lotteries_us_region_only
                      - government_services
                      - grocery_stores_supermarkets
                      - hardware_equipment_and_supplies
                      - hardware_stores
                      - health_and_beauty_spas
                      - hearing_aids_sales_and_supplies
                      - heating_plumbing_a_c
                      - hobby_toy_and_game_shops
                      - home_supply_warehouse_stores
                      - hospitals
                      - hotels_motels_and_resorts
                      - household_appliance_stores
                      - industrial_supplies
                      - information_retrieval_services
                      - insurance_default
                      - insurance_underwriting_premiums
                      - intra_company_purchases
                      - jewelry_stores_watches_clocks_and_silverware_stores
                      - landscaping_services
                      - laundries
                      - laundry_cleaning_services
                      - legal_services_attorneys
                      - luggage_and_leather_goods_stores
                      - lumber_building_materials_stores
                      - manual_cash_disburse
                      - marinas_service_and_supplies
                      - marketplaces
                      - masonry_stonework_and_plaster
                      - massage_parlors
                      - medical_and_dental_labs
                      - medical_dental_ophthalmic_and_hospital_equipment_and_supplies
                      - medical_services
                      - membership_organizations
                      - mens_and_boys_clothing_and_accessories_stores
                      - mens_womens_clothing_stores
                      - metal_service_centers
                      - miscellaneous
                      - miscellaneous_apparel_and_accessory_shops
                      - miscellaneous_auto_dealers
                      - miscellaneous_business_services
                      - miscellaneous_food_stores
                      - miscellaneous_general_merchandise
                      - miscellaneous_general_services
                      - miscellaneous_home_furnishing_specialty_stores
                      - miscellaneous_publishing_and_printing
                      - miscellaneous_recreation_services
                      - miscellaneous_repair_shops
                      - miscellaneous_specialty_retail
                      - mobile_home_dealers
                      - motion_picture_theaters
                      - motor_freight_carriers_and_trucking
                      - motor_homes_dealers
                      - motor_vehicle_supplies_and_new_parts
                      - motorcycle_shops_and_dealers
                      - motorcycle_shops_dealers
                      - music_stores_musical_instruments_pianos_and_sheet_music
                      - news_dealers_and_newsstands
                      - non_fi_money_orders
                      - non_fi_stored_value_card_purchase_load
                      - nondurable_goods
                      - nurseries_lawn_and_garden_supply_stores
                      - nursing_personal_care
                      - office_and_commercial_furniture
                      - opticians_eyeglasses
                      - optometrists_ophthalmologist
                      - orthopedic_goods_prosthetic_devices
                      - osteopaths
                      - package_stores_beer_wine_and_liquor
                      - paints_varnishes_and_supplies
                      - parking_lots_garages
                      - passenger_railways
                      - pawn_shops
                      - pet_shops_pet_food_and_supplies
                      - petroleum_and_petroleum_products
                      - photo_developing
                      - photographic_photocopy_microfilm_equipment_and_supplies
                      - photographic_studios
                      - picture_video_production
                      - piece_goods_notions_and_other_dry_goods
                      - plumbing_heating_equipment_and_supplies
                      - political_organizations
                      - postal_services_government_only
                      - precious_stones_and_metals_watches_and_jewelry
                      - professional_services
                      - public_warehousing_and_storage
                      - quick_copy_repro_and_blueprint
                      - railroads
                      - real_estate_agents_and_managers_rentals
                      - record_stores
                      - recreational_vehicle_rentals
                      - religious_goods_stores
                      - religious_organizations
                      - roofing_siding_sheet_metal
                      - secretarial_support_services
                      - security_brokers_dealers
                      - service_stations
                      - sewing_needlework_fabric_and_piece_goods_stores
                      - shoe_repair_hat_cleaning
                      - shoe_stores
                      - small_appliance_repair
                      - snowmobile_dealers
                      - special_trade_services
                      - specialty_cleaning
                      - sporting_goods_stores
                      - sporting_recreation_camps
                      - sports_and_riding_apparel_stores
                      - sports_clubs_fields
                      - stamp_and_coin_stores
                      - stationary_office_supplies_printing_and_writing_paper
                      - stationery_stores_office_and_school_supply_stores
                      - swimming_pools_sales
                      - t_ui_travel_germany
                      - tailors_alterations
                      - tax_payments_government_agencies
                      - tax_preparation_services
                      - taxicabs_limousines
                      - telecommunication_equipment_and_telephone_sales
                      - telecommunication_services
                      - telegraph_services
                      - tent_and_awning_shops
                      - testing_laboratories
                      - theatrical_ticket_agencies
                      - timeshares
                      - tire_retreading_and_repair
                      - tolls_bridge_fees
                      - tourist_attractions_and_exhibits
                      - towing_services
                      - trailer_parks_campgrounds
                      - transportation_services
                      - travel_agencies_tour_operators
                      - truck_stop_iteration
                      - truck_utility_trailer_rentals
                      - typesetting_plate_making_and_related_services
                      - typewriter_stores
                      - u_s_federal_government_agencies_or_departments
                      - uniforms_commercial_clothing
                      - used_merchandise_and_secondhand_stores
                      - utilities
                      - variety_stores
                      - veterinary_services
                      - video_amusement_game_supplies
                      - video_game_arcades
                      - video_tape_rental_stores
                      - vocational_trade_schools
                      - watch_jewelry_repair
                      - welding_repair
                      - wholesale_clubs
                      - wig_and_toupee_stores
                      - wires_money_orders
                      - womens_accessory_and_specialty_shops
                      - womens_ready_to_wear_stores
                      - wrecking_and_salvage_yards
                      maxLength: 5000
                      type: string
                    type: array
                  interval:
                    enum:
                    - all_time
                    - daily
                    - monthly
                    - per_authorization
                    - weekly
                    - yearly
                    type: string
                required:
                - amount
                - interval
                title: spending_limits_param
                type: object
              type: array
          title: authorization_controls_param
          type: object
        status:
          description: Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.
          enum:
          - active
          - inactive
          type: string
        type:
          description: The type of card to issue. Possible values are `physical` or `virtual`.
          enum:
          - physical
          - virtual
          type: string
    payment_intent:
      description: 'A PaymentIntent guides you through the process of collecting a payment from your customer.

        We recommend that you create exactly one PaymentIntent for each order or

        customer session in your system. You can reference the PaymentIntent later to

        see the history of payment attempts for a particular session.


        A PaymentIntent transitions through

        [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)

        throughout its lifetime as it interfaces with Stripe.js to perform

        authentication flows and ultimately creates at most one successful charge.


        Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)'
      properties:
        amount:
          description: Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
          type: integer
        amount_capturable:
          description: Amount that can be captured from this PaymentIntent.
          type: integer
        amount_details:
          $ref: '#/components/schemas/payment_flows_amount_details'
        amount_received:
          description: Amount that this PaymentIntent collects.
          type: integer
        application:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/application'
          description: ID of the Connect application that created the PaymentIntent.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/application'
        application_fee_amount:
          description: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
          nullable: true
          type: integer
        automatic_payment_methods:
          anyOf:
          - $ref: '#/components/schemas/payment_flows_automatic_payment_methods_payment_intent'
          description: Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)
          nullable: true
        canceled_at:
          description: Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
          format: unix-time
          nullable: true
          type: integer
        cancellation_reason:
          description: Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`).
          enum:
          - abandoned
          - automatic
          - duplicate
          - failed_invoice
          - fraudulent
          - requested_by_customer
          - void_invoice
          nullable: true
          type: string
        capture_method:
          description: Controls when the funds will be captured from the customer's account.
          enum:
          - automatic
          - automatic_async
          - manual
          type: string
        client_secret:
          description: "The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \n\nThe client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled."
          maxLength: 5000
          nullable: true
          type: string
        confirmation_method:
          description: Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.
          enum:
          - automatic
          - manual
          type: string
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: 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).
          type: string
        customer:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/customer'
          - $ref: '#/components/schemas/deleted_customer'
          description: 'ID of the Customer this PaymentIntent belongs to, if one exists.


            Payment methods attached to other Customers cannot be used with this PaymentIntent.


            If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent''s payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.'
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/customer'
            - $ref: '#/components/schemas/deleted_customer'
        description:
          description: An arbitrary string attached to the object. Often useful for displaying to users.
          maxLength: 5000
          nullable: true
          type: string
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        invoice:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/invoice'
          description: ID of the invoice that created this PaymentIntent, if it exists.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/invoice'
        last_payment_error:
          anyOf:
          - $ref: '#/components/schemas/api_errors'
          description: The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
          nullable: true
        latest_charge:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/charge'
          description: The latest charge created by this PaymentIntent.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/charge'
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).
          type: object
        next_action:
          anyOf:
          - $ref: '#/components/schemas/payment_intent_next_action'
          description: If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
          nullable: true
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - payment_intent
          type: string
        on_behalf_of:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/account'
          description: The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/account'
        payment_method:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/payment_method'
          description: ID of the payment method used in this PaymentIntent.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/payment_method'
        payment_method_configuration_details:
          anyOf:
          - $ref: '#/components/schemas/payment_method_config_biz_payment_method_configuration_details'
          description: Information about the payment method configuration used for this PaymentIntent.
          nullable: true
        payment_method_options:
          anyOf:
          - $ref: '#/components/schemas/payment_intent_payment_method_options'
          description: Payment-method-specific configuration for this PaymentIntent.
          nullable: true
        payment_method_types:
          description: The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
          items:
            maxLength: 5000
            type: string
          type: array
        processing:
          anyOf:
          - $ref: '#/components/schemas/payment_intent_processing'
          description: If present, this property tells you about the processing state of the payment.
          nullable: true
        receipt_email:
          description: Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
          maxLength: 5000
          nullable: true
          type: string
        review:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/review'
          description: ID of the review associated with this PaymentIntent, if any.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/review'
        setup_future_usage:
          description: 'Indicates that you intend to make future payments with this PaymentIntent''s payment method.


            Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent''s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.


            When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).'
          enum:
          - off_session
          - on_session
          nullable: true
          type: string
        shipping:
          anyOf:
          - $ref: '#/components/schemas/shipping'
          description: Shipping information for this PaymentIntent.
          nullable: true
        statement_descriptor:
          description: For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.
          maxLength: 5000
          nullable: true
          type: string
        statement_descriptor_suffix:
          description: Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
          maxLength: 5000
          nullable: true
          type: string
        status:
          description: Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses).
          enum:
          - canceled
          - processing
          - requires_action
          - requires_capture
          - requires_confirmation
          - requires_payment_method
          - succeeded
          type: string
        transfer_data:
          anyOf:
          - $ref: '#/components/schemas/transfer_data'
          description: The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
          nullable: true
        transfer_group:
          description: A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).
          maxLength: 5000
          nullable: true
          type: string
      required:
      - amount
      - capture_method
      - confirmation_method
      - created
      - currency
      - id
      - livemode
      - object
      - payment_method_types
      - status
      title: PaymentIntent
      type: object
      x-expandableFields:
      - amount_details
      - application
      - automatic_payment_methods
      - customer
      - invoice
      - last_payment_error
      - latest_charge
      - next_action
      - on_behalf_of
      - payment_method
      - payment_method_configuration_details
      - payment_method_options
      - processing
      - review
      - shipping
      - transfer_data
      x-resourceId: payment_intent
    issuing.authorization:
      description: 'When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`

        object is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the

        purchase to be completed successfully.


        Related guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations)'
      properties:
        amount:
          description: The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.
          type: integer
        amount_details:
          anyOf:
          - $ref: '#/components/schemas/issuing_authorization_amount_details'
          description: Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
          nullable: true
        approved:
          description: Whether the authorization has been approved.
          type: boolean
        authorization_method:
          description: How the card details were provided.
          enum:
          - chip
          - contactless
          - keyed_in
          - online
          - swipe
          type: string
        balance_transactions:
          description: List of balance transactions associated with this authorization.
          items:
            $ref: '#/components/schemas/balance_transaction'
          type: array
        card:
          $ref: '#/components/schemas/issuing.card'
        cardholder:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/issuing.cardholder'
          description: The cardholder to whom this authorization belongs.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/issuing.cardholder'
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. 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).
          type: string
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        merchant_amount:
          description: The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different.
          type: integer
        merchant_currency:
          description: The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. 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).
          type: string
        merchant_data:
          $ref: '#/components/schemas/issuing_authorization_merchant_data'
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          type: object
        network_data:
          anyOf:
          - $ref: '#/components/schemas/issuing_authorization_network_data'
          description: Details about the authorization, such as identifiers, set by the card network.
          nullable: true
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - issuing.authorization
          type: string
        pending_request:
          anyOf:
          - $ref: '#/components/schemas/issuing_authorization_pending_request'
          description: The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.
          nullable: true
        request_history:
          description: History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.
          items:
            $ref: '#/components/schemas/issuing_authorization_request'
          type: array
        status:
          description: The current status of the authorization in its lifecycle.
          enum:
          - closed
          - pending
          - reversed
          type: string
        token:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/issuing.token'
          description: '[Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.'
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/issuing.token'
        transactions:
          description: List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.
          items:
            $ref: '#/components/schemas/issuing.transaction'
          type: array
        treasury:
          anyOf:
          - $ref: '#/components/schemas/issuing_authorization_treasury'
          description: '[Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts).'
          nullable: true
        verification_data:
          $ref: '#/components/schemas/issuing_authorization_verification_data'
        wallet:
          description: The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.
          maxLength: 5000
          nullable: true
          type: string
      required:
      - amount
      - approved
      - authorization_method
      - balance_transactions
      - card
      - created
      - currency
      - id
      - livemode
      - merchant_amount
      - merchant_currency
      - merchant_data
      - metadata
      - object
      - request_history
      - status
      - transactions
      - verification_data
      title: IssuingAuthorization
      type: object
      x-expandableFields:
      - amount_details
      - balance_transactions
      - card
      - cardholder
      - merchant_data
      - network_data
      - pending_request
      - request_history
      - token
      - transactions
      - treasury
      - verification_data
      x-resourceId: issuing.authorization
    payment_link:
      description: 'A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.


        When a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.


        Related guide: [Payment Links API](https://stripe.com/docs/payment-links)'
      properties:
        active:
          description: Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.
          type: boolean
        after_completion:
          $ref: '#/components/schemas/payment_links_resource_after_completion'
        allow_promotion_codes:
          description: Whether user redeemable promotion codes are enabled.
          type: boolean
        application:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/application'
          - $ref: '#/components/schemas/deleted_application'
          description: The ID of the Connect application that created the Payment Link.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/application'
            - $ref: '#/components/schemas/deleted_application'
        application_fee_amount:
          description: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.
          nullable: true
          type: integer
        application_fee_percent:
          description: This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
          nullable: true
          type: number
        automatic_tax:
          $ref: '#/components/schemas/payment_links_resource_automatic_tax'
        billing_address_collection:
          description: Configuration for collecting the customer's billing address.
          enum:
          - auto
          - required
          type: string
        consent_collection:
          anyOf:
          - $ref: '#/components/schemas/payment_links_resource_consent_collection'
          description: When set, provides configuration to gather active consent from customers.
          nullable: true
        currency:
          description: 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).
          type: string
        custom_fields:
          description: Collect additional information from your customer using custom fields. Up to 2 fields are supported.
          items:
            $ref: '#/components/schemas/payment_links_resource_custom_fields'
          type: array
        custom_text:
          $ref: '#/components/schemas/payment_links_resource_custom_text'
        customer_creation:
          description: Configuration for Customer creation during checkout.
          enum:
          - always
          - if_required
          type: string
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        inactive_message:
          description: The custom message to be displayed to a customer when a payment link is no longer active.
          maxLength: 5000
          nullable: true
          type: string
        invoice_creation:
          anyOf:
          - $ref: '#/components/schemas/payment_links_resource_invoice_creation'
          description: Configuration for creating invoice for payment mode payment links.
          nullable: true
        line_items:
          description: The line items representing what is being sold.
          properties:
            data:
              description: Details about each object.
              items:
                $ref: '#/components/schemas/item'
              type: array
            has_more:
              description: True if this list has another page of items after this one that can be fetched.
              type: boolean
            object:
              description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
              enum:
              - list
              type: string
            url:
              description: The URL where this list can be accessed.
              maxLength: 5000
              type: string
          required:
          - data
          - has_more
          - object
          - url
          title: PaymentLinksResourceListLineItems
          type: object
          x-expandableFields:
          - data
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          type: object
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - payment_link
          type: string
        on_behalf_of:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/account'
          description: The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/account'
        payment_intent_data:
          anyOf:
          - $ref: '#/components/schemas/payment_links_resource_payment_intent_data'
          description: Indicates the parameters to be passed to PaymentIntent creation during checkout.
          nullable: true
        payment_method_collection:
          description: Configuration for collecting a payment method during checkout.
          enum:
          - always
          - if_required
          type: string
        payment_method_types:
          description: The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
          items:
            enum:
            - affirm
            - afterpay_clearpay
            - alipay
            - au_becs_debit
            - bacs_debit
            - bancontact
            - blik
            - boleto
            - card
            - cashapp
            - eps
            - fpx
            - giropay
            - grabpay
            - ideal
            - klarna
            - konbini
            - link
            - oxxo
            - p24
            - paynow
            - paypal
            - pix
            - promptpay
            - sepa_debit
            - sofort
            - us_bank_account
            - wechat_pay
            type: string
            x-stripeBypassValidation: true
          nullable: true
          type: array
        phone_number_collection:
          $ref: '#/components/schemas/payment_links_resource_phone_number_collection'
        restrictions:
          anyOf:
          - $ref: '#/components/schemas/payment_links_resource_restrictions'
          description: Settings that restrict the usage of a payment link.
          nullable: true
        shipping_address_collection:
          anyOf:
          - $ref: '#/components/schemas/payment_links_resource_shipping_address_collection'
          description: Configuration for collecting the customer's shipping address.
          nullable: true
        shipping_options:
          description: The shipping rate options applied to the session.
          items:
            $ref: '#/components/schemas/payment_links_resource_shipping_option'
          type: array
        submit_type:
          description: Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
          enum:
          - auto
          - book
          - donate
          - pay
          type: string
        subscription_data:
          anyOf:
          - $ref: '#/components/schemas/payment_links_resource_subscription_data'
          description: When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
          nullable: true
        tax_id_collection:
          $ref: '#/components/schemas/payment_links_resource_tax_id_collection'
        transfer_data:
          anyOf:
          - $ref: '#/components/schemas/payment_links_resource_transfer_data'
          description: The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
          nullable: true
        url:
          description: The public URL that can be shared with customers.
          maxLength: 5000
          type: string
      required:
      - active
      - after_completion
      - allow_promotion_codes
      - automatic_tax
      - billing_address_collection
      - currency
      - custom_fields
      - custom_text
      - customer_creation
      - id
      - livemode
      - metadata
      - object
      - payment_method_collection
      - phone_number_collection
      - shipping_options
      - submit_type
      - tax_id_collection
      - url
      title: PaymentLink
      type: object
      x-expandableFields:
      - after_completion
      - application
      - automatic_tax
      - consent_collection
      - custom_fields
      - custom_text
      - invoice_creation
      - line_items
      - on_behalf_of
      - payment_intent_data
      - phone_number_collection
      - restrictions
      - shipping_address_collection
      - shipping_options
      - subscription_data
      - tax_id_collection
      - transfer_data
      x-resourceId: payment_link
    issuing.dispute:
      description: 'As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.


        Related guide: [Issuing disputes](https://stripe.com/docs/issuing/purchases/disputes)'
      properties:
        amount:
          description: Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation).
          type: integer
        balance_transactions:
          description: List of balance transactions associated with the dispute.
          items:
            $ref: '#/components/schemas/balance_transaction'
          nullable: true
          type: array
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: The currency the `transaction` was made in.
          type: string
        evidence:
          $ref: '#/components/schemas/issuing_dispute_evidence'
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          type: object
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - issuing.dispute
          type: string
        status:
          description: Current status of the dispute.
          enum:
          - expired
          - lost
          - submitted
          - unsubmitted
          - won
          type: string
        transaction:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/issuing.transaction'
          description: The transaction being disputed.
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/issuing.transaction'
        treasury:
          anyOf:
          - $ref: '#/components/schemas/issuing_dispute_treasury'
          description: '[Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts'
          nullable: true
      required:
      - amount
      - created
      - currency
      - evidence
      - id
      - livemode
      - metadata
      - object
      - status
      - transaction
      title: IssuingDispute
      type: object
      x-expandableFields:
      - balance_transactions
      - evidence
      - transaction
      - treasury
      x-resourceId: issuing.dispute
    PostPaymentIntentsIntentIncrementAuthorizationRequest:
      type: object
      required:
      - amount
      properties:
        amount:
          description: The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.
          type: integer
        application_fee_amount:
          description: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
          type: integer
        description:
          description: An arbitrary string attached to the object. Often useful for displaying to users.
          maxLength: 1000
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        statement_descriptor:
          description: For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.
          maxLength: 22
          type: string
        transfer_data:
          description: 'The parameters used to automatically create a transfer after the payment is captured.

            Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).'
          properties:
            amount:
              type: integer
          title: transfer_data_update_params
          type: object
    PostCreditNotesIdRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        memo:
          description: Credit note memo.
          maxLength: 5000
          type: string
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
    plan:
      description: 'You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.


        Plans define the base price, currency, and billing cycle for recurring purchases of products.

        [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.


        For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.


        Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview).'
      properties:
        active:
          description: Whether the plan can be used for new purchases.
          type: boolean
        aggregate_usage:
          description: Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.
          enum:
          - last_during_period
          - last_ever
          - max
          - sum
          nullable: true
          type: string
        amount:
          description: The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.
          nullable: true
          type: integer
        amount_decimal:
          description: The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.
          format: decimal
          nullable: true
          type: string
        billing_scheme:
          description: Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
          enum:
          - per_unit
          - tiered
          type: string
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: 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).
          type: string
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        interval:
          description: The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
          enum:
          - day
          - month
          - week
          - year
          type: string
        interval_count:
          description: The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
          type: integer
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          nullable: true
          type: object
        nickname:
          description: A brief description of the plan, hidden from customers.
          maxLength: 5000
          nullable: true
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - plan
          type: string
        product:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/product'
          - $ref: '#/components/schemas/deleted_product'
          description: The product whose pricing this plan determines.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/product'
            - $ref: '#/components/schemas/deleted_product'
        tiers:
          description: Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
          items:
            $ref: '#/components/schemas/plan_tier'
          type: array
        tiers_mode:
          description: Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.
          enum:
          - graduated
          - volume
          nullable: true
          type: string
        transform_usage:
          anyOf:
          - $ref: '#/components/schemas/transform_usage'
          description: Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
          nullable: true
        trial_period_days:
          description: Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
          nullable: true
          type: integer
        usage_type:
          description: Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
          enum:
          - licensed
          - metered
          type: string
      required:
      - active
      - billing_scheme
      - created
      - currency
      - id
      - interval
      - interval_count
      - livemode
      - object
      - usage_type
      title: Plan
      type: object
      x-expandableFields:
      - product
      - tiers
      - transform_usage
      x-resourceId: plan
    PostIssuingDisputesDisputeRequest:
      type: object
      properties:
        amount:
          description: The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
          type: integer
        evidence:
          description: Evidence provided for the dispute.
          properties:
            canceled:
              anyOf:
              - properties:
                  additional_documentation:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  canceled_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                  cancellation_policy_provided:
                    anyOf:
                    - type: boolean
                    - enum:
                      - ''
                      type: string
                  cancellation_reason:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  expected_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                  explanation:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  product_description:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  product_type:
                    enum:
                    - ''
                    - merchandise
                    - service
                    type: string
                  return_status:
                    enum:
                    - ''
                    - merchant_rejected
                    - successful
                    type: string
                  returned_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                title: canceled
                type: object
              - enum:
                - ''
                type: string
            duplicate:
              anyOf:
              - properties:
                  additional_documentation:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  card_statement:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  cash_receipt:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  check_image:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  explanation:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  original_transaction:
                    maxLength: 5000
                    type: string
                title: duplicate
                type: object
              - enum:
                - ''
                type: string
            fraudulent:
              anyOf:
              - properties:
                  additional_documentation:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  explanation:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                title: fraudulent
                type: object
              - enum:
                - ''
                type: string
            merchandise_not_as_described:
              anyOf:
              - properties:
                  additional_documentation:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  explanation:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  received_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                  return_description:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  return_status:
                    enum:
                    - ''
                    - merchant_rejected
                    - successful
                    type: string
                  returned_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                title: merchandise_not_as_described
                type: object
              - enum:
                - ''
                type: string
            not_received:
              anyOf:
              - properties:
                  additional_documentation:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  expected_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                  explanation:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  product_description:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  product_type:
                    enum:
                    - ''
                    - merchandise
                    - service
                    type: string
                title: not_received
                type: object
              - enum:
                - ''
                type: string
            other:
              anyOf:
              - properties:
                  additional_documentation:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  explanation:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  product_description:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  product_type:
                    enum:
                    - ''
                    - merchandise
                    - service
                    type: string
                title: other
                type: object
              - enum:
                - ''
                type: string
            reason:
              enum:
              - canceled
              - duplicate
              - fraudulent
              - merchandise_not_as_described
              - not_received
              - other
              - service_not_as_described
              type: string
              x-stripeBypassValidation: true
            service_not_as_described:
              anyOf:
              - properties:
                  additional_documentation:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  canceled_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                  cancellation_reason:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  explanation:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  received_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                title: service_not_as_described
                type: object
              - enum:
                - ''
                type: string
          title: evidence_param
          type: object
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
    PostPaymentIntentsIntentCancelRequest:
      type: object
      properties:
        cancellation_reason:
          description: 'Reason for canceling this PaymentIntent. Possible values are: `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`'
          enum:
          - abandoned
          - duplicate
          - fraudulent
          - requested_by_customer
          maxLength: 5000
          type: string
          x-stripeBypassValidation: true
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    issuing.settlement:
      description: When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.
      properties:
        bin:
          description: The Bank Identification Number reflecting this settlement record.
          maxLength: 5000
          type: string
        clearing_date:
          description: The date that the transactions are cleared and posted to user's accounts.
          type: integer
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: 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).
          type: string
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        interchange_fees:
          description: The total interchange received as reimbursement for the transactions.
          type: integer
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          type: object
        net_total:
          description: The total net amount required to settle with the network.
          type: integer
        network:
          description: The card network for this settlement report. One of ["visa"]
          enum:
          - visa
          type: string
        network_fees:
          description: The total amount of fees owed to the network.
          type: integer
        network_settlement_identifier:
          description: The Settlement Identification Number assigned by the network.
          maxLength: 5000
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - issuing.settlement
          type: string
        settlement_service:
          description: One of `international` or `uk_national_net`.
          maxLength: 5000
          type: string
        transaction_count:
          description: The total number of transactions reflected in this settlement.
          type: integer
        transaction_volume:
          description: The total transaction amount reflected in this settlement.
          type: integer
      required:
      - bin
      - clearing_date
      - created
      - currency
      - id
      - interchange_fees
      - livemode
      - metadata
      - net_total
      - network
      - network_fees
      - network_settlement_identifier
      - object
      - settlement_service
      - transaction_count
      - transaction_volume
      title: IssuingSettlement
      type: object
      x-expandableFields: []
      x-resourceId: issuing.settlement
    line_item:
      description: ''
      properties:
        amount:
          description: The amount, in cents (or local equivalent).
          type: integer
        amount_excluding_tax:
          description: The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts.
          nullable: true
          type: integer
        currency:
          description: 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).
          type: string
        description:
          description: An arbitrary string attached to the object. Often useful for displaying to users.
          maxLength: 5000
          nullable: true
          type: string
        discount_amounts:
          description: The amount of discount calculated per discount for this line item.
          items:
            $ref: '#/components/schemas/discounts_resource_discount_amount'
          nullable: true
          type: array
        discountable:
          description: If true, discounts will apply to this line item. Always false for prorations.
          type: boolean
        discounts:
          description: The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
          items:
            anyOf:
            - maxLength: 5000
              type: string
            - $ref: '#/components/schemas/discount'
            x-expansionResources:
              oneOf:
              - $ref: '#/components/schemas/discount'
          nullable: true
          type: array
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        invoice_item:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/invoiceitem'
          description: The ID of the [invoice item](https://stripe.com/docs/api/Invoice Items) associated with this line item if any.
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/invoiceitem'
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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. Note that for line items with `type=subscription` this will reflect the metadata of the subscription that caused the line item to be created.
          type: object
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - line_item
          type: string
        period:
          $ref: '#/components/schemas/invoice_line_item_period'
        price:
          anyOf:
          - $ref: '#/components/schemas/price'
          description: The price of the line item.
          nullable: true
        proration:
          description: Whether this is a proration.
          type: boolean
        proration_details:
          anyOf:
          - $ref: '#/components/schemas/invoices_resource_line_items_proration_details'
          description: Additional details for proration line items
          nullable: true
        quantity:
          description: The quantity of the subscription, if the line item is a subscription or a proration.
          nullable: true
          type: integer
        subscription:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/subscription'
          description: The subscription that the invoice item pertains to, if any.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/subscription'
        subscription_item:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/subscription_item'
          description: The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription.
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/subscription_item'
        tax_amounts:
          description: The amount of tax calculated per tax rate for this line item
          items:
            $ref: '#/components/schemas/invoice_tax_amount'
          type: array
        tax_rates:
          description: The tax rates which apply to the line item.
          items:
            $ref: '#/components/schemas/tax_rate'
          type: array
        type:
          description: A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`.
          enum:
          - invoiceitem
          - subscription
          type: string
        unit_amount_excluding_tax:
          description: The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts.
          format: decimal
          nullable: true
          type: string
      required:
      - amount
      - currency
      - discountable
      - id
      - livemode
      - metadata
      - object
      - period
      - proration
      - type
      title: InvoiceLineItem
      type: object
      x-expandableFields:
      - discount_amounts
      - discounts
      - invoice_item
      - period
      - price
      - proration_details
      - subscription
      - subscription_item
      - tax_amounts
      - tax_rates
      x-resourceId: line_item
    PostCustomersRequest:
      type: object
      properties:
        address:
          anyOf:
          - properties:
              city:
                maxLength: 5000
                type: string
              country:
                maxLength: 5000
                type: string
              line1:
                maxLength: 5000
                type: string
              line2:
                maxLength: 5000
                type: string
              postal_code:
                maxLength: 5000
                type: string
              state:
                maxLength: 5000
                type: string
            title: optional_fields_address
            type: object
          - enum:
            - ''
            type: string
          description: The customer's address.
        balance:
          description: An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
          type: integer
        cash_balance:
          description: Balance information and default balance settings for this customer.
          properties:
            settings:
              properties:
                reconciliation_mode:
                  enum:
                  - automatic
                  - manual
                  - merchant_default
                  type: string
              title: balance_settings_param
              type: object
          title: cash_balance_param
          type: object
        coupon:
          maxLength: 5000
          type: string
        description:
          description: An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
          maxLength: 5000
          type: string
        email:
          description: Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.
          maxLength: 512
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        invoice_prefix:
          description: The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
          maxLength: 5000
          type: string
        invoice_settings:
          description: Default invoice settings for this customer.
          properties:
            custom_fields:
              anyOf:
              - items:
                  properties:
                    name:
                      maxLength: 30
                      type: string
                    value:
                      maxLength: 30
                      type: string
                  required:
                  - name
                  - value
                  title: custom_field_params
                  type: object
                type: array
              - enum:
                - ''
                type: string
            default_payment_method:
              maxLength: 5000
              type: string
            footer:
              maxLength: 5000
              type: string
            rendering_options:
              anyOf:
              - properties:
                  amount_tax_display:
                    enum:
                    - ''
                    - exclude_tax
                    - include_inclusive_tax
                    type: string
                title: rendering_options_param
                type: object
              - enum:
                - ''
                type: string
          title: customer_param
          type: object
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        name:
          description: The customer's full name or business name.
          maxLength: 256
          type: string
        next_invoice_sequence:
          description: The sequence to be used on the customer's next invoice. Defaults to 1.
          type: integer
        payment_method:
          maxLength: 5000
          type: string
        phone:
          description: The customer's phone number.
          maxLength: 20
          type: string
        preferred_locales:
          description: Customer's preferred languages, ordered by preference.
          items:
            maxLength: 5000
            type: string
          type: array
        promotion_code:
          description: The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
          maxLength: 5000
          type: string
        shipping:
          anyOf:
          - properties:
              address:
                properties:
                  city:
                    maxLength: 5000
                    type: string
                  country:
                    maxLength: 5000
                    type: string
                  line1:
                    maxLength: 5000
                    type: string
                  line2:
                    maxLength: 5000
                    type: string
                  postal_code:
                    maxLength: 5000
                    type: string
                  state:
                    maxLength: 5000
                    type: string
                title: optional_fields_address
                type: object
              name:
                maxLength: 5000
                type: string
              phone:
                maxLength: 5000
                type: string
            required:
            - address
            - name
            title: customer_shipping
            type: object
          - enum:
            - ''
            type: string
          description: The customer's shipping information. Appears on invoices emailed to this customer.
        source:
          maxLength: 5000
          type: string
          x-stripeBypassValidation: true
        tax:
          description: Tax details about the customer.
          properties:
            ip_address:
              anyOf:
              - type: string
              - enum:
                - ''
                type: string
            validate_location:
              enum:
              - deferred
              - immediately
              type: string
          title: tax_param
          type: object
        tax_exempt:
          description: The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
          enum:
          - ''
          - exempt
          - none
          - reverse
          type: string
        tax_id_data:
          description: The customer's tax IDs.
          items:
            properties:
              type:
                enum:
                - ad_nrt
                - ae_trn
                - ar_cuit
                - au_abn
                - au_arn
                - bg_uic
                - bo_tin
                - br_cnpj
                - br_cpf
                - ca_bn
                - ca_gst_hst
                - ca_pst_bc
                - ca_pst_mb
                - ca_pst_sk
                - ca_qst
                - ch_vat
                - cl_tin
                - cn_tin
                - co_nit
                - cr_tin
                - do_rcn
                - ec_ruc
                - eg_tin
                - es_cif
                - eu_oss_vat
                - eu_vat
                - gb_vat
                - ge_vat
                - hk_br
                - hu_tin
                - id_npwp
                - il_vat
                - in_gst
                - is_vat
                - jp_cn
                - jp_rn
                - jp_trn
                - ke_pin
                - kr_brn
                - li_uid
                - mx_rfc
                - my_frp
                - my_itn
                - my_sst
                - no_vat
                - nz_gst
                - pe_ruc
                - ph_tin
                - ro_tin
                - rs_pib
                - ru_inn
                - ru_kpp
                - sa_vat
                - sg_gst
                - sg_uen
                - si_tin
                - sv_nit
                - th_vat
                - tr_tin
                - tw_vat
                - ua_vat
                - us_ein
                - uy_ruc
                - ve_rif
                - vn_tin
                - za_vat
                maxLength: 5000
                type: string
                x-stripeBypassValidation: true
              value:
                type: string
            required:
            - type
            - value
            title: data_params
            type: object
          type: array
        test_clock:
          description: ID of the test clock to attach to the customer.
          maxLength: 5000
          type: string
    PostPaymentMethodConfigurationsRequest:
      type: object
      properties:
        acss_debit:
          description: Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        affirm:
          description: '[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.'
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        afterpay_clearpay:
          description: Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        alipay:
          description: Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        apple_pay:
          description: Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        apple_pay_later:
          description: Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        au_becs_debit:
          description: Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        bacs_debit:
          description: Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        bancontact:
          description: Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        blik:
          description: BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        boleto:
          description: Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        card:
          description: Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        cartes_bancaires:
          description: Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        cashapp:
          description: Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        eps:
          description: EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        fpx:
          description: Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        giropay:
          description: giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        google_pay:
          description: Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        grabpay:
          description: GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        ideal:
          description: iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        jcb:
          description: JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        klarna:
          description: Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        konbini:
          description: Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        link:
          description: '[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.'
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        name:
          description: Configuration name.
          maxLength: 100
          type: string
        oxxo:
          description: OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        p24:
          description: Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        parent:
          description: Configuration's parent configuration. Specify to create a child configuration.
          maxLength: 100
          type: string
        paynow:
          description: PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        paypal:
          description: PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        promptpay:
          description: PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        revolut_pay:
          description: Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        sepa_debit:
          description: The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        sofort:
          description: Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        us_bank_account:
          description: Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        wechat_pay:
          description: WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
    PostCustomersCustomerBalanceTransactionsRequest:
      type: object
      required:
      - amount
      - currency
      properties:
        amount:
          description: The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance.
          type: integer
        currency:
          description: 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). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value.
          type: string
        description:
          description: An arbitrary string attached to the object. Often useful for displaying to users.
          maxLength: 350
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
    funding_instructions:
      description: 'Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is

        automatically applied to future invoices and payments using the `customer_balance` payment method.

        Customers can fund this balance by initiating a bank transfer to any account in the

        `financial_addresses` field.

        Related guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions)'
      properties:
        bank_transfer:
          $ref: '#/components/schemas/funding_instructions_bank_transfer'
        currency:
          description: 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).
          maxLength: 5000
          type: string
        funding_type:
          description: The `funding_type` of the returned instructions
          enum:
          - bank_transfer
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - funding_instructions
          type: string
      required:
      - bank_transfer
      - currency
      - funding_type
      - livemode
      - object
      title: CustomerBalanceFundingInstructionsCustomerBalanceFundingInstructions
      type: object
      x-expandableFields:
      - bank_transfer
      x-resourceId: funding_instructions
    PostPaymentMethodsRequest:
      type: object
      properties:
        acss_debit:
          description: If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
          properties:
            account_number:
              maxLength: 5000
              type: string
            institution_number:
              maxLength: 5000
              type: string
            transit_number:
              maxLength: 5000
              type: string
          required:
          - account_number
          - institution_number
          - transit_number
          title: payment_method_param
          type: object
        affirm:
          description: If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
          properties: {}
          title: param
          type: object
        afterpay_clearpay:
          description: If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
          properties: {}
          title: param
          type: object
        alipay:
          description: If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
          properties: {}
          title: param
          type: object
        au_becs_debit:
          description: If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
          properties:
            account_number:
              maxLength: 5000
              type: string
            bsb_number:
              maxLength: 5000
              type: string
          required:
          - account_number
          - bsb_number
          title: param
          type: object
        bacs_debit:
          description: If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
          properties:
            account_number:
              maxLength: 5000
              type: string
            sort_code:
              maxLength: 5000
              type: string
          title: param
          type: object
        bancontact:
          description: If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
          properties: {}
          title: param
          type: object
        billing_details:
          description: Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
          properties:
            address:
              anyOf:
              - properties:
                  city:
                    maxLength: 5000
                    type: string
                  country:
                    maxLength: 5000
                    type: string
                  line1:
                    maxLength: 5000
                    type: string
                  line2:
                    maxLength: 5000
                    type: string
                  postal_code:
                    maxLength: 5000
                    type: string
                  state:
                    maxLength: 5000
                    type: string
                title: billing_details_address
                type: object
              - enum:
                - ''
                type: string
            email:
              anyOf:
              - type: string
              - enum:
                - ''
                type: string
            name:
              anyOf:
              - maxLength: 5000
                type: string
              - enum:
                - ''
                type: string
            phone:
              anyOf:
              - maxLength: 5000
                type: string
              - enum:
                - ''
                type: string
          title: billing_details_inner_params
          type: object
        blik:
          description: If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
          properties: {}
          title: param
          type: object
        boleto:
          description: If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
          properties:
            tax_id:
              maxLength: 5000
              type: string
          required:
          - tax_id
          title: param
          type: object
        card:
          anyOf:
          - properties:
              cvc:
                maxLength: 5000
                type: string
              exp_month:
                type: integer
              exp_year:
                type: integer
              number:
                maxLength: 5000
                type: string
            required:
            - exp_month
            - exp_year
            - number
            title: card_details_params
            type: object
          - properties:
              token:
                maxLength: 5000
                type: string
            required:
            - token
            title: token_params
            type: object
          description: 'If this is a `card` PaymentMethod, this hash contains the user''s card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly.'
          x-stripeBypassValidation: true
        cashapp:
          description: If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
          properties: {}
          title: param
          type: object
        customer:
          description: The `Customer` to whom the original PaymentMethod is attached.
          maxLength: 5000
          type: string
        customer_balance:
          description: If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
          properties: {}
          title: param
          type: object
        eps:
          description: If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
          properties:
            bank:
              enum:
              - arzte_und_apotheker_bank
              - austrian_anadi_bank_ag
              - bank_austria
              - bankhaus_carl_spangler
              - bankhaus_schelhammer_und_schattera_ag
              - bawag_psk_ag
              - bks_bank_ag
              - brull_kallmus_bank_ag
              - btv_vier_lander_bank
              - capital_bank_grawe_gruppe_ag
              - deutsche_bank_ag
              - dolomitenbank
              - easybank_ag
              - erste_bank_und_sparkassen
              - hypo_alpeadriabank_international_ag
              - hypo_bank_burgenland_aktiengesellschaft
              - hypo_noe_lb_fur_niederosterreich_u_wien
              - hypo_oberosterreich_salzburg_steiermark
              - hypo_tirol_bank_ag
              - hypo_vorarlberg_bank_ag
              - marchfelder_bank
              - oberbank_ag
              - raiffeisen_bankengruppe_osterreich
              - schoellerbank_ag
              - sparda_bank_wien
              - volksbank_gruppe
              - volkskreditbank_ag
              - vr_bank_braunau
              maxLength: 5000
              type: string
          title: param
          type: object
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        fpx:
          description: If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
          properties:
            bank:
              enum:
              - affin_bank
              - agrobank
              - alliance_bank
              - ambank
              - bank_islam
              - bank_muamalat
              - bank_of_china
              - bank_rakyat
              - bsn
              - cimb
              - deutsche_bank
              - hong_leong_bank
              - hsbc
              - kfh
              - maybank2e
              - maybank2u
              - ocbc
              - pb_enterprise
              - public_bank
              - rhb
              - standard_chartered
              - uob
              maxLength: 5000
              type: string
              x-stripeBypassValidation: true
          required:
          - bank
          title: param
          type: object
        giropay:
          description: If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
          properties: {}
          title: param
          type: object
        grabpay:
          description: If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
          properties: {}
          title: param
          type: object
        ideal:
          description: If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
          properties:
            bank:
              enum:
              - abn_amro
              - asn_bank
              - bunq
              - handelsbanken
              - ing
              - knab
              - moneyou
              - n26
              - rabobank
              - regiobank
              - revolut
              - sns_bank
              - triodos_bank
              - van_lanschot
              - yoursafe
              maxLength: 5000
              type: string
          title: param
          type: object
        interac_present:
          description: If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
          properties: {}
          title: param
          type: object
        klarna:
          description: If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
          properties:
            dob:
              properties:
                day:
                  type: integer
                month:
                  type: integer
                year:
                  type: integer
              required:
              - day
              - month
              - year
              title: date_of_birth
              type: object
          title: param
          type: object
        konbini:
          description: If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
          properties: {}
          title: param
          type: object
        link:
          description: If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
          properties: {}
          title: param
          type: object
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        oxxo:
          description: If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
          properties: {}
          title: param
          type: object
        p24:
          description: If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
          properties:
            bank:
              enum:
              - alior_bank
              - bank_millennium
              - bank_nowy_bfg_sa
              - bank_pekao_sa
              - banki_spbdzielcze
              - blik
              - bnp_paribas
              - boz
              - citi_handlowy
              - credit_agricole
              - envelobank
              - etransfer_pocztowy24
              - getin_bank
              - ideabank
              - ing
              - inteligo
              - mbank_mtransfer
              - nest_przelew
              - noble_pay
              - pbac_z_ipko
              - plus_bank
              - santander_przelew24
              - tmobile_usbugi_bankowe
              - toyota_bank
              - volkswagen_bank
              type: string
              x-stripeBypassValidation: true
          title: param
          type: object
        payment_method:
          description: The PaymentMethod to share.
          maxLength: 5000
          type: string
        paynow:
          description: If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
          properties: {}
          title: param
          type: object
        paypal:
          description: If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
          properties: {}
          title: param
          type: object
        pix:
          description: If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
          properties: {}
          title: param
          type: object
        promptpay:
          description: If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
          properties: {}
          title: param
          type: object
        radar_options:
          description: Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
          properties:
            session:
              maxLength: 5000
              type: string
          title: radar_options
          type: object
        revolut_pay:
          description: If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
          properties: {}
          title: param
          type: object
        sepa_debit:
          description: If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
          properties:
            iban:
              maxLength: 5000
              type: string
          required:
          - iban
          title: param
          type: object
        sofort:
          description: If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
          properties:
            country:
              enum:
              - AT
              - BE
              - DE
              - ES
              - IT
              - NL
              type: string
          required:
          - country
          title: param
          type: object
        type:
          description: The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
          enum:
          - acss_debit
          - affirm
          - afterpay_clearpay
          - alipay
          - au_becs_debit
          - bacs_debit
          - bancontact
          - blik
          - boleto
          - card
          - cashapp
          - customer_balance
          - eps
          - fpx
          - giropay
          - grabpay
          - ideal
          - klarna
          - konbini
          - link
          - oxxo
          - p24
          - paynow
          - paypal
          - pix
          - promptpay
          - revolut_pay
          - sepa_debit
          - sofort
          - us_bank_account
          - wechat_pay
          - zip
          type: string
          x-stripeBypassValidation: true
        us_bank_account:
          description: If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
          properties:
            account_holder_type:
              enum:
              - company
              - individual
              type: string
            account_number:
              maxLength: 5000
              type: string
            account_type:
              enum:
              - checking
              - savings
              type: string
            financial_connections_account:
              maxLength: 5000
              type: string
            routing_number:
              maxLength: 5000
              type: string
          title: payment_method_param
          type: object
        wechat_pay:
          description: If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
          properties: {}
          title: param
          type: object
        zip:
          description: If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
          properties: {}
          title: param
          type: object
    billing_portal.configuration:
      description: A portal configuration describes the functionality and behavior of a portal session.
      properties:
        active:
          description: Whether the configuration is active and can be used to create portal sessions.
          type: boolean
        application:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/application'
          - $ref: '#/components/schemas/deleted_application'
          description: ID of the Connect Application that created the configuration.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/application'
            - $ref: '#/components/schemas/deleted_application'
        business_profile:
          $ref: '#/components/schemas/portal_business_profile'
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        default_return_url:
          description: The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
          maxLength: 5000
          nullable: true
          type: string
        features:
          $ref: '#/components/schemas/portal_features'
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        is_default:
          description: Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
          type: boolean
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        login_page:
          $ref: '#/components/schemas/portal_login_page'
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          nullable: true
          type: object
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - billing_portal.configuration
          type: string
        updated:
          description: Time at which the object was last updated. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
      required:
      - active
      - business_profile
      - created
      - features
      - id
      - is_default
      - livemode
      - login_page
      - object
      - updated
      title: PortalConfiguration
      type: object
      x-expandableFields:
      - application
      - business_profile
      - features
      - login_page
      x-resourceId: billing_portal.configuration
    PostCustomersCustomerCardsRequest:
      type: object
      properties:
        alipay_account:
          description: A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details.
          maxLength: 5000
          type: string
        bank_account:
          anyOf:
          - properties:
              account_holder_name:
                maxLength: 5000
                type: string
              account_holder_type:
                enum:
                - company
                - individual
                maxLength: 5000
                type: string
              account_number:
                maxLength: 5000
                type: string
              country:
                maxLength: 5000
                type: string
              currency:
                type: string
              object:
                enum:
                - bank_account
                maxLength: 5000
                type: string
              routing_number:
                maxLength: 5000
                type: string
            required:
            - account_number
            - country
            title: customer_payment_source_bank_account
            type: object
          - maxLength: 5000
            type: string
          description: Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details.
        card:
          anyOf:
          - properties:
              address_city:
                maxLength: 5000
                type: string
              address_country:
                maxLength: 5000
                type: string
              address_line1:
                maxLength: 5000
                type: string
              address_line2:
                maxLength: 5000
                type: string
              address_state:
                maxLength: 5000
                type: string
              address_zip:
                maxLength: 5000
                type: string
              cvc:
                maxLength: 5000
                type: string
              exp_month:
                type: integer
              exp_year:
                type: integer
              metadata:
                additionalProperties:
                  type: string
                type: object
              name:
                maxLength: 5000
                type: string
              number:
                maxLength: 5000
                type: string
              object:
                enum:
                - card
                maxLength: 5000
                type: string
            required:
            - exp_month
            - exp_year
            - number
            title: customer_payment_source_card
            type: object
          - maxLength: 5000
            type: string
          description: A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).
          x-stripeBypassValidation: true
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        source:
          description: Please refer to full [documentation](https://stripe.com/docs/api) instead.
          maxLength: 5000
          type: string
          x-stripeBypassValidation: true
    payout:
      description: 'A `Payout` object is created when you receive funds from Stripe, or when you

        initiate a payout to either a bank account or debit card of a [connected

        Stripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,

        and list all payouts. Payouts are made on [varying

        schedules](/docs/connect/manage-payout-schedule), depending on your country and

        industry.


        Related guide: [Receiving payouts](https://stripe.com/docs/payouts)'
      properties:
        amount:
          description: The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.
          type: integer
        arrival_date:
          description: Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.
          format: unix-time
          type: integer
        automatic:
          description: Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts).
          type: boolean
        balance_transaction:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/balance_transaction'
          description: ID of the balance transaction that describes the impact of this payout on your account balance.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/balance_transaction'
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: 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).
          type: string
        description:
          description: An arbitrary string attached to the object. Often useful for displaying to users.
          maxLength: 5000
          nullable: true
          type: string
        destination:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/bank_account'
          - $ref: '#/components/schemas/card'
          - $ref: '#/components/schemas/deleted_bank_account'
          - $ref: '#/components/schemas/deleted_card'
          description: ID of the bank account or card the payout is sent to.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/bank_account'
            - $ref: '#/components/schemas/card'
            - $ref: '#/components/schemas/deleted_bank_account'
            - $ref: '#/components/schemas/deleted_card'
          x-stripeBypassValidation: true
        failure_balance_transaction:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/balance_transaction'
          description: If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/balance_transaction'
        failure_code:
          description: Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures).
          maxLength: 5000
          nullable: true
          type: string
        failure_message:
          description: Message that provides the reason for a payout failure, if available.
          maxLength: 5000
          nullable: true
          type: string
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          nullable: true
          type: object
        method:
          description: The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).
          maxLength: 5000
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - payout
          type: string
        original_payout:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/payout'
          description: If the payout reverses another, this is the ID of the original payout.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/payout'
        reconciliation_status:
          description: If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.
          enum:
          - completed
          - in_progress
          - not_applicable
          type: string
        reversed_by:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/payout'
          description: If the payout reverses, this is the ID of the payout that reverses this payout.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/payout'
        source_type:
          description: 'The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`.'
          maxLength: 5000
          type: string
        statement_descriptor:
          description: Extra information about a payout that displays on the user's bank statement.
          maxLength: 5000
          nullable: true
          type: string
        status:
          description: 'Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it''s submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`.'
          maxLength: 5000
          type: string
        type:
          description: Can be `bank_account` or `card`.
          enum:
          - bank_account
          - card
          type: string
          x-stripeBypassValidation: true
      required:
      - amount
      - arrival_date
      - automatic
      - created
      - currency
      - id
      - livemode
      - method
      - object
      - reconciliation_status
      - source_type
      - status
      - type
      title: Payout
      type: object
      x-expandableFields:
      - balance_transaction
      - destination
      - failure_balance_transaction
      - original_payout
      - reversed_by
      x-resourceId: payout
    deleted_customer:
      description: ''
      properties:
        deleted:
          description: Always true for a deleted object
          enum:
          - true
          type: boolean
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - customer
          type: string
      required:
      - deleted
      - id
      - object
      title: DeletedCustomer
      type: object
      x-expandableFields: []
      x-resourceId: deleted_customer
    PostPayoutsRequest:
      type: object
      required:
      - amount
      - currency
      properties:
        amount:
          description: A positive integer in cents representing how much to payout.
          type: integer
        currency:
          description: 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).
          type: string
        description:
          description: An arbitrary string attached to the object. Often useful for displaying to users.
          maxLength: 5000
          type: string
        destination:
          description: The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency.
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        method:
          description: The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).
          enum:
          - instant
          - standard
          maxLength: 5000
          type: string
          x-stripeBypassValidation: true
        source_type:
          description: The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`.
          enum:
          - bank_account
          - card
          - fpx
          maxLength: 5000
          type: string
          x-stripeBypassValidation: true
        statement_descriptor:
          description: A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.
          maxLength: 22
          type: string
          x-stripeBypassValidation: true
    PostPaymentIntentsRequest:
      type: object
      required:
      - amount
      - currency
      properties:
        amount:
          description: Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
          type: integer
        application_fee_amount:
          description: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
          type: integer
        automatic_payment_methods:
          description: When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.
          properties:
            allow_redirects:
              enum:
              - always
              - never
              type: string
            enabled:
              type: boolean
          required:
          - enabled
          title: automatic_payment_methods_param
          type: object
        capture_method:
          description: Controls when the funds will be captured from the customer's account.
          enum:
          - automatic
          - automatic_async
          - manual
          type: string
        confirm:
          description: Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm).
          type: boolean
        confirmation_method:
          description: Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.
          enum:
          - automatic
          - manual
          type: string
        currency:
          description: 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).
          type: string
        customer:
          description: 'ID of the Customer this PaymentIntent belongs to, if one exists.


            Payment methods attached to other Customers cannot be used with this PaymentIntent.


            If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent''s payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.'
          maxLength: 5000
          type: string
        description:
          description: An arbitrary string attached to the object. Often useful for displaying to users.
          maxLength: 1000
          type: string
        error_on_requires_action:
          description: Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
          type: boolean
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        mandate:
          description: ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
          maxLength: 5000
          type: string
        mandate_data:
          anyOf:
          - properties:
              customer_acceptance:
                properties:
                  accepted_at:
                    format: unix-time
                    type: integer
                  offline:
                    properties: {}
                    title: offline_param
                    type: object
                  online:
                    properties:
                      ip_address:
                        type: string
                      user_agent:
                        maxLength: 5000
                        type: string
                    required:
                    - ip_address
                    - user_agent
                    title: online_param
                    type: object
                  type:
                    enum:
                    - offline
                    - online
                    maxLength: 5000
                    type: string
                required:
                - type
                title: customer_acceptance_param
                type: object
            required:
            - customer_acceptance
            title: secret_key_param
            type: object
          - enum:
            - ''
            type: string
          description: This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        off_session:
          anyOf:
          - type: boolean
          - enum:
            - one_off
            - recurring
            maxLength: 5000
            type: string
          description: Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
        on_behalf_of:
          description: The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
          type: string
        payment_method:
          description: 'ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent.


            If you omit this parameter with `confirm=true`, `customer.default_source` attaches as this PaymentIntent''s payment instrument to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward.'
          maxLength: 5000
          type: string
        payment_method_configuration:
          description: The ID of the payment method configuration to use with this PaymentIntent.
          maxLength: 100
          type: string
        payment_method_data:
          description: 'If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear

            in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)

            property on the PaymentIntent.'
          properties:
            acss_debit:
              properties:
                account_number:
                  maxLength: 5000
                  type: string
                institution_number:
                  maxLength: 5000
                  type: string
                transit_number:
                  maxLength: 5000
                  type: string
              required:
              - account_number
              - institution_number
              - transit_number
              title: payment_method_param
              type: object
            affirm:
              properties: {}
              title: param
              type: object
            afterpay_clearpay:
              properties: {}
              title: param
              type: object
            alipay:
              properties: {}
              title: param
              type: object
            au_becs_debit:
              properties:
                account_number:
                  maxLength: 5000
                  type: string
                bsb_number:
                  maxLength: 5000
                  type: string
              required:
              - account_number
              - bsb_number
              title: param
              type: object
            bacs_debit:
              properties:
                account_number:
                  maxLength: 5000
                  type: string
                sort_code:
                  maxLength: 5000
                  type: string
              title: param
              type: object
            bancontact:
              properties: {}
              title: param
              type: object
            billing_details:
              properties:
                address:
                  anyOf:
                  - properties:
                      city:
                        maxLength: 5000
                        type: string
                      country:
                        maxLength: 5000
                        type: string
                      line1:
                        maxLength: 5000
                        type: string
                      line2:
                        maxLength: 5000
                        type: string
                      postal_code:
                        maxLength: 5000
                        type: string
                      state:
                        maxLength: 5000
                        type: string
                    title: billing_details_address
                    type: object
                  - enum:
                    - ''
                    type: string
                email:
                  anyOf:
                  - type: string
                  - enum:
                    - ''
                    type: string
                name:
                  anyOf:
                  - maxLength: 5000
                    type: string
                  - enum:
                    - ''
                    type: string
                phone:
                  anyOf:
                  - maxLength: 5000
                    type: string
                  - enum:
                    - ''
                    type: string
              title: billing_details_inner_params
              type: object
            blik:
              properties: {}
              title: param
              type: object
            boleto:
              properties:
                tax_id:
                  maxLength: 5000
                  type: string
              required:
              - tax_id
              title: param
              type: object
            cashapp:
              properties: {}
              title: param
              type: object
            customer_balance:
              properties: {}
              title: param
              type: object
            eps:
              properties:
                bank:
                  enum:
                  - arzte_und_apotheker_bank
                  - austrian_anadi_bank_ag
                  - bank_austria
                  - bankhaus_carl_spangler
                  - bankhaus_schelhammer_und_schattera_ag
                  - bawag_psk_ag
                  - bks_bank_ag
                  - brull_kallmus_bank_ag
                  - btv_vier_lander_bank
                  - capital_bank_grawe_gruppe_ag
                  - deutsche_bank_ag
                  - dolomitenbank
                  - easybank_ag
                  - erste_bank_und_sparkassen
                  - hypo_alpeadriabank_international_ag
                  - hypo_bank_burgenland_aktiengesellschaft
                  - hypo_noe_lb_fur_niederosterreich_u_wien
                  - hypo_oberosterreich_salzburg_steiermark
                  - hypo_tirol_bank_ag
                  - hypo_vorarlberg_bank_ag
                  - marchfelder_bank
                  - oberbank_ag
                  - raiffeisen_bankengruppe_osterreich
                  - schoellerbank_ag
                  - sparda_bank_wien
                  - volksbank_gruppe
                  - volkskreditbank_ag
                  - vr_bank_braunau
                  maxLength: 5000
                  type: string
              title: param
              type: object
            fpx:
              properties:
                bank:
                  enum:
                  - affin_bank
                  - agrobank
                  - alliance_bank
                  - ambank
                  - bank_islam
                  - bank_muamalat
                  - bank_of_china
                  - bank_rakyat
                  - bsn
                  - cimb
                  - deutsche_bank
                  - hong_leong_bank
                  - hsbc
                  - kfh
                  - maybank2e
                  - maybank2u
                  - ocbc
                  - pb_enterprise
                  - public_bank
                  - rhb
                  - standard_chartered
                  - uob
                  maxLength: 5000
                  type: string
                  x-stripeBypassValidation: true
              required:
              - bank
              title: param
              type: object
            giropay:
              properties: {}
              title: param
              type: object
            grabpay:
              properties: {}
              title: param
              type: object
            ideal:
              properties:
                bank:
                  enum:
                  - abn_amro
                  - asn_bank
                  - bunq
                  - handelsbanken
                  - ing
                  - knab
                  - moneyou
                  - n26
                  - rabobank
                  - regiobank
                  - revolut
                  - sns_bank
                  - triodos_bank
                  - van_lanschot
                  - yoursafe
                  maxLength: 5000
                  type: string
              title: param
              type: object
            interac_present:
              properties: {}
              title: param
              type: object
            klarna:
              properties:
                dob:
                  properties:
                    day:
                      type: integer
                    month:
                      type: integer
                    year:
                      type: integer
                  required:
                  - day
                  - month
                  - year
                  title: date_of_birth
                  type: object
              title: param
              type: object
            konbini:
              properties: {}
              title: param
              type: object
            link:
              properties: {}
              title: param
              type: object
            metadata:
              additionalProperties:
                type: string
              type: object
            oxxo:
              properties: {}
              title: param
              type: object
            p24:
              properties:
                bank:
                  enum:
                  - alior_bank
                  - bank_millennium
                  - bank_nowy_bfg_sa
                  - bank_pekao_sa
                  - banki_spbdzielcze
                  - blik
                  - bnp_paribas
                  - boz
                  - citi_handlowy
                  - credit_agricole
                  - envelobank
                  - etransfer_pocztowy24
                  - getin_bank
                  - ideabank
                  - ing
                  - inteligo
                  - mbank_mtransfer
                  - nest_przelew
                  - noble_pay
                  - pbac_z_ipko
                  - plus_bank
                  - santander_przelew24
                  - tmobile_usbugi_bankowe
                  - toyota_bank
                  - volkswagen_bank
                  type: string
                  x-stripeBypassValidation: true
              title: param
              type: object
            paynow:
              properties: {}
              title: param
              type: object
            paypal:
              properties: {}
              title: param
              type: object
            pix:
              properties: {}
              title: param
              type: object
            promptpay:
              properties: {}
              title: param
              type: object
            radar_options:
              properties:
                session:
                  maxLength: 5000
                  type: string
              title: radar_options
              type: object
            revolut_pay:
              properties: {}
              title: param
              type: object
            sepa_debit:
              properties:
                iban:
                  maxLength: 5000
                  type: string
              required:
              - iban
              title: param
              type: object
            sofort:
              properties:
                country:
                  enum:
                  - AT
                  - BE
                  - DE
                  - ES
                  - IT
                  - NL
                  type: string
              required:
              - country
              title: param
              type: object
            type:
              enum:
              - acss_debit
              - affirm
              - afterpay_clearpay
              - alipay
              - au_becs_debit
              - bacs_debit
              - bancontact
              - blik
              - boleto
              - cashapp
              - customer_balance
              - eps
              - fpx
              - giropay
              - grabpay
              - ideal
              - klarna
              - konbini
              - link
              - oxxo
              - p24
              - paynow
              - paypal
              - pix
              - promptpay
              - revolut_pay
              - sepa_debit
              - sofort
              - us_bank_account
              - wechat_pay
              - zip
              type: string
              x-stripeBypassValidation: true
            us_bank_account:
              properties:
                account_holder_type:
                  enum:
                  - company
                  - individual
                  type: string
                account_number:
                  maxLength: 5000
                  type: string
                account_type:
                  enum:
                  - checking
                  - savings
                  type: string
                financial_connections_account:
                  maxLength: 5000
                  type: string
                routing_number:
                  maxLength: 5000
                  type: string
              title: payment_method_param
              type: object
            wechat_pay:
              properties: {}
              title: param
              type: object
            zip:
              properties: {}
              title: param
              type: object
          required:
          - type
          title: payment_method_data_params
          type: object
        payment_method_options:
          description: Payment method-specific configuration for this PaymentIntent.
          properties:
            acss_debit:
              anyOf:
              - properties:
                  mandate_options:
                    properties:
                      custom_mandate_url:
                        anyOf:
                        - type: string
                        - enum:
                          - ''
                          type: string
                      interval_description:
                        maxLength: 500
                        type: string
                      payment_schedule:
                        enum:
                        - combined
                        - interval
                        - sporadic
                        type: string
                      transaction_type:
                        enum:
                        - business
                        - personal
                        type: string
                    title: payment_intent_payment_method_options_mandate_options_param
                    type: object
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                  verification_method:
                    enum:
                    - automatic
                    - instant
                    - microdeposits
                    type: string
                    x-stripeBypassValidation: true
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            affirm:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  preferred_locale:
                    maxLength: 30
                    type: string
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            afterpay_clearpay:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  reference:
                    maxLength: 128
                    type: string
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                    x-stripeBypassValidation: true
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            alipay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            au_becs_debit:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            bacs_debit:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            bancontact:
              anyOf:
              - properties:
                  preferred_language:
                    enum:
                    - de
                    - en
                    - fr
                    - nl
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            blik:
              anyOf:
              - properties:
                  code:
                    maxLength: 5000
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            boleto:
              anyOf:
              - properties:
                  expires_after_days:
                    type: integer
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            card:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  cvc_token:
                    maxLength: 5000
                    type: string
                  installments:
                    properties:
                      enabled:
                        type: boolean
                      plan:
                        anyOf:
                        - properties:
                            count:
                              type: integer
                            interval:
                              enum:
                              - month
                              type: string
                            type:
                              enum:
                              - fixed_count
                              type: string
                          required:
                          - count
                          - interval
                          - type
                          title: installment_plan
                          type: object
                        - enum:
                          - ''
                          type: string
                    title: installments_param
                    type: object
                  mandate_options:
                    properties:
                      amount:
                        type: integer
                      amount_type:
                        enum:
                        - fixed
                        - maximum
                        type: string
                      description:
                        maxLength: 200
                        type: string
                      end_date:
                        format: unix-time
                        type: integer
                      interval:
                        enum:
                        - day
                        - month
                        - sporadic
                        - week
                        - year
                        type: string
                      interval_count:
                        type: integer
                      reference:
                        maxLength: 80
                        type: string
                      start_date:
                        format: unix-time
                        type: integer
                      supported_types:
                        items:
                          enum:
                          - india
                          type: string
                        type: array
                    required:
                    - amount
                    - amount_type
                    - interval
                    - reference
                    - start_date
                    title: mandate_options_param
                    type: object
                  network:
                    enum:
                    - amex
                    - cartes_bancaires
                    - diners
                    - discover
                    - eftpos_au
                    - interac
                    - jcb
                    - mastercard
                    - unionpay
                    - unknown
                    - visa
                    maxLength: 5000
                    type: string
                    x-stripeBypassValidation: true
                  request_extended_authorization:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_incremental_authorization:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_multicapture:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_overcapture:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_three_d_secure:
                    enum:
                    - any
                    - automatic
                    - challenge
                    type: string
                    x-stripeBypassValidation: true
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                  statement_descriptor_suffix_kana:
                    anyOf:
                    - maxLength: 22
                      type: string
                    - enum:
                      - ''
                      type: string
                  statement_descriptor_suffix_kanji:
                    anyOf:
                    - maxLength: 17
                      type: string
                    - enum:
                      - ''
                      type: string
                  three_d_secure:
                    properties:
                      ares_trans_status:
                        enum:
                        - A
                        - C
                        - I
                        - N
                        - R
                        - U
                        - Y
                        type: string
                      cryptogram:
                        maxLength: 5000
                        type: string
                      electronic_commerce_indicator:
                        enum:
                        - '01'
                        - '02'
                        - '05'
                        - '06'
                        - '07'
                        type: string
                        x-stripeBypassValidation: true
                      exemption_indicator:
                        enum:
                        - low_risk
                        - none
                        type: string
                      network_options:
                        properties:
                          cartes_bancaires:
                            properties:
                              cb_avalgo:
                                enum:
                                - '0'
                                - '1'
                                - '2'
                                - '3'
                                - '4'
                                - A
                                type: string
                              cb_exemption:
                                maxLength: 4
                                type: string
                              cb_score:
                                type: integer
                            required:
                            - cb_avalgo
                            title: cartes_bancaires_network_options_param
                            type: object
                        title: network_options_param
                        type: object
                      requestor_challenge_indicator:
                        maxLength: 2
                        type: string
                      transaction_id:
                        maxLength: 5000
                        type: string
                      version:
                        enum:
                        - 1.0.2
                        - 2.1.0
                        - 2.2.0
                        type: string
                        x-stripeBypassValidation: true
                    required:
                    - cryptogram
                    - transaction_id
                    - version
                    title: payment_method_options_param
                    type: object
                title: payment_intent_param
                type: object
              - enum:
                - ''
                type: string
            card_present:
              anyOf:
              - properties:
                  request_extended_authorization:
                    type: boolean
                  request_incremental_authorization_support:
                    type: boolean
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            cashapp:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            customer_balance:
              anyOf:
              - properties:
                  bank_transfer:
                    properties:
                      eu_bank_transfer:
                        properties:
                          country:
                            maxLength: 5000
                            type: string
                        required:
                        - country
                        title: eu_bank_transfer_params
                        type: object
                      requested_address_types:
                        items:
                          enum:
                          - aba
                          - iban
                          - sepa
                          - sort_code
                          - spei
                          - swift
                          - zengin
                          type: string
                          x-stripeBypassValidation: true
                        type: array
                      type:
                        enum:
                        - eu_bank_transfer
                        - gb_bank_transfer
                        - jp_bank_transfer
                        - mx_bank_transfer
                        - us_bank_transfer
                        type: string
                        x-stripeBypassValidation: true
                    required:
                    - type
                    title: bank_transfer_param
                    type: object
                  funding_type:
                    enum:
                    - bank_transfer
                    type: string
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            eps:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            fpx:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            giropay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            grabpay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            ideal:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            interac_present:
              anyOf:
              - properties: {}
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            klarna:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  preferred_locale:
                    enum:
                    - cs-CZ
                    - da-DK
                    - de-AT
                    - de-CH
                    - de-DE
                    - el-GR
                    - en-AT
                    - en-AU
                    - en-BE
                    - en-CA
                    - en-CH
                    - en-CZ
                    - en-DE
                    - en-DK
                    - en-ES
                    - en-FI
                    - en-FR
                    - en-GB
                    - en-GR
                    - en-IE
                    - en-IT
                    - en-NL
                    - en-NO
                    - en-NZ
                    - en-PL
                    - en-PT
                    - en-SE
                    - en-US
                    - es-ES
                    - es-US
                    - fi-FI
                    - fr-BE
                    - fr-CA
                    - fr-CH
                    - fr-FR
                    - it-CH
                    - it-IT
                    - nb-NO
                    - nl-BE
                    - nl-NL
                    - pl-PL
                    - pt-PT
                    - sv-FI
                    - sv-SE
                    type: string
                    x-stripeBypassValidation: true
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                    x-stripeBypassValidation: true
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            konbini:
              anyOf:
              - properties:
                  confirmation_number:
                    anyOf:
                    - maxLength: 11
                      type: string
                    - enum:
                      - ''
                      type: string
                  expires_after_days:
                    anyOf:
                    - type: integer
                    - enum:
                      - ''
                      type: string
                  expires_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                  product_description:
                    anyOf:
                    - maxLength: 22
                      type: string
                    - enum:
                      - ''
                      type: string
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            link:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            oxxo:
              anyOf:
              - properties:
                  expires_after_days:
                    type: integer
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            p24:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                  tos_shown_and_accepted:
                    type: boolean
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            paynow:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            paypal:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  preferred_locale:
                    enum:
                    - 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
                    type: string
                    x-stripeBypassValidation: true
                  reference:
                    maxLength: 127
                    type: string
                  risk_correlation_id:
                    maxLength: 32
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            pix:
              anyOf:
              - properties:
                  expires_after_seconds:
                    type: integer
                  expires_at:
                    format: unix-time
                    type: integer
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            promptpay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            revolut_pay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            sepa_debit:
              anyOf:
              - properties:
                  mandate_options:
                    properties: {}
                    title: payment_method_options_mandate_options_param
                    type: object
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            sofort:
              anyOf:
              - properties:
                  preferred_language:
                    enum:
                    - ''
                    - de
                    - en
                    - es
                    - fr
                    - it
                    - nl
                    - pl
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            us_bank_account:
              anyOf:
              - properties:
                  financial_connections:
                    properties:
                      permissions:
                        items:
                          enum:
                          - balances
                          - ownership
                          - payment_method
                          - transactions
                          maxLength: 5000
                          type: string
                          x-stripeBypassValidation: true
                        type: array
                      prefetch:
                        items:
                          enum:
                          - balances
                          - transactions
                          type: string
                          x-stripeBypassValidation: true
                        type: array
                      return_url:
                        maxLength: 5000
                        type: string
                    title: linked_account_options_param
                    type: object
                  mandate_options:
                    properties:
                      collection_method:
                        enum:
                        - ''
                        - paper
                        type: string
                        x-stripeBypassValidation: true
                    title: mandate_options_param
                    type: object
                  networks:
                    properties:
                      requested:
                        items:
                          enum:
                          - ach
                          - us_domestic_wire
                          type: string
                        type: array
                    title: networks_options_param
                    type: object
                  preferred_settlement_speed:
                    enum:
                    - ''
                    - fastest
                    - standard
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                  verification_method:
                    enum:
                    - automatic
                    - instant
                    - microdeposits
                    type: string
                    x-stripeBypassValidation: true
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            wechat_pay:
              anyOf:
              - properties:
                  app_id:
                    maxLength: 5000
                    type: string
                  client:
                    enum:
                    - android
                    - ios
                    - web
                    type: string
                    x-stripeBypassValidation: true
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                required:
                - client
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            zip:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
          title: payment_method_options_param
          type: object
        payment_method_types:
          description: The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, it defaults to ["card"]. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
          items:
            maxLength: 5000
            type: string
          type: array
        radar_options:
          description: Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).
          properties:
            session:
              maxLength: 5000
              type: string
          title: radar_options_with_hidden_options
          type: object
        receipt_email:
          description: Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails).
          type: string
        return_url:
          description: The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
          type: string
        setup_future_usage:
          description: 'Indicates that you intend to make future payments with this PaymentIntent''s payment method.


            Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent''s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.


            When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).'
          enum:
          - off_session
          - on_session
          type: string
        shipping:
          description: Shipping information for this PaymentIntent.
          properties:
            address:
              properties:
                city:
                  maxLength: 5000
                  type: string
                country:
                  maxLength: 5000
                  type: string
                line1:
                  maxLength: 5000
                  type: string
                line2:
                  maxLength: 5000
                  type: string
                postal_code:
                  maxLength: 5000
                  type: string
                state:
                  maxLength: 5000
                  type: string
              title: optional_fields_address
              type: object
            carrier:
              maxLength: 5000
              type: string
            name:
              maxLength: 5000
              type: string
            phone:
              maxLength: 5000
              type: string
            tracking_number:
              maxLength: 5000
              type: string
          required:
          - address
          - name
          title: optional_fields_shipping
          type: object
        statement_descriptor:
          description: For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.
          maxLength: 22
          type: string
        statement_descriptor_suffix:
          description: Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. The concatenated descriptor must contain 1-22 characters.
          maxLength: 22
          type: string
        transfer_data:
          description: 'The parameters that you can use to automatically create a Transfer.

            Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).'
          properties:
            amount:
              type: integer
            destination:
              type: string
          required:
          - destination
          title: transfer_data_creation_params
          type: object
        transfer_group:
          description: A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).
          type: string
        use_stripe_sdk:
          description: Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
          type: boolean
    PostFinancialConnectionsAccountsAccountUnsubscribeRequest:
      type: object
      required:
      - features
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        features:
          description: The list of account features from which you would like to unsubscribe.
          items:
            enum:
            - transactions
            type: string
            x-stripeBypassValidation: true
          type: array
    apps.secret:
      description: 'Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.


        The primary resource in Secret Store is a `secret`. Other apps can''t view secrets created by an app. Additionally, secrets are scoped to provide further permission control.


        All Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don''t change per-user, like a third-party API key.


        A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.


        Related guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects)'
      properties:
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        deleted:
          description: If true, indicates that this secret has been deleted
          type: boolean
        expires_at:
          description: The Unix timestamp for the expiry time of the secret, after which the secret deletes.
          format: unix-time
          nullable: true
          type: integer
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        name:
          description: A name for the secret that's unique within the scope.
          maxLength: 5000
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - apps.secret
          type: string
        payload:
          description: The plaintext secret value to be stored.
          maxLength: 5000
          nullable: true
          type: string
        scope:
          $ref: '#/components/schemas/secret_service_resource_scope'
      required:
      - created
      - id
      - livemode
      - name
      - object
      - scope
      title: SecretServiceResourceSecret
      type: object
      x-expandableFields:
      - scope
      x-resourceId: apps.secret
    card:
      description: 'You can store multiple cards on a customer in order to charge the customer

        later. You can also store multiple debit cards on a recipient in order to

        transfer to those cards later.


        Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)'
      properties:
        account:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/account'
          description: The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/account'
        address_city:
          description: City/District/Suburb/Town/Village.
          maxLength: 5000
          nullable: true
          type: string
        address_country:
          description: Billing address country, if provided when creating card.
          maxLength: 5000
          nullable: true
          type: string
        address_line1:
          description: Address line 1 (Street address/PO Box/Company name).
          maxLength: 5000
          nullable: true
          type: string
        address_line1_check:
          description: 'If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.'
          maxLength: 5000
          nullable: true
          type: string
        address_line2:
          description: Address line 2 (Apartment/Suite/Unit/Building).
          maxLength: 5000
          nullable: true
          type: string
        address_state:
          description: State/County/Province/Region.
          maxLength: 5000
          nullable: true
          type: string
        address_zip:
          description: ZIP or postal code.
          maxLength: 5000
          nullable: true
          type: string
        address_zip_check:
          description: 'If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.'
          maxLength: 5000
          nullable: true
          type: string
        available_payout_methods:
          description: A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.
          items:
            enum:
            - instant
            - standard
            type: string
          nullable: true
          type: array
        brand:
          description: Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
          maxLength: 5000
          type: string
        country:
          description: Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
          maxLength: 5000
          nullable: true
          type: string
        currency:
          description: Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.
          nullable: true
          type: string
        customer:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/customer'
          - $ref: '#/components/schemas/deleted_customer'
          description: The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/customer'
            - $ref: '#/components/schemas/deleted_customer'
        cvc_check:
          description: 'If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn''t been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).'
          maxLength: 5000
          nullable: true
          type: string
        default_for_currency:
          description: Whether this card is the default external account for its currency.
          nullable: true
          type: boolean
        dynamic_last4:
          description: (For tokenized numbers only.) The last four digits of the device account number.
          maxLength: 5000
          nullable: true
          type: string
        exp_month:
          description: Two-digit number representing the card's expiration month.
          type: integer
        exp_year:
          description: Four-digit number representing the card's expiration year.
          type: integer
        fingerprint:
          description: 'Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.


            *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same cardone for India and one for the rest of the world.*'
          maxLength: 5000
          nullable: true
          type: string
        funding:
          description: Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
          maxLength: 5000
          type: string
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        last4:
          description: The last four digits of the card.
          maxLength: 5000
          type: string
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          nullable: true
          type: object
        name:
          description: Cardholder name.
          maxLength: 5000
          nullable: true
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - card
          type: string
        status:
          description: For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.
          maxLength: 5000
          nullable: true
          type: string
        tokenization_method:
          description: If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.
          maxLength: 5000
          nullable: true
          type: string
      required:
      - brand
      - exp_month
      - exp_year
      - funding
      - id
      - last4
      - object
      title: Card
      type: object
      x-expandableFields:
      - account
      - customer
      x-resourceId: card
    PostLinkedAccountsAccountRefreshRequest:
      type: object
      required:
      - features
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        features:
          description: The list of account features that you would like to refresh.
          items:
            enum:
            - balance
            - ownership
            - transactions
            type: string
            x-stripeBypassValidation: true
          type: array
    PostPaymentMethodDomainsRequest:
      type: object
      required:
      - domain_name
      properties:
        domain_name:
          description: The domain name that this payment method domain object represents.
          maxLength: 5000
          type: string
        enabled:
          description: Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.
          type: boolean
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostPaymentIntentsIntentVerifyMicrodepositsRequest:
      type: object
      properties:
        amounts:
          description: Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.
          items:
            type: integer
          type: array
        client_secret:
          description: The client secret of the PaymentIntent.
          maxLength: 5000
          type: string
        descriptor_code:
          description: A six-character code starting with SM present in the microdeposit sent to the bank account.
          maxLength: 5000
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostCustomersCustomerSubscriptionsRequest:
      type: object
      properties:
        add_invoice_items:
          description: A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
          items:
            properties:
              price:
                maxLength: 5000
                type: string
              price_data:
                properties:
                  currency:
                    type: string
                  product:
                    maxLength: 5000
                    type: string
                  tax_behavior:
                    enum:
                    - exclusive
                    - inclusive
                    - unspecified
                    type: string
                  unit_amount:
                    type: integer
                  unit_amount_decimal:
                    format: decimal
                    type: string
                required:
                - currency
                - product
                title: one_time_price_data_with_negative_amounts
                type: object
              quantity:
                type: integer
              tax_rates:
                anyOf:
                - items:
                    maxLength: 5000
                    type: string
                  type: array
                - enum:
                  - ''
                  type: string
            title: add_invoice_item_entry
            type: object
          type: array
        application_fee_percent:
          description: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
          type: number
        automatic_tax:
          description: Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
          properties:
            enabled:
              type: boolean
          required:
          - enabled
          title: automatic_tax_config
          type: object
        backdate_start_date:
          description: For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
          format: unix-time
          type: integer
        billing_cycle_anchor:
          description: A future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
          format: unix-time
          type: integer
          x-stripeBypassValidation: true
        billing_thresholds:
          anyOf:
          - properties:
              amount_gte:
                type: integer
              reset_billing_cycle_anchor:
                type: boolean
            title: billing_thresholds_param
            type: object
          - enum:
            - ''
            type: string
          description: Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
        cancel_at:
          description: A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
          format: unix-time
          type: integer
        cancel_at_period_end:
          description: Boolean indicating whether this subscription should cancel at the end of the current period.
          type: boolean
        collection_method:
          description: Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
          enum:
          - charge_automatically
          - send_invoice
          type: string
        coupon:
          description: The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.
          maxLength: 5000
          type: string
        currency:
          description: 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).
          type: string
        days_until_due:
          description: Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
          type: integer
        default_payment_method:
          description: ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
          maxLength: 5000
          type: string
        default_source:
          description: ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
          maxLength: 5000
          type: string
        default_tax_rates:
          anyOf:
          - items:
              maxLength: 5000
              type: string
            type: array
          - enum:
            - ''
            type: string
          description: 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.
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        items:
          description: A list of up to 20 subscription items, each with an attached price.
          items:
            properties:
              billing_thresholds:
                anyOf:
                - properties:
                    usage_gte:
                      type: integer
                  required:
                  - usage_gte
                  title: item_billing_thresholds_param
                  type: object
                - enum:
                  - ''
                  type: string
              metadata:
                additionalProperties:
                  type: string
                type: object
              price:
                maxLength: 5000
                type: string
              price_data:
                properties:
                  currency:
                    type: string
                  product:
                    maxLength: 5000
                    type: string
                  recurring:
                    properties:
                      interval:
                        enum:
                        - day
                        - month
                        - week
                        - year
                        type: string
                      interval_count:
                        type: integer
                    required:
                    - interval
                    title: recurring_adhoc
                    type: object
                  tax_behavior:
                    enum:
                    - exclusive
                    - inclusive
                    - unspecified
                    type: string
                  unit_amount:
                    type: integer
                  unit_amount_decimal:
                    format: decimal
                    type: string
                required:
                - currency
                - product
                - recurring
                title: recurring_price_data
                type: object
              quantity:
                type: integer
              tax_rates:
                anyOf:
                - items:
                    maxLength: 5000
                    type: string
                  type: array
                - enum:
                  - ''
                  type: string
            title: subscription_item_create_params
            type: object
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        off_session:
          description: Indicates if a customer is on or off-session while an invoice payment is attempted.
          type: boolean
        payment_behavior:
          description: 'Only applies to subscriptions with `collection_method=charge_automatically`.


            Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription''s invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.


            Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the payment intent is not confirmed within 23 hours subscriptions transition to `status=incomplete_expired`, which is a terminal state.


            Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription''s first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.


            `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription.


            Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first invoice status.'
          enum:
          - allow_incomplete
          - default_incomplete
          - error_if_incomplete
          - pending_if_incomplete
          type: string
        payment_settings:
          description: Payment settings to pass to invoices created by the subscription.
          properties:
            payment_method_options:
              properties:
                acss_debit:
                  anyOf:
                  - properties:
                      mandate_options:
                        properties:
                          transaction_type:
                            enum:
                            - business
                            - personal
                            type: string
                        title: mandate_options_param
                        type: object
                      verification_method:
                        enum:
                        - automatic
                        - instant
                        - microdeposits
                        type: string
                        x-stripeBypassValidation: true
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                bancontact:
                  anyOf:
                  - properties:
                      preferred_language:
                        enum:
                        - de
                        - en
                        - fr
                        - nl
                        type: string
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                card:
                  anyOf:
                  - properties:
                      mandate_options:
                        properties:
                          amount:
                            type: integer
                          amount_type:
                            enum:
                            - fixed
                            - maximum
                            type: string
                          description:
                            maxLength: 200
                            type: string
                        title: mandate_options_param
                        type: object
                      network:
                        enum:
                        - amex
                        - cartes_bancaires
                        - diners
                        - discover
                        - eftpos_au
                        - interac
                        - jcb
                        - mastercard
                        - unionpay
                        - unknown
                        - visa
                        maxLength: 5000
                        type: string
                        x-stripeBypassValidation: true
                      request_three_d_secure:
                        enum:
                        - any
                        - automatic
                        type: string
                    title: subscription_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                customer_balance:
                  anyOf:
                  - properties:
                      bank_transfer:
                        properties:
                          eu_bank_transfer:
                            properties:
                              country:
                                maxLength: 5000
                                type: string
                            required:
                            - country
                            title: eu_bank_transfer_param
                            type: object
                          type:
                            type: string
                        title: bank_transfer_param
                        type: object
                      funding_type:
                        type: string
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                konbini:
                  anyOf:
                  - properties: {}
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                us_bank_account:
                  anyOf:
                  - properties:
                      financial_connections:
                        properties:
                          permissions:
                            items:
                              enum:
                              - balances
                              - ownership
                              - payment_method
                              - transactions
                              maxLength: 5000
                              type: string
                              x-stripeBypassValidation: true
                            type: array
                          prefetch:
                            items:
                              enum:
                              - balances
                              - transactions
                              type: string
                              x-stripeBypassValidation: true
                            type: array
                        title: invoice_linked_account_options_param
                        type: object
                      verification_method:
                        enum:
                        - automatic
                        - instant
                        - microdeposits
                        type: string
                        x-stripeBypassValidation: true
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
              title: payment_method_options
              type: object
            payment_method_types:
              anyOf:
              - items:
                  enum:
                  - ach_credit_transfer
                  - ach_debit
                  - acss_debit
                  - au_becs_debit
                  - bacs_debit
                  - bancontact
                  - boleto
                  - card
                  - cashapp
                  - customer_balance
                  - fpx
                  - giropay
                  - grabpay
                  - ideal
                  - konbini
                  - link
                  - paynow
                  - paypal
                  - promptpay
                  - sepa_debit
                  - sofort
                  - us_bank_account
                  - wechat_pay
                  type: string
                  x-stripeBypassValidation: true
                type: array
              - enum:
                - ''
                type: string
            save_default_payment_method:
              enum:
              - 'off'
              - on_subscription
              type: string
          title: payment_settings
          type: object
        pending_invoice_item_interval:
          anyOf:
          - properties:
              interval:
                enum:
                - day
                - month
                - week
                - year
                type: string
              interval_count:
                type: integer
            required:
            - interval
            title: pending_invoice_item_interval_params
            type: object
          - enum:
            - ''
            type: string
          description: Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
        promotion_code:
          description: The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.
          maxLength: 5000
          type: string
        proration_behavior:
          description: Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
          enum:
          - always_invoice
          - create_prorations
          - none
          type: string
        transfer_data:
          description: 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.
          properties:
            amount_percent:
              type: number
            destination:
              type: string
          required:
          - destination
          title: transfer_data_specs
          type: object
        trial_end:
          anyOf:
          - enum:
            - now
            maxLength: 5000
            type: string
          - format: unix-time
            type: integer
          description: Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
        trial_from_plan:
          description: Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
          type: boolean
        trial_period_days:
          description: Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
          type: integer
        trial_settings:
          description: Settings related to subscription trials.
          properties:
            end_behavior:
              properties:
                missing_payment_method:
                  enum:
                  - cancel
                  - create_invoice
                  - pause
                  type: string
              required:
              - missing_payment_method
              title: end_behavior
              type: object
          required:
          - end_behavior
          title: trial_settings_config
          type: object
    PostEphemeralKeysRequest:
      type: object
      properties:
        customer:
          description: The ID of the Customer you'd like to modify using the resulting ephemeral key.
          maxLength: 5000
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        issuing_card:
          description: The ID of the Issuing Card you'd like to access using the resulting ephemeral key.
          maxLength: 5000
          type: string
        nonce:
          description: A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information.
          maxLength: 5000
          type: string
        verification_session:
          description: The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key
          maxLength: 5000
          type: string
    PostInvoice ItemsRequest:
      type: object
      required:
      - customer
      properties:
        amount:
          description: The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice.
          type: integer
        currency:
          description: 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).
          type: string
        customer:
          description: The ID of the customer who will be billed when this invoice item is billed.
          maxLength: 5000
          type: string
        description:
          description: An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
          maxLength: 5000
          type: string
        discountable:
          description: Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.
          type: boolean
        discounts:
          anyOf:
          - items:
              properties:
                coupon:
                  maxLength: 5000
                  type: string
                discount:
                  maxLength: 5000
                  type: string
              title: discounts_data_param
              type: object
            type: array
          - enum:
            - ''
            type: string
          description: The coupons to redeem into discounts for the invoice item or invoice line item.
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        invoice:
          description: The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.
          maxLength: 5000
          type: string
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        period:
          description: The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
          properties:
            end:
              format: unix-time
              type: integer
            start:
              format: unix-time
              type: integer
          required:
          - end
          - start
          title: period
          type: object
        price:
          description: The ID of the price object.
          maxLength: 5000
          type: string
        price_data:
          description: Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
          properties:
            currency:
              type: string
            product:
              maxLength: 5000
              type: string
            tax_behavior:
              enum:
              - exclusive
              - inclusive
              - unspecified
              type: string
            unit_amount:
              type: integer
            unit_amount_decimal:
              format: decimal
              type: string
          required:
          - currency
          - product
          title: one_time_price_data
          type: object
        quantity:
          description: Non-negative integer. The quantity of units for the invoice item.
          type: integer
        subscription:
          description: The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
          maxLength: 5000
          type: string
        tax_behavior:
          description: Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
          enum:
          - exclusive
          - inclusive
          - unspecified
          type: string
        tax_code:
          anyOf:
          - type: string
          - enum:
            - ''
            type: string
          description: A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
        tax_rates:
          description: The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.
          items:
            maxLength: 5000
            type: string
          type: array
        unit_amount:
          description: The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice.
          type: integer
        unit_amount_decimal:
          description: Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
          format: decimal
          type: string
    PostInvoice ItemsInvoiceitemRequest:
      type: object
      properties:
        amount:
          description: The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
          type: integer
        description:
          description: An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
          maxLength: 5000
          type: string
        discountable:
          description: Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations.
          type: boolean
        discounts:
          anyOf:
          - items:
              properties:
                coupon:
                  maxLength: 5000
                  type: string
                discount:
                  maxLength: 5000
                  type: string
              title: discounts_data_param
              type: object
            type: array
          - enum:
            - ''
            type: string
          description: The coupons & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        period:
          description: The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
          properties:
            end:
              format: unix-time
              type: integer
            start:
              format: unix-time
              type: integer
          required:
          - end
          - start
          title: period
          type: object
        price:
          description: The ID of the price object.
          maxLength: 5000
          type: string
        price_data:
          description: Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
          properties:
            currency:
              type: string
            product:
              maxLength: 5000
              type: string
            tax_behavior:
              enum:
              - exclusive
              - inclusive
              - unspecified
              type: string
            unit_amount:
              type: integer
            unit_amount_decimal:
              format: decimal
              type: string
          required:
          - currency
          - product
          title: one_time_price_data
          type: object
        quantity:
          description: Non-negative integer. The quantity of units for the invoice item.
          type: integer
        tax_behavior:
          description: Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
          enum:
          - exclusive
          - inclusive
          - unspecified
          type: string
        tax_code:
          anyOf:
          - type: string
          - enum:
            - ''
            type: string
          description: A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
        tax_rates:
          anyOf:
          - items:
              maxLength: 5000
              type: string
            type: array
          - enum:
            - ''
            type: string
          description: The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates.
        unit_amount:
          description: The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
          type: integer
        unit_amount_decimal:
          description: Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
          format: decimal
          type: string
    PostIssuingTokensTokenRequest:
      type: object
      required:
      - status
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        status:
          description: Specifies which status the token should be updated to.
          enum:
          - active
          - deleted
          - suspended
          type: string
    error:
      description: An error response from the Stripe API
      properties:
        error:
          $ref: '#/components/schemas/api_errors'
      required:
      - error
      type: object
    discount:
      description: 'A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).

        It contains information about when the discount began, when it will end, and what it is applied to.


        Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)'
      properties:
        checkout_session:
          description: The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.
          maxLength: 5000
          nullable: true
          type: string
        coupon:
          $ref: '#/components/schemas/coupon'
        customer:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/customer'
          - $ref: '#/components/schemas/deleted_customer'
          description: The ID of the customer associated with this discount.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/customer'
            - $ref: '#/components/schemas/deleted_customer'
        end:
          description: If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.
          format: unix-time
          nullable: true
          type: integer
        id:
          description: The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.
          maxLength: 5000
          type: string
        invoice:
          description: The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
          maxLength: 5000
          nullable: true
          type: string
        invoice_item:
          description: The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
          maxLength: 5000
          nullable: true
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - discount
          type: string
        promotion_code:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/promotion_code'
          description: The promotion code applied to create this discount.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/promotion_code'
        start:
          description: Date that the coupon was applied.
          format: unix-time
          type: integer
        subscription:
          description: The subscription that this coupon is applied to, if it is applied to a particular subscription.
          maxLength: 5000
          nullable: true
          type: string
      required:
      - coupon
      - id
      - object
      - start
      title: Discount
      type: object
      x-expandableFields:
      - coupon
      - customer
      - promotion_code
      x-resourceId: discount
    PostPaymentIntentsIntentConfirmRequest:
      type: object
      properties:
        capture_method:
          description: Controls when the funds will be captured from the customer's account.
          enum:
          - automatic
          - automatic_async
          - manual
          type: string
        client_secret:
          description: The client secret of the PaymentIntent.
          maxLength: 5000
          type: string
        error_on_requires_action:
          description: Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication).
          type: boolean
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        mandate:
          description: ID of the mandate that's used for this payment.
          maxLength: 5000
          type: string
        mandate_data:
          anyOf:
          - properties:
              customer_acceptance:
                properties:
                  accepted_at:
                    format: unix-time
                    type: integer
                  offline:
                    properties: {}
                    title: offline_param
                    type: object
                  online:
                    properties:
                      ip_address:
                        type: string
                      user_agent:
                        maxLength: 5000
                        type: string
                    required:
                    - ip_address
                    - user_agent
                    title: online_param
                    type: object
                  type:
                    enum:
                    - offline
                    - online
                    maxLength: 5000
                    type: string
                required:
                - type
                title: customer_acceptance_param
                type: object
            required:
            - customer_acceptance
            title: secret_key_param
            type: object
          - enum:
            - ''
            type: string
          - description: This hash contains details about the Mandate to create
            properties:
              customer_acceptance:
                properties:
                  online:
                    properties:
                      ip_address:
                        type: string
                      user_agent:
                        maxLength: 5000
                        type: string
                    title: online_param
                    type: object
                  type:
                    enum:
                    - online
                    maxLength: 5000
                    type: string
                required:
                - online
                - type
                title: customer_acceptance_param
                type: object
            required:
            - customer_acceptance
            title: client_key_param
            type: object
        off_session:
          anyOf:
          - type: boolean
          - enum:
            - one_off
            - recurring
            maxLength: 5000
            type: string
          description: Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards).
        payment_method:
          description: ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent.
          maxLength: 5000
          type: string
        payment_method_data:
          description: 'If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear

            in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)

            property on the PaymentIntent.'
          properties:
            acss_debit:
              properties:
                account_number:
                  maxLength: 5000
                  type: string
                institution_number:
                  maxLength: 5000
                  type: string
                transit_number:
                  maxLength: 5000
                  type: string
              required:
              - account_number
              - institution_number
              - transit_number
              title: payment_method_param
              type: object
            affirm:
              properties: {}
              title: param
              type: object
            afterpay_clearpay:
              properties: {}
              title: param
              type: object
            alipay:
              properties: {}
              title: param
              type: object
            au_becs_debit:
              properties:
                account_number:
                  maxLength: 5000
                  type: string
                bsb_number:
                  maxLength: 5000
                  type: string
              required:
              - account_number
              - bsb_number
              title: param
              type: object
            bacs_debit:
              properties:
                account_number:
                  maxLength: 5000
                  type: string
                sort_code:
                  maxLength: 5000
                  type: string
              title: param
              type: object
            bancontact:
              properties: {}
              title: param
              type: object
            billing_details:
              properties:
                address:
                  anyOf:
                  - properties:
                      city:
                        maxLength: 5000
                        type: string
                      country:
                        maxLength: 5000
                        type: string
                      line1:
                        maxLength: 5000
                        type: string
                      line2:
                        maxLength: 5000
                        type: string
                      postal_code:
                        maxLength: 5000
                        type: string
                      state:
                        maxLength: 5000
                        type: string
                    title: billing_details_address
                    type: object
                  - enum:
                    - ''
                    type: string
                email:
                  anyOf:
                  - type: string
                  - enum:
                    - ''
                    type: string
                name:
                  anyOf:
                  - maxLength: 5000
                    type: string
                  - enum:
                    - ''
                    type: string
                phone:
                  anyOf:
                  - maxLength: 5000
                    type: string
                  - enum:
                    - ''
                    type: string
              title: billing_details_inner_params
              type: object
            blik:
              properties: {}
              title: param
              type: object
            boleto:
              properties:
                tax_id:
                  maxLength: 5000
                  type: string
              required:
              - tax_id
              title: param
              type: object
            cashapp:
              properties: {}
              title: param
              type: object
            customer_balance:
              properties: {}
              title: param
              type: object
            eps:
              properties:
                bank:
                  enum:
                  - arzte_und_apotheker_bank
                  - austrian_anadi_bank_ag
                  - bank_austria
                  - bankhaus_carl_spangler
                  - bankhaus_schelhammer_und_schattera_ag
                  - bawag_psk_ag
                  - bks_bank_ag
                  - brull_kallmus_bank_ag
                  - btv_vier_lander_bank
                  - capital_bank_grawe_gruppe_ag
                  - deutsche_bank_ag
                  - dolomitenbank
                  - easybank_ag
                  - erste_bank_und_sparkassen
                  - hypo_alpeadriabank_international_ag
                  - hypo_bank_burgenland_aktiengesellschaft
                  - hypo_noe_lb_fur_niederosterreich_u_wien
                  - hypo_oberosterreich_salzburg_steiermark
                  - hypo_tirol_bank_ag
                  - hypo_vorarlberg_bank_ag
                  - marchfelder_bank
                  - oberbank_ag
                  - raiffeisen_bankengruppe_osterreich
                  - schoellerbank_ag
                  - sparda_bank_wien
                  - volksbank_gruppe
                  - volkskreditbank_ag
                  - vr_bank_braunau
                  maxLength: 5000
                  type: string
              title: param
              type: object
            fpx:
              properties:
                bank:
                  enum:
                  - affin_bank
                  - agrobank
                  - alliance_bank
                  - ambank
                  - bank_islam
                  - bank_muamalat
                  - bank_of_china
                  - bank_rakyat
                  - bsn
                  - cimb
                  - deutsche_bank
                  - hong_leong_bank
                  - hsbc
                  - kfh
                  - maybank2e
                  - maybank2u
                  - ocbc
                  - pb_enterprise
                  - public_bank
                  - rhb
                  - standard_chartered
                  - uob
                  maxLength: 5000
                  type: string
                  x-stripeBypassValidation: true
              required:
              - bank
              title: param
              type: object
            giropay:
              properties: {}
              title: param
              type: object
            grabpay:
              properties: {}
              title: param
              type: object
            ideal:
              properties:
                bank:
                  enum:
                  - abn_amro
                  - asn_bank
                  - bunq
                  - handelsbanken
                  - ing
                  - knab
                  - moneyou
                  - n26
                  - rabobank
                  - regiobank
                  - revolut
                  - sns_bank
                  - triodos_bank
                  - van_lanschot
                  - yoursafe
                  maxLength: 5000
                  type: string
              title: param
              type: object
            interac_present:
              properties: {}
              title: param
              type: object
            klarna:
              properties:
                dob:
                  properties:
                    day:
                      type: integer
                    month:
                      type: integer
                    year:
                      type: integer
                  required:
                  - day
                  - month
                  - year
                  title: date_of_birth
                  type: object
              title: param
              type: object
            konbini:
              properties: {}
              title: param
              type: object
            link:
              properties: {}
              title: param
              type: object
            metadata:
              additionalProperties:
                type: string
              type: object
            oxxo:
              properties: {}
              title: param
              type: object
            p24:
              properties:
                bank:
                  enum:
                  - alior_bank
                  - bank_millennium
                  - bank_nowy_bfg_sa
                  - bank_pekao_sa
                  - banki_spbdzielcze
                  - blik
                  - bnp_paribas
                  - boz
                  - citi_handlowy
                  - credit_agricole
                  - envelobank
                  - etransfer_pocztowy24
                  - getin_bank
                  - ideabank
                  - ing
                  - inteligo
                  - mbank_mtransfer
                  - nest_przelew
                  - noble_pay
                  - pbac_z_ipko
                  - plus_bank
                  - santander_przelew24
                  - tmobile_usbugi_bankowe
                  - toyota_bank
                  - volkswagen_bank
                  type: string
                  x-stripeBypassValidation: true
              title: param
              type: object
            paynow:
              properties: {}
              title: param
              type: object
            paypal:
              properties: {}
              title: param
              type: object
            pix:
              properties: {}
              title: param
              type: object
            promptpay:
              properties: {}
              title: param
              type: object
            radar_options:
              properties:
                session:
                  maxLength: 5000
                  type: string
              title: radar_options
              type: object
            revolut_pay:
              properties: {}
              title: param
              type: object
            sepa_debit:
              properties:
                iban:
                  maxLength: 5000
                  type: string
              required:
              - iban
              title: param
              type: object
            sofort:
              properties:
                country:
                  enum:
                  - AT
                  - BE
                  - DE
                  - ES
                  - IT
                  - NL
                  type: string
              required:
              - country
              title: param
              type: object
            type:
              enum:
              - acss_debit
              - affirm
              - afterpay_clearpay
              - alipay
              - au_becs_debit
              - bacs_debit
              - bancontact
              - blik
              - boleto
              - cashapp
              - customer_balance
              - eps
              - fpx
              - giropay
              - grabpay
              - ideal
              - klarna
              - konbini
              - link
              - oxxo
              - p24
              - paynow
              - paypal
              - pix
              - promptpay
              - revolut_pay
              - sepa_debit
              - sofort
              - us_bank_account
              - wechat_pay
              - zip
              type: string
              x-stripeBypassValidation: true
            us_bank_account:
              properties:
                account_holder_type:
                  enum:
                  - company
                  - individual
                  type: string
                account_number:
                  maxLength: 5000
                  type: string
                account_type:
                  enum:
                  - checking
                  - savings
                  type: string
                financial_connections_account:
                  maxLength: 5000
                  type: string
                routing_number:
                  maxLength: 5000
                  type: string
              title: payment_method_param
              type: object
            wechat_pay:
              properties: {}
              title: param
              type: object
            zip:
              properties: {}
              title: param
              type: object
          required:
          - type
          title: payment_method_data_params
          type: object
        payment_method_options:
          description: Payment method-specific configuration for this PaymentIntent.
          properties:
            acss_debit:
              anyOf:
              - properties:
                  mandate_options:
                    properties:
                      custom_mandate_url:
                        anyOf:
                        - type: string
                        - enum:
                          - ''
                          type: string
                      interval_description:
                        maxLength: 500
                        type: string
                      payment_schedule:
                        enum:
                        - combined
                        - interval
                        - sporadic
                        type: string
                      transaction_type:
                        enum:
                        - business
                        - personal
                        type: string
                    title: payment_intent_payment_method_options_mandate_options_param
                    type: object
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                  verification_method:
                    enum:
                    - automatic
                    - instant
                    - microdeposits
                    type: string
                    x-stripeBypassValidation: true
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            affirm:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  preferred_locale:
                    maxLength: 30
                    type: string
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            afterpay_clearpay:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  reference:
                    maxLength: 128
                    type: string
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                    x-stripeBypassValidation: true
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            alipay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            au_becs_debit:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            bacs_debit:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            bancontact:
              anyOf:
              - properties:
                  preferred_language:
                    enum:
                    - de
                    - en
                    - fr
                    - nl
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            blik:
              anyOf:
              - properties:
                  code:
                    maxLength: 5000
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            boleto:
              anyOf:
              - properties:
                  expires_after_days:
                    type: integer
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            card:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  cvc_token:
                    maxLength: 5000
                    type: string
                  installments:
                    properties:
                      enabled:
                        type: boolean
                      plan:
                        anyOf:
                        - properties:
                            count:
                              type: integer
                            interval:
                              enum:
                              - month
                              type: string
                            type:
                              enum:
                              - fixed_count
                              type: string
                          required:
                          - count
                          - interval
                          - type
                          title: installment_plan
                          type: object
                        - enum:
                          - ''
                          type: string
                    title: installments_param
                    type: object
                  mandate_options:
                    properties:
                      amount:
                        type: integer
                      amount_type:
                        enum:
                        - fixed
                        - maximum
                        type: string
                      description:
                        maxLength: 200
                        type: string
                      end_date:
                        format: unix-time
                        type: integer
                      interval:
                        enum:
                        - day
                        - month
                        - sporadic
                        - week
                        - year
                        type: string
                      interval_count:
                        type: integer
                      reference:
                        maxLength: 80
                        type: string
                      start_date:
                        format: unix-time
                        type: integer
                      supported_types:
                        items:
                          enum:
                          - india
                          type: string
                        type: array
                    required:
                    - amount
                    - amount_type
                    - interval
                    - reference
                    - start_date
                    title: mandate_options_param
                    type: object
                  network:
                    enum:
                    - amex
                    - cartes_bancaires
                    - diners
                    - discover
                    - eftpos_au
                    - interac
                    - jcb
                    - mastercard
                    - unionpay
                    - unknown
                    - visa
                    maxLength: 5000
                    type: string
                    x-stripeBypassValidation: true
                  request_extended_authorization:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_incremental_authorization:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_multicapture:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_overcapture:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_three_d_secure:
                    enum:
                    - any
                    - automatic
                    - challenge
                    type: string
                    x-stripeBypassValidation: true
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                  statement_descriptor_suffix_kana:
                    anyOf:
                    - maxLength: 22
                      type: string
                    - enum:
                      - ''
                      type: string
                  statement_descriptor_suffix_kanji:
                    anyOf:
                    - maxLength: 17
                      type: string
                    - enum:
                      - ''
                      type: string
                  three_d_secure:
                    properties:
                      ares_trans_status:
                        enum:
                        - A
                        - C
                        - I
                        - N
                        - R
                        - U
                        - Y
                        type: string
                      cryptogram:
                        maxLength: 5000
                        type: string
                      electronic_commerce_indicator:
                        enum:
                        - '01'
                        - '02'
                        - '05'
                        - '06'
                        - '07'
                        type: string
                        x-stripeBypassValidation: true
                      exemption_indicator:
                        enum:
                        - low_risk
                        - none
                        type: string
                      network_options:
                        properties:
                          cartes_bancaires:
                            properties:
                              cb_avalgo:
                                enum:
                                - '0'
                                - '1'
                                - '2'
                                - '3'
                                - '4'
                                - A
                                type: string
                              cb_exemption:
                                maxLength: 4
                                type: string
                              cb_score:
                                type: integer
                            required:
                            - cb_avalgo
                            title: cartes_bancaires_network_options_param
                            type: object
                        title: network_options_param
                        type: object
                      requestor_challenge_indicator:
                        maxLength: 2
                        type: string
                      transaction_id:
                        maxLength: 5000
                        type: string
                      version:
                        enum:
                        - 1.0.2
                        - 2.1.0
                        - 2.2.0
                        type: string
                        x-stripeBypassValidation: true
                    required:
                    - cryptogram
                    - transaction_id
                    - version
                    title: payment_method_options_param
                    type: object
                title: payment_intent_param
                type: object
              - enum:
                - ''
                type: string
            card_present:
              anyOf:
              - properties:
                  request_extended_authorization:
                    type: boolean
                  request_incremental_authorization_support:
                    type: boolean
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            cashapp:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            customer_balance:
              anyOf:
              - properties:
                  bank_transfer:
                    properties:
                      eu_bank_transfer:
                        properties:
                          country:
                            maxLength: 5000
                            type: string
                        required:
                        - country
                        title: eu_bank_transfer_params
                        type: object
                      requested_address_types:
                        items:
                          enum:
                          - aba
                          - iban
                          - sepa
                          - sort_code
                          - spei
                          - swift
                          - zengin
                          type: string
                          x-stripeBypassValidation: true
                        type: array
                      type:
                        enum:
                        - eu_bank_transfer
                        - gb_bank_transfer
                        - jp_bank_transfer
                        - mx_bank_transfer
                        - us_bank_transfer
                        type: string
                        x-stripeBypassValidation: true
                    required:
                    - type
                    title: bank_transfer_param
                    type: object
                  funding_type:
                    enum:
                    - bank_transfer
                    type: string
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            eps:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            fpx:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            giropay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            grabpay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            ideal:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            interac_present:
              anyOf:
              - properties: {}
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            klarna:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  preferred_locale:
                    enum:
                    - cs-CZ
                    - da-DK
                    - de-AT
                    - de-CH
                    - de-DE
                    - el-GR
                    - en-AT
                    - en-AU
                    - en-BE
                    - en-CA
                    - en-CH
                    - en-CZ
                    - en-DE
                    - en-DK
                    - en-ES
                    - en-FI
                    - en-FR
                    - en-GB
                    - en-GR
                    - en-IE
                    - en-IT
                    - en-NL
                    - en-NO
                    - en-NZ
                    - en-PL
                    - en-PT
                    - en-SE
                    - en-US
                    - es-ES
                    - es-US
                    - fi-FI
                    - fr-BE
                    - fr-CA
                    - fr-CH
                    - fr-FR
                    - it-CH
                    - it-IT
                    - nb-NO
                    - nl-BE
                    - nl-NL
                    - pl-PL
                    - pt-PT
                    - sv-FI
                    - sv-SE
                    type: string
                    x-stripeBypassValidation: true
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                    x-stripeBypassValidation: true
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            konbini:
              anyOf:
              - properties:
                  confirmation_number:
                    anyOf:
                    - maxLength: 11
                      type: string
                    - enum:
                      - ''
                      type: string
                  expires_after_days:
                    anyOf:
                    - type: integer
                    - enum:
                      - ''
                      type: string
                  expires_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                  product_description:
                    anyOf:
                    - maxLength: 22
                      type: string
                    - enum:
                      - ''
                      type: string
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            link:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            oxxo:
              anyOf:
              - properties:
                  expires_after_days:
                    type: integer
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            p24:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                  tos_shown_and_accepted:
                    type: boolean
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            paynow:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            paypal:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  preferred_locale:
                    enum:
                    - 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
                    type: string
                    x-stripeBypassValidation: true
                  reference:
                    maxLength: 127
                    type: string
                  risk_correlation_id:
                    maxLength: 32
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            pix:
              anyOf:
              - properties:
                  expires_after_seconds:
                    type: integer
                  expires_at:
                    format: unix-time
                    type: integer
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            promptpay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            revolut_pay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            sepa_debit:
              anyOf:
              - properties:
                  mandate_options:
                    properties: {}
                    title: payment_method_options_mandate_options_param
                    type: object
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            sofort:
              anyOf:
              - properties:
                  preferred_language:
                    enum:
                    - ''
                    - de
                    - en
                    - es
                    - fr
                    - it
                    - nl
                    - pl
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            us_bank_account:
              anyOf:
              - properties:
                  financial_connections:
                    properties:
                      permissions:
                        items:
                          enum:
                          - balances
                          - ownership
                          - payment_method
                          - transactions
                          maxLength: 5000
                          type: string
                          x-stripeBypassValidation: true
                        type: array
                      prefetch:
                        items:
                          enum:
                          - balances
                          - transactions
                          type: string
                          x-stripeBypassValidation: true
                        type: array
                      return_url:
                        maxLength: 5000
                        type: string
                    title: linked_account_options_param
                    type: object
                  mandate_options:
                    properties:
                      collection_method:
                        enum:
                        - ''
                        - paper
                        type: string
                        x-stripeBypassValidation: true
                    title: mandate_options_param
                    type: object
                  networks:
                    properties:
                      requested:
                        items:
                          enum:
                          - ach
                          - us_domestic_wire
                          type: string
                        type: array
                    title: networks_options_param
                    type: object
                  preferred_settlement_speed:
                    enum:
                    - ''
                    - fastest
                    - standard
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                  verification_method:
                    enum:
                    - automatic
                    - instant
                    - microdeposits
                    type: string
                    x-stripeBypassValidation: true
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            wechat_pay:
              anyOf:
              - properties:
                  app_id:
                    maxLength: 5000
                    type: string
                  client:
                    enum:
                    - android
                    - ios
                    - web
                    type: string
                    x-stripeBypassValidation: true
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                required:
                - client
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            zip:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
          title: payment_method_options_param
          type: object
        payment_method_types:
          description: The list of payment method types (for example, a card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
          items:
            maxLength: 5000
            type: string
          type: array
        radar_options:
          description: Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).
          properties:
            session:
              maxLength: 5000
              type: string
          title: radar_options_with_hidden_options
          type: object
        receipt_email:
          anyOf:
          - type: string
          - enum:
            - ''
            type: string
          description: Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
        return_url:
          description: 'The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method''s app or site.

            If you''d prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.

            This parameter is only used for cards and other redirect-based payment methods.'
          type: string
        setup_future_usage:
          description: 'Indicates that you intend to make future payments with this PaymentIntent''s payment method.


            Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent''s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.


            When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).


            If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.'
          enum:
          - ''
          - off_session
          - on_session
          type: string
        shipping:
          anyOf:
          - properties:
              address:
                properties:
                  city:
                    maxLength: 5000
                    type: string
                  country:
                    maxLength: 5000
                    type: string
                  line1:
                    maxLength: 5000
                    type: string
                  line2:
                    maxLength: 5000
                    type: string
                  postal_code:
                    maxLength: 5000
                    type: string
                  state:
                    maxLength: 5000
                    type: string
                title: optional_fields_address
                type: object
              carrier:
                maxLength: 5000
                type: string
              name:
                maxLength: 5000
                type: string
              phone:
                maxLength: 5000
                type: string
              tracking_number:
                maxLength: 5000
                type: string
            required:
            - address
            - name
            title: optional_fields_shipping
            type: object
          - enum:
            - ''
            type: string
          description: Shipping information for this PaymentIntent.
        use_stripe_sdk:
          description: Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
          type: boolean
    dispute:
      description: 'A dispute occurs when a customer questions your charge with their card issuer.

        When this happens, you have the opportunity to respond to the dispute with

        evidence that shows that the charge is legitimate.


        Related guide: [Disputes and fraud](https://stripe.com/docs/disputes)'
      properties:
        amount:
          description: Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed).
          type: integer
        balance_transactions:
          description: List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.
          items:
            $ref: '#/components/schemas/balance_transaction'
          type: array
        charge:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/charge'
          description: ID of the charge that's disputed.
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/charge'
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: 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).
          type: string
        evidence:
          $ref: '#/components/schemas/dispute_evidence'
        evidence_details:
          $ref: '#/components/schemas/dispute_evidence_details'
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        is_charge_refundable:
          description: If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute.
          type: boolean
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          type: object
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - dispute
          type: string
        payment_intent:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/payment_intent'
          description: ID of the PaymentIntent that's disputed.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/payment_intent'
        payment_method_details:
          $ref: '#/components/schemas/dispute_payment_method_details'
        reason:
          description: Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories).
          maxLength: 5000
          type: string
        status:
          description: Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`.
          enum:
          - lost
          - needs_response
          - under_review
          - warning_closed
          - warning_needs_response
          - warning_under_review
          - won
          type: string
      required:
      - amount
      - balance_transactions
      - charge
      - created
      - currency
      - evidence
      - evidence_details
      - id
      - is_charge_refundable
      - livemode
      - metadata
      - object
      - reason
      - status
      title: Dispute
      type: object
      x-expandableFields:
      - balance_transactions
      - charge
      - evidence
      - evidence_details
      - payment_intent
      - payment_method_details
      x-resourceId: dispute
    payment_source:
      anyOf:
      - $ref: '#/components/schemas/account'
      - $ref: '#/components/schemas/bank_account'
      - $ref: '#/components/schemas/card'
      - $ref: '#/components/schemas/source'
      title: Polymorphic
      x-resourceId: payment_source
      x-stripeBypassValidation: true
    payment_method:
      description: 'PaymentMethod objects represent your customer''s payment instruments.

        You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to

        Customer objects to store instrument details for future payments.


        Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).'
      properties:
        acss_debit:
          $ref: '#/components/schemas/payment_method_acss_debit'
        affirm:
          $ref: '#/components/schemas/payment_method_affirm'
        afterpay_clearpay:
          $ref: '#/components/schemas/payment_method_afterpay_clearpay'
        alipay:
          $ref: '#/components/schemas/payment_flows_private_payment_methods_alipay'
        au_becs_debit:
          $ref: '#/components/schemas/payment_method_au_becs_debit'
        bacs_debit:
          $ref: '#/components/schemas/payment_method_bacs_debit'
        bancontact:
          $ref: '#/components/schemas/payment_method_bancontact'
        billing_details:
          $ref: '#/components/schemas/billing_details'
        blik:
          $ref: '#/components/schemas/payment_method_blik'
        boleto:
          $ref: '#/components/schemas/payment_method_boleto'
        card:
          $ref: '#/components/schemas/payment_method_card'
        card_present:
          $ref: '#/components/schemas/payment_method_card_present'
        cashapp:
          $ref: '#/components/schemas/payment_method_cashapp'
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        customer:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/customer'
          description: The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/customer'
        customer_balance:
          $ref: '#/components/schemas/payment_method_customer_balance'
        eps:
          $ref: '#/components/schemas/payment_method_eps'
        fpx:
          $ref: '#/components/schemas/payment_method_fpx'
        giropay:
          $ref: '#/components/schemas/payment_method_giropay'
        grabpay:
          $ref: '#/components/schemas/payment_method_grabpay'
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        ideal:
          $ref: '#/components/schemas/payment_method_ideal'
        interac_present:
          $ref: '#/components/schemas/payment_method_interac_present'
        klarna:
          $ref: '#/components/schemas/payment_method_klarna'
        konbini:
          $ref: '#/components/schemas/payment_method_konbini'
        link:
          $ref: '#/components/schemas/payment_method_link'
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          nullable: true
          type: object
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - payment_method
          type: string
        oxxo:
          $ref: '#/components/schemas/payment_method_oxxo'
        p24:
          $ref: '#/components/schemas/payment_method_p24'
        paynow:
          $ref: '#/components/schemas/payment_method_paynow'
        paypal:
          $ref: '#/components/schemas/payment_method_paypal'
        pix:
          $ref: '#/components/schemas/payment_method_pix'
        promptpay:
          $ref: '#/components/schemas/payment_method_promptpay'
        radar_options:
          $ref: '#/components/schemas/radar_radar_options'
        revolut_pay:
          $ref: '#/components/schemas/payment_method_revolut_pay'
        sepa_debit:
          $ref: '#/components/schemas/payment_method_sepa_debit'
        sofort:
          $ref: '#/components/schemas/payment_method_sofort'
        type:
          description: The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
          enum:
          - acss_debit
          - affirm
          - afterpay_clearpay
          - alipay
          - au_becs_debit
          - bacs_debit
          - bancontact
          - blik
          - boleto
          - card
          - card_present
          - cashapp
          - customer_balance
          - eps
          - fpx
          - giropay
          - grabpay
          - ideal
          - interac_present
          - klarna
          - konbini
          - link
          - oxxo
          - p24
          - paynow
          - paypal
          - pix
          - promptpay
          - revolut_pay
          - sepa_debit
          - sofort
          - us_bank_account
          - wechat_pay
          - zip
          type: string
          x-stripeBypassValidation: true
        us_bank_account:
          $ref: '#/components/schemas/payment_method_us_bank_account'
        wechat_pay:
          $ref: '#/components/schemas/payment_method_wechat_pay'
        zip:
          $ref: '#/components/schemas/payment_method_zip'
      required:
      - billing_details
      - created
      - id
      - livemode
      - object
      - type
      title: PaymentMethod
      type: object
      x-expandableFields:
      - acss_debit
      - affirm
      - afterpay_clearpay
      - alipay
      - au_becs_debit
      - bacs_debit
      - bancontact
      - billing_details
      - blik
      - boleto
      - card
      - card_present
      - cashapp
      - customer
      - customer_balance
      - eps
      - fpx
      - giropay
      - grabpay
      - ideal
      - interac_present
      - klarna
      - konbini
      - link
      - oxxo
      - p24
      - paynow
      - paypal
      - pix
      - promptpay
      - radar_options
      - revolut_pay
      - sepa_debit
      - sofort
      - us_bank_account
      - wechat_pay
      - zip
      x-resourceId: payment_method
    PostFilesRequest:
      type: object
      required:
      - file
      - purpose
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        file:
          description: A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.
          format: binary
          type: string
        file_link_data:
          description: Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.
          properties:
            create:
              type: boolean
            expires_at:
              format: unix-time
              type: integer
            metadata:
              anyOf:
              - additionalProperties:
                  type: string
                type: object
              - enum:
                - ''
                type: string
          required:
          - create
          title: file_link_creation_params
          type: object
        purpose:
          description: The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
          enum:
          - account_requirement
          - additional_verification
          - business_icon
          - business_logo
          - customer_signature
          - dispute_evidence
          - identity_document
          - pci_document
          - tax_document_user_upload
          - terminal_reader_splashscreen
          type: string
          x-stripeBypassValidation: true
    PostCustomersCustomerSourcesRequest:
      type: object
      properties:
        alipay_account:
          description: A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details.
          maxLength: 5000
          type: string
        bank_account:
          anyOf:
          - properties:
              account_holder_name:
                maxLength: 5000
                type: string
              account_holder_type:
                enum:
                - company
                - individual
                maxLength: 5000
                type: string
              account_number:
                maxLength: 5000
                type: string
              country:
                maxLength: 5000
                type: string
              currency:
                type: string
              object:
                enum:
                - bank_account
                maxLength: 5000
                type: string
              routing_number:
                maxLength: 5000
                type: string
            required:
            - account_number
            - country
            title: customer_payment_source_bank_account
            type: object
          - maxLength: 5000
            type: string
          description: Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details.
        card:
          anyOf:
          - properties:
              address_city:
                maxLength: 5000
                type: string
              address_country:
                maxLength: 5000
                type: string
              address_line1:
                maxLength: 5000
                type: string
              address_line2:
                maxLength: 5000
                type: string
              address_state:
                maxLength: 5000
                type: string
              address_zip:
                maxLength: 5000
                type: string
              cvc:
                maxLength: 5000
                type: string
              exp_month:
                type: integer
              exp_year:
                type: integer
              metadata:
                additionalProperties:
                  type: string
                type: object
              name:
                maxLength: 5000
                type: string
              number:
                maxLength: 5000
                type: string
              object:
                enum:
                - card
                maxLength: 5000
                type: string
            required:
            - exp_month
            - exp_year
            - number
            title: customer_payment_source_card
            type: object
          - maxLength: 5000
            type: string
          description: A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).
          x-stripeBypassValidation: true
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        source:
          description: Please refer to full [documentation](https://stripe.com/docs/api) instead.
          maxLength: 5000
          type: string
          x-stripeBypassValidation: true
    PostPaymentMethodsPaymentMethodAttachRequest:
      type: object
      required:
      - customer
      properties:
        customer:
          description: The ID of the customer to which to attach the PaymentMethod.
          maxLength: 5000
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    payment_method_domain:
      description: 'A payment method domain represents a web domain that you have registered with Stripe.

        Stripe Elements use registered payment method domains to control where certain payment methods are shown.


        Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).'
      properties:
        apple_pay:
          $ref: '#/components/schemas/payment_method_domain_resource_payment_method_status'
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        domain_name:
          description: The domain name that this payment method domain object represents.
          maxLength: 5000
          type: string
        enabled:
          description: Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.
          type: boolean
        google_pay:
          $ref: '#/components/schemas/payment_method_domain_resource_payment_method_status'
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        link:
          $ref: '#/components/schemas/payment_method_domain_resource_payment_method_status'
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - payment_method_domain
          type: string
        paypal:
          $ref: '#/components/schemas/payment_method_domain_resource_payment_method_status'
      required:
      - apple_pay
      - created
      - domain_name
      - enabled
      - google_pay
      - id
      - link
      - livemode
      - object
      - paypal
      title: PaymentMethodDomainResourcePaymentMethodDomain
      type: object
      x-expandableFields:
      - apple_pay
      - google_pay
      - link
      - paypal
      x-resourceId: payment_method_domain
    PostIssuingCardholdersCardholderRequest:
      type: object
      properties:
        billing:
          description: The cardholder's billing address.
          properties:
            address:
              properties:
                city:
                  maxLength: 5000
                  type: string
                country:
                  maxLength: 5000
                  type: string
                line1:
                  maxLength: 5000
                  type: string
                line2:
                  maxLength: 5000
                  type: string
                postal_code:
                  maxLength: 5000
                  type: string
                state:
                  maxLength: 5000
                  type: string
              required:
              - city
              - country
              - line1
              - postal_code
              title: required_address
              type: object
          required:
          - address
          title: billing_specs
          type: object
        company:
          description: Additional information about a `company` cardholder.
          properties:
            tax_id:
              maxLength: 5000
              type: string
          title: company_param
          type: object
        email:
          description: The cardholder's email address.
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        individual:
          description: Additional information about an `individual` cardholder.
          properties:
            card_issuing:
              properties:
                user_terms_acceptance:
                  properties:
                    date:
                      format: unix-time
                      type: integer
                    ip:
                      type: string
                    user_agent:
                      anyOf:
                      - maxLength: 5000
                        type: string
                      - enum:
                        - ''
                        type: string
                  title: terms_acceptance_param
                  type: object
              title: card_issuing_param
              type: object
            dob:
              properties:
                day:
                  type: integer
                month:
                  type: integer
                year:
                  type: integer
              required:
              - day
              - month
              - year
              title: date_of_birth_specs
              type: object
            first_name:
              type: string
            last_name:
              type: string
            verification:
              properties:
                document:
                  properties:
                    back:
                      maxLength: 5000
                      type: string
                    front:
                      maxLength: 5000
                      type: string
                  title: person_verification_document_param
                  type: object
              title: person_verification_param
              type: object
          title: individual_param
          type: object
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        phone_number:
          description: The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure) for more details.
          type: string
        preferred_locales:
          description: "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder."
          items:
            enum:
            - de
            - en
            - es
            - fr
            - it
            type: string
          type: array
        spending_controls:
          description: Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
          properties:
            allowed_categories:
              items:
                enum:
                - ac_refrigeration_repair
                - accounting_bookkeeping_services
                - advertising_services
                - agricultural_cooperative
                - airlines_air_carriers
                - airports_flying_fields
                - ambulance_services
                - amusement_parks_carnivals
                - antique_reproductions
                - antique_shops
                - aquariums
                - architectural_surveying_services
                - art_dealers_and_galleries
                - artists_supply_and_craft_shops
                - auto_and_home_supply_stores
                - auto_body_repair_shops
                - auto_paint_shops
                - auto_service_shops
                - automated_cash_disburse
                - automated_fuel_dispensers
                - automobile_associations
                - automotive_parts_and_accessories_stores
                - automotive_tire_stores
                - bail_and_bond_payments
                - bakeries
                - bands_orchestras
                - barber_and_beauty_shops
                - betting_casino_gambling
                - bicycle_shops
                - billiard_pool_establishments
                - boat_dealers
                - boat_rentals_and_leases
                - book_stores
                - books_periodicals_and_newspapers
                - bowling_alleys
                - bus_lines
                - business_secretarial_schools
                - buying_shopping_services
                - cable_satellite_and_other_pay_television_and_radio
                - camera_and_photographic_supply_stores
                - candy_nut_and_confectionery_stores
                - car_and_truck_dealers_new_used
                - car_and_truck_dealers_used_only
                - car_rental_agencies
                - car_washes
                - carpentry_services
                - carpet_upholstery_cleaning
                - caterers
                - charitable_and_social_service_organizations_fundraising
                - chemicals_and_allied_products
                - child_care_services
                - childrens_and_infants_wear_stores
                - chiropodists_podiatrists
                - chiropractors
                - cigar_stores_and_stands
                - civic_social_fraternal_associations
                - cleaning_and_maintenance
                - clothing_rental
                - colleges_universities
                - commercial_equipment
                - commercial_footwear
                - commercial_photography_art_and_graphics
                - commuter_transport_and_ferries
                - computer_network_services
                - computer_programming
                - computer_repair
                - computer_software_stores
                - computers_peripherals_and_software
                - concrete_work_services
                - construction_materials
                - consulting_public_relations
                - correspondence_schools
                - cosmetic_stores
                - counseling_services
                - country_clubs
                - courier_services
                - court_costs
                - credit_reporting_agencies
                - cruise_lines
                - dairy_products_stores
                - dance_hall_studios_schools
                - dating_escort_services
                - dentists_orthodontists
                - department_stores
                - detective_agencies
                - digital_goods_applications
                - digital_goods_games
                - digital_goods_large_volume
                - digital_goods_media
                - direct_marketing_catalog_merchant
                - direct_marketing_combination_catalog_and_retail_merchant
                - direct_marketing_inbound_telemarketing
                - direct_marketing_insurance_services
                - direct_marketing_other
                - direct_marketing_outbound_telemarketing
                - direct_marketing_subscription
                - direct_marketing_travel
                - discount_stores
                - doctors
                - door_to_door_sales
                - drapery_window_covering_and_upholstery_stores
                - drinking_places
                - drug_stores_and_pharmacies
                - drugs_drug_proprietaries_and_druggist_sundries
                - dry_cleaners
                - durable_goods
                - duty_free_stores
                - eating_places_restaurants
                - educational_services
                - electric_razor_stores
                - electric_vehicle_charging
                - electrical_parts_and_equipment
                - electrical_services
                - electronics_repair_shops
                - electronics_stores
                - elementary_secondary_schools
                - emergency_services_gcas_visa_use_only
                - employment_temp_agencies
                - equipment_rental
                - exterminating_services
                - family_clothing_stores
                - fast_food_restaurants
                - financial_institutions
                - fines_government_administrative_entities
                - fireplace_fireplace_screens_and_accessories_stores
                - floor_covering_stores
                - florists
                - florists_supplies_nursery_stock_and_flowers
                - freezer_and_locker_meat_provisioners
                - fuel_dealers_non_automotive
                - funeral_services_crematories
                - furniture_home_furnishings_and_equipment_stores_except_appliances
                - furniture_repair_refinishing
                - furriers_and_fur_shops
                - general_services
                - gift_card_novelty_and_souvenir_shops
                - glass_paint_and_wallpaper_stores
                - glassware_crystal_stores
                - golf_courses_public
                - government_licensed_horse_dog_racing_us_region_only
                - government_licensed_online_casions_online_gambling_us_region_only
                - government_owned_lotteries_non_us_region
                - government_owned_lotteries_us_region_only
                - government_services
                - grocery_stores_supermarkets
                - hardware_equipment_and_supplies
                - hardware_stores
                - health_and_beauty_spas
                - hearing_aids_sales_and_supplies
                - heating_plumbing_a_c
                - hobby_toy_and_game_shops
                - home_supply_warehouse_stores
                - hospitals
                - hotels_motels_and_resorts
                - household_appliance_stores
                - industrial_supplies
                - information_retrieval_services
                - insurance_default
                - insurance_underwriting_premiums
                - intra_company_purchases
                - jewelry_stores_watches_clocks_and_silverware_stores
                - landscaping_services
                - laundries
                - laundry_cleaning_services
                - legal_services_attorneys
                - luggage_and_leather_goods_stores
                - lumber_building_materials_stores
                - manual_cash_disburse
                - marinas_service_and_supplies
                - marketplaces
                - masonry_stonework_and_plaster
                - massage_parlors
                - medical_and_dental_labs
                - medical_dental_ophthalmic_and_hospital_equipment_and_supplies
                - medical_services
                - membership_organizations
                - mens_and_boys_clothing_and_accessories_stores
                - mens_womens_clothing_stores
                - metal_service_centers
                - miscellaneous
                - miscellaneous_apparel_and_accessory_shops
                - miscellaneous_auto_dealers
                - miscellaneous_business_services
                - miscellaneous_food_stores
                - miscellaneous_general_merchandise
                - miscellaneous_general_services
                - miscellaneous_home_furnishing_specialty_stores
                - miscellaneous_publishing_and_printing
                - miscellaneous_recreation_services
                - miscellaneous_repair_shops
                - miscellaneous_specialty_retail
                - mobile_home_dealers
                - motion_picture_theaters
                - motor_freight_carriers_and_trucking
                - motor_homes_dealers
                - motor_vehicle_supplies_and_new_parts
                - motorcycle_shops_and_dealers
                - motorcycle_shops_dealers
                - music_stores_musical_instruments_pianos_and_sheet_music
                - news_dealers_and_newsstands
                - non_fi_money_orders
                - non_fi_stored_value_card_purchase_load
                - nondurable_goods
                - nurseries_lawn_and_garden_supply_stores
                - nursing_personal_care
                - office_and_commercial_furniture
                - opticians_eyeglasses
                - optometrists_ophthalmologist
                - orthopedic_goods_prosthetic_devices
                - osteopaths
                - package_stores_beer_wine_and_liquor
                - paints_varnishes_and_supplies
                - parking_lots_garages
                - passenger_railways
                - pawn_shops
                - pet_shops_pet_food_and_supplies
                - petroleum_and_petroleum_products
                - photo_developing
                - photographic_photocopy_microfilm_equipment_and_supplies
                - photographic_studios
                - picture_video_production
                - piece_goods_notions_and_other_dry_goods
                - plumbing_heating_equipment_and_supplies
                - political_organizations
                - postal_services_government_only
                - precious_stones_and_metals_watches_and_jewelry
                - professional_services
                - public_warehousing_and_storage
                - quick_copy_repro_and_blueprint
                - railroads
                - real_estate_agents_and_managers_rentals
                - record_stores
                - recreational_vehicle_rentals
                - religious_goods_stores
                - religious_organizations
                - roofing_siding_sheet_metal
                - secretarial_support_services
                - security_brokers_dealers
                - service_stations
                - sewing_needlework_fabric_and_piece_goods_stores
                - shoe_repair_hat_cleaning
                - shoe_stores
                - small_appliance_repair
                - snowmobile_dealers
                - special_trade_services
                - specialty_cleaning
                - sporting_goods_stores
                - sporting_recreation_camps
                - sports_and_riding_apparel_stores
                - sports_clubs_fields
                - stamp_and_coin_stores
                - stationary_office_supplies_printing_and_writing_paper
                - stationery_stores_office_and_school_supply_stores
                - swimming_pools_sales
                - t_ui_travel_germany
                - tailors_alterations
                - tax_payments_government_agencies
                - tax_preparation_services
                - taxicabs_limousines
                - telecommunication_equipment_and_telephone_sales
                - telecommunication_services
                - telegraph_services
                - tent_and_awning_shops
                - testing_laboratories
                - theatrical_ticket_agencies
                - timeshares
                - tire_retreading_and_repair
                - tolls_bridge_fees
                - tourist_attractions_and_exhibits
                - towing_services
                - trailer_parks_campgrounds
                - transportation_services
                - travel_agencies_tour_operators
                - truck_stop_iteration
                - truck_utility_trailer_rentals
                - typesetting_plate_making_and_related_services
                - typewriter_stores
                - u_s_federal_government_agencies_or_departments
                - uniforms_commercial_clothing
                - used_merchandise_and_secondhand_stores
                - utilities
                - variety_stores
                - veterinary_services
                - video_amusement_game_supplies
                - video_game_arcades
                - video_tape_rental_stores
                - vocational_trade_schools
                - watch_jewelry_repair
                - welding_repair
                - wholesale_clubs
                - wig_and_toupee_stores
                - wires_money_orders
                - womens_accessory_and_specialty_shops
                - womens_ready_to_wear_stores
                - wrecking_and_salvage_yards
                maxLength: 5000
                type: string
              type: array
            blocked_categories:
              items:
                enum:
                - ac_refrigeration_repair
                - accounting_bookkeeping_services
                - advertising_services
                - agricultural_cooperative
                - airlines_air_carriers
                - airports_flying_fields
                - ambulance_services
                - amusement_parks_carnivals
                - antique_reproductions
                - antique_shops
                - aquariums
                - architectural_surveying_services
                - art_dealers_and_galleries
                - artists_supply_and_craft_shops
                - auto_and_home_supply_stores
                - auto_body_repair_shops
                - auto_paint_shops
                - auto_service_shops
                - automated_cash_disburse
                - automated_fuel_dispensers
                - automobile_associations
                - automotive_parts_and_accessories_stores
                - automotive_tire_stores
                - bail_and_bond_payments
                - bakeries
                - bands_orchestras
                - barber_and_beauty_shops
                - betting_casino_gambling
                - bicycle_shops
                - billiard_pool_establishments
                - boat_dealers
                - boat_rentals_and_leases
                - book_stores
                - books_periodicals_and_newspapers
                - bowling_alleys
                - bus_lines
                - business_secretarial_schools
                - buying_shopping_services
                - cable_satellite_and_other_pay_television_and_radio
                - camera_and_photographic_supply_stores
                - candy_nut_and_confectionery_stores
                - car_and_truck_dealers_new_used
                - car_and_truck_dealers_used_only
                - car_rental_agencies
                - car_washes
                - carpentry_services
                - carpet_upholstery_cleaning
                - caterers
                - charitable_and_social_service_organizations_fundraising
                - chemicals_and_allied_products
                - child_care_services
                - childrens_and_infants_wear_stores
                - chiropodists_podiatrists
                - chiropractors
                - cigar_stores_and_stands
                - civic_social_fraternal_associations
                - cleaning_and_maintenance
                - clothing_rental
                - colleges_universities
                - commercial_equipment
                - commercial_footwear
                - commercial_photography_art_and_graphics
                - commuter_transport_and_ferries
                - computer_network_services
                - computer_programming
                - computer_repair
                - computer_software_stores
                - computers_peripherals_and_software
                - concrete_work_services
                - construction_materials
                - consulting_public_relations
                - correspondence_schools
                - cosmetic_stores
                - counseling_services
                - country_clubs
                - courier_services
                - court_costs
                - credit_reporting_agencies
                - cruise_lines
                - dairy_products_stores
                - dance_hall_studios_schools
                - dating_escort_services
                - dentists_orthodontists
                - department_stores
                - detective_agencies
                - digital_goods_applications
                - digital_goods_games
                - digital_goods_large_volume
                - digital_goods_media
                - direct_marketing_catalog_merchant
                - direct_marketing_combination_catalog_and_retail_merchant
                - direct_marketing_inbound_telemarketing
                - direct_marketing_insurance_services
                - direct_marketing_other
                - direct_marketing_outbound_telemarketing
                - direct_marketing_subscription
                - direct_marketing_travel
                - discount_stores
                - doctors
                - door_to_door_sales
                - drapery_window_covering_and_upholstery_stores
                - drinking_places
                - drug_stores_and_pharmacies
                - drugs_drug_proprietaries_and_druggist_sundries
                - dry_cleaners
                - durable_goods
                - duty_free_stores
                - eating_places_restaurants
                - educational_services
                - electric_razor_stores
                - electric_vehicle_charging
                - electrical_parts_and_equipment
                - electrical_services
                - electronics_repair_shops
                - electronics_stores
                - elementary_secondary_schools
                - emergency_services_gcas_visa_use_only
                - employment_temp_agencies
                - equipment_rental
                - exterminating_services
                - family_clothing_stores
                - fast_food_restaurants
                - financial_institutions
                - fines_government_administrative_entities
                - fireplace_fireplace_screens_and_accessories_stores
                - floor_covering_stores
                - florists
                - florists_supplies_nursery_stock_and_flowers
                - freezer_and_locker_meat_provisioners
                - fuel_dealers_non_automotive
                - funeral_services_crematories
                - furniture_home_furnishings_and_equipment_stores_except_appliances
                - furniture_repair_refinishing
                - furriers_and_fur_shops
                - general_services
                - gift_card_novelty_and_souvenir_shops
                - glass_paint_and_wallpaper_stores
                - glassware_crystal_stores
                - golf_courses_public
                - government_licensed_horse_dog_racing_us_region_only
                - government_licensed_online_casions_online_gambling_us_region_only
                - government_owned_lotteries_non_us_region
                - government_owned_lotteries_us_region_only
                - government_services
                - grocery_stores_supermarkets
                - hardware_equipment_and_supplies
                - hardware_stores
                - health_and_beauty_spas
                - hearing_aids_sales_and_supplies
                - heating_plumbing_a_c
                - hobby_toy_and_game_shops
                - home_supply_warehouse_stores
                - hospitals
                - hotels_motels_and_resorts
                - household_appliance_stores
                - industrial_supplies
                - information_retrieval_services
                - insurance_default
                - insurance_underwriting_premiums
                - intra_company_purchases
                - jewelry_stores_watches_clocks_and_silverware_stores
                - landscaping_services
                - laundries
                - laundry_cleaning_services
                - legal_services_attorneys
                - luggage_and_leather_goods_stores
                - lumber_building_materials_stores
                - manual_cash_disburse
                - marinas_service_and_supplies
                - marketplaces
                - masonry_stonework_and_plaster
                - massage_parlors
                - medical_and_dental_labs
                - medical_dental_ophthalmic_and_hospital_equipment_and_supplies
                - medical_services
                - membership_organizations
                - mens_and_boys_clothing_and_accessories_stores
                - mens_womens_clothing_stores
                - metal_service_centers
                - miscellaneous
                - miscellaneous_apparel_and_accessory_shops
                - miscellaneous_auto_dealers
                - miscellaneous_business_services
                - miscellaneous_food_stores
                - miscellaneous_general_merchandise
                - miscellaneous_general_services
                - miscellaneous_home_furnishing_specialty_stores
                - miscellaneous_publishing_and_printing
                - miscellaneous_recreation_services
                - miscellaneous_repair_shops
                - miscellaneous_specialty_retail
                - mobile_home_dealers
                - motion_picture_theaters
                - motor_freight_carriers_and_trucking
                - motor_homes_dealers
                - motor_vehicle_supplies_and_new_parts
                - motorcycle_shops_and_dealers
                - motorcycle_shops_dealers
                - music_stores_musical_instruments_pianos_and_sheet_music
                - news_dealers_and_newsstands
                - non_fi_money_orders
                - non_fi_stored_value_card_purchase_load
                - nondurable_goods
                - nurseries_lawn_and_garden_supply_stores
                - nursing_personal_care
                - office_and_commercial_furniture
                - opticians_eyeglasses
                - optometrists_ophthalmologist
                - orthopedic_goods_prosthetic_devices
                - osteopaths
                - package_stores_beer_wine_and_liquor
                - paints_varnishes_and_supplies
                - parking_lots_garages
                - passenger_railways
                - pawn_shops
                - pet_shops_pet_food_and_supplies
                - petroleum_and_petroleum_products
                - photo_developing
                - photographic_photocopy_microfilm_equipment_and_supplies
                - photographic_studios
                - picture_video_production
                - piece_goods_notions_and_other_dry_goods
                - plumbing_heating_equipment_and_supplies
                - political_organizations
                - postal_services_government_only
                - precious_stones_and_metals_watches_and_jewelry
                - professional_services
                - public_warehousing_and_storage
                - quick_copy_repro_and_blueprint
                - railroads
                - real_estate_agents_and_managers_rentals
                - record_stores
                - recreational_vehicle_rentals
                - religious_goods_stores
                - religious_organizations
                - roofing_siding_sheet_metal
                - secretarial_support_services
                - security_brokers_dealers
                - service_stations
                - sewing_needlework_fabric_and_piece_goods_stores
                - shoe_repair_hat_cleaning
                - shoe_stores
                - small_appliance_repair
                - snowmobile_dealers
                - special_trade_services
                - specialty_cleaning
                - sporting_goods_stores
                - sporting_recreation_camps
                - sports_and_riding_apparel_stores
                - sports_clubs_fields
                - stamp_and_coin_stores
                - stationary_office_supplies_printing_and_writing_paper
                - stationery_stores_office_and_school_supply_stores
                - swimming_pools_sales
                - t_ui_travel_germany
                - tailors_alterations
                - tax_payments_government_agencies
                - tax_preparation_services
                - taxicabs_limousines
                - telecommunication_equipment_and_telephone_sales
                - telecommunication_services
                - telegraph_services
                - tent_and_awning_shops
                - testing_laboratories
                - theatrical_ticket_agencies
                - timeshares
                - tire_retreading_and_repair
                - tolls_bridge_fees
                - tourist_attractions_and_exhibits
                - towing_services
                - trailer_parks_campgrounds
                - transportation_services
                - travel_agencies_tour_operators
                - truck_stop_iteration
                - truck_utility_trailer_rentals
                - typesetting_plate_making_and_related_services
                - typewriter_stores
                - u_s_federal_government_agencies_or_departments
                - uniforms_commercial_clothing
                - used_merchandise_and_secondhand_stores
                - utilities
                - variety_stores
                - veterinary_services
                - video_amusement_game_supplies
                - video_game_arcades
                - video_tape_rental_stores
                - vocational_trade_schools
                - watch_jewelry_repair
                - welding_repair
                - wholesale_clubs
                - wig_and_toupee_stores
                - wires_money_orders
                - womens_accessory_and_specialty_shops
                - womens_ready_to_wear_stores
                - wrecking_and_salvage_yards
                maxLength: 5000
                type: string
              type: array
            spending_limits:
              items:
                properties:
                  amount:
                    type: integer
                  categories:
                    items:
                      enum:
                      - ac_refrigeration_repair
                      - accounting_bookkeeping_services
                      - advertising_services
                      - agricultural_cooperative
                      - airlines_air_carriers
                      - airports_flying_fields
                      - ambulance_services
                      - amusement_parks_carnivals
                      - antique_reproductions
                      - antique_shops
                      - aquariums
                      - architectural_surveying_services
                      - art_dealers_and_galleries
                      - artists_supply_and_craft_shops
                      - auto_and_home_supply_stores
                      - auto_body_repair_shops
                      - auto_paint_shops
                      - auto_service_shops
                      - automated_cash_disburse
                      - automated_fuel_dispensers
                      - automobile_associations
                      - automotive_parts_and_accessories_stores
                      - automotive_tire_stores
                      - bail_and_bond_payments
                      - bakeries
                      - bands_orchestras
                      - barber_and_beauty_shops
                      - betting_casino_gambling
                      - bicycle_shops
                      - billiard_pool_establishments
                      - boat_dealers
                      - boat_rentals_and_leases
                      - book_stores
                      - books_periodicals_and_newspapers
                      - bowling_alleys
                      - bus_lines
                      - business_secretarial_schools
                      - buying_shopping_services
                      - cable_satellite_and_other_pay_television_and_radio
                      - camera_and_photographic_supply_stores
                      - candy_nut_and_confectionery_stores
                      - car_and_truck_dealers_new_used
                      - car_and_truck_dealers_used_only
                      - car_rental_agencies
                      - car_washes
                      - carpentry_services
                      - carpet_upholstery_cleaning
                      - caterers
                      - charitable_and_social_service_organizations_fundraising
                      - chemicals_and_allied_products
                      - child_care_services
                      - childrens_and_infants_wear_stores
                      - chiropodists_podiatrists
                      - chiropractors
                      - cigar_stores_and_stands
                      - civic_social_fraternal_associations
                      - cleaning_and_maintenance
                      - clothing_rental
                      - colleges_universities
                      - commercial_equipment
                      - commercial_footwear
                      - commercial_photography_art_and_graphics
                      - commuter_transport_and_ferries
                      - computer_network_services
                      - computer_programming
                      - computer_repair
                      - computer_software_stores
                      - computers_peripherals_and_software
                      - concrete_work_services
                      - construction_materials
                      - consulting_public_relations
                      - correspondence_schools
                      - cosmetic_stores
                      - counseling_services
                      - country_clubs
                      - courier_services
                      - court_costs
                      - credit_reporting_agencies
                      - cruise_lines
                      - dairy_products_stores
                      - dance_hall_studios_schools
                      - dating_escort_services
                      - dentists_orthodontists
                      - department_stores
                      - detective_agencies
                      - digital_goods_applications
                      - digital_goods_games
                      - digital_goods_large_volume
                      - digital_goods_media
                      - direct_marketing_catalog_merchant
                      - direct_marketing_combination_catalog_and_retail_merchant
                      - direct_marketing_inbound_telemarketing
                      - direct_marketing_insurance_services
                      - direct_marketing_other
                      - direct_marketing_outbound_telemarketing
                      - direct_marketing_subscription
                      - direct_marketing_travel
                      - discount_stores
                      - doctors
                      - door_to_door_sales
                      - drapery_window_covering_and_upholstery_stores
                      - drinking_places
                      - drug_stores_and_pharmacies
                      - drugs_drug_proprietaries_and_druggist_sundries
                      - dry_cleaners
                      - durable_goods
                      - duty_free_stores
                      - eating_places_restaurants
                      - educational_services
                      - electric_razor_stores
                      - electric_vehicle_charging
                      - electrical_parts_and_equipment
                      - electrical_services
                      - electronics_repair_shops
                      - electronics_stores
                      - elementary_secondary_schools
                      - emergency_services_gcas_visa_use_only
                      - employment_temp_agencies
                      - equipment_rental
                      - exterminating_services
                      - family_clothing_stores
                      - fast_food_restaurants
                      - financial_institutions
                      - fines_government_administrative_entities
                      - fireplace_fireplace_screens_and_accessories_stores
                      - floor_covering_stores
                      - florists
                      - florists_supplies_nursery_stock_and_flowers
                      - freezer_and_locker_meat_provisioners
                      - fuel_dealers_non_automotive
                      - funeral_services_crematories
                      - furniture_home_furnishings_and_equipment_stores_except_appliances
                      - furniture_repair_refinishing
                      - furriers_and_fur_shops
                      - general_services
                      - gift_card_novelty_and_souvenir_shops
                      - glass_paint_and_wallpaper_stores
                      - glassware_crystal_stores
                      - golf_courses_public
                      - government_licensed_horse_dog_racing_us_region_only
                      - government_licensed_online_casions_online_gambling_us_region_only
                      - government_owned_lotteries_non_us_region
                      - government_owned_lotteries_us_region_only
                      - government_services
                      - grocery_stores_supermarkets
                      - hardware_equipment_and_supplies
                      - hardware_stores
                      - health_and_beauty_spas
                      - hearing_aids_sales_and_supplies
                      - heating_plumbing_a_c
                      - hobby_toy_and_game_shops
                      - home_supply_warehouse_stores
                      - hospitals
                      - hotels_motels_and_resorts
                      - household_appliance_stores
                      - industrial_supplies
                      - information_retrieval_services
                      - insurance_default
                      - insurance_underwriting_premiums
                      - intra_company_purchases
                      - jewelry_stores_watches_clocks_and_silverware_stores
                      - landscaping_services
                      - laundries
                      - laundry_cleaning_services
                      - legal_services_attorneys
                      - luggage_and_leather_goods_stores
                      - lumber_building_materials_stores
                      - manual_cash_disburse
                      - marinas_service_and_supplies
                      - marketplaces
                      - masonry_stonework_and_plaster
                      - massage_parlors
                      - medical_and_dental_labs
                      - medical_dental_ophthalmic_and_hospital_equipment_and_supplies
                      - medical_services
                      - membership_organizations
                      - mens_and_boys_clothing_and_accessories_stores
                      - mens_womens_clothing_stores
                      - metal_service_centers
                      - miscellaneous
                      - miscellaneous_apparel_and_accessory_shops
                      - miscellaneous_auto_dealers
                      - miscellaneous_business_services
                      - miscellaneous_food_stores
                      - miscellaneous_general_merchandise
                      - miscellaneous_general_services
                      - miscellaneous_home_furnishing_specialty_stores
                      - miscellaneous_publishing_and_printing
                      - miscellaneous_recreation_services
                      - miscellaneous_repair_shops
                      - miscellaneous_specialty_retail
                      - mobile_home_dealers
                      - motion_picture_theaters
                      - motor_freight_carriers_and_trucking
                      - motor_homes_dealers
                      - motor_vehicle_supplies_and_new_parts
                      - motorcycle_shops_and_dealers
                      - motorcycle_shops_dealers
                      - music_stores_musical_instruments_pianos_and_sheet_music
                      - news_dealers_and_newsstands
                      - non_fi_money_orders
                      - non_fi_stored_value_card_purchase_load
                      - nondurable_goods
                      - nurseries_lawn_and_garden_supply_stores
                      - nursing_personal_care
                      - office_and_commercial_furniture
                      - opticians_eyeglasses
                      - optometrists_ophthalmologist
                      - orthopedic_goods_prosthetic_devices
                      - osteopaths
                      - package_stores_beer_wine_and_liquor
                      - paints_varnishes_and_supplies
                      - parking_lots_garages
                      - passenger_railways
                      - pawn_shops
                      - pet_shops_pet_food_and_supplies
                      - petroleum_and_petroleum_products
                      - photo_developing
                      - photographic_photocopy_microfilm_equipment_and_supplies
                      - photographic_studios
                      - picture_video_production
                      - piece_goods_notions_and_other_dry_goods
                      - plumbing_heating_equipment_and_supplies
                      - political_organizations
                      - postal_services_government_only
                      - precious_stones_and_metals_watches_and_jewelry
                      - professional_services
                      - public_warehousing_and_storage
                      - quick_copy_repro_and_blueprint
                      - railroads
                      - real_estate_agents_and_managers_rentals
                      - record_stores
                      - recreational_vehicle_rentals
                      - religious_goods_stores
                      - religious_organizations
                      - roofing_siding_sheet_metal
                      - secretarial_support_services
                      - security_brokers_dealers
                      - service_stations
                      - sewing_needlework_fabric_and_piece_goods_stores
                      - shoe_repair_hat_cleaning
                      - shoe_stores
                      - small_appliance_repair
                      - snowmobile_dealers
                      - special_trade_services
                      - specialty_cleaning
                      - sporting_goods_stores
                      - sporting_recreation_camps
                      - sports_and_riding_apparel_stores
                      - sports_clubs_fields
                      - stamp_and_coin_stores
                      - stationary_office_supplies_printing_and_writing_paper
                      - stationery_stores_office_and_school_supply_stores
                      - swimming_pools_sales
                      - t_ui_travel_germany
                      - tailors_alterations
                      - tax_payments_government_agencies
                      - tax_preparation_services
                      - taxicabs_limousines
                      - telecommunication_equipment_and_telephone_sales
                      - telecommunication_services
                      - telegraph_services
                      - tent_and_awning_shops
                      - testing_laboratories
                      - theatrical_ticket_agencies
                      - timeshares
                      - tire_retreading_and_repair
                      - tolls_bridge_fees
                      - tourist_attractions_and_exhibits
                      - towing_services
                      - trailer_parks_campgrounds
                      - transportation_services
                      - travel_agencies_tour_operators
                      - truck_stop_iteration
                      - truck_utility_trailer_rentals
                      - typesetting_plate_making_and_related_services
                      - typewriter_stores
                      - u_s_federal_government_agencies_or_departments
                      - uniforms_commercial_clothing
                      - used_merchandise_and_secondhand_stores
                      - utilities
                      - variety_stores
                      - veterinary_services
                      - video_amusement_game_supplies
                      - video_game_arcades
                      - video_tape_rental_stores
                      - vocational_trade_schools
                      - watch_jewelry_repair
                      - welding_repair
                      - wholesale_clubs
                      - wig_and_toupee_stores
                      - wires_money_orders
                      - womens_accessory_and_specialty_shops
                      - womens_ready_to_wear_stores
                      - wrecking_and_salvage_yards
                      maxLength: 5000
                      type: string
                    type: array
                  interval:
                    enum:
                    - all_time
                    - daily
                    - monthly
                    - per_authorization
                    - weekly
                    - yearly
                    type: string
                required:
                - amount
                - interval
                title: spending_limits_param
                type: object
              type: array
            spending_limits_currency:
              type: string
          title: authorization_controls_param_v2
          type: object
        status:
          description: Specifies whether to permit authorizations on this cardholder's cards.
          enum:
          - active
          - inactive
          type: string
    PostDisputesDisputeRequest:
      type: object
      properties:
        evidence:
          description: Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.
          properties:
            access_activity_log:
              maxLength: 20000
              type: string
            billing_address:
              maxLength: 5000
              type: string
            cancellation_policy:
              type: string
            cancellation_policy_disclosure:
              maxLength: 20000
              type: string
            cancellation_rebuttal:
              maxLength: 20000
              type: string
            customer_communication:
              type: string
            customer_email_address:
              maxLength: 5000
              type: string
            customer_name:
              maxLength: 5000
              type: string
            customer_purchase_ip:
              maxLength: 5000
              type: string
            customer_signature:
              type: string
            duplicate_charge_documentation:
              type: string
            duplicate_charge_explanation:
              maxLength: 20000
              type: string
            duplicate_charge_id:
              maxLength: 5000
              type: string
            product_description:
              maxLength: 20000
              type: string
            receipt:
              type: string
            refund_policy:
              type: string
            refund_policy_disclosure:
              maxLength: 20000
              type: string
            refund_refusal_explanation:
              maxLength: 20000
              type: string
            service_date:
              maxLength: 5000
              type: string
            service_documentation:
              type: string
            shipping_address:
              maxLength: 5000
              type: string
            shipping_carrier:
              maxLength: 5000
              type: string
            shipping_date:
              maxLength: 5000
              type: string
            shipping_documentation:
              type: string
            shipping_tracking_number:
              maxLength: 5000
              type: string
            uncategorized_file:
              type: string
            uncategorized_text:
              maxLength: 20000
              type: string
          title: dispute_evidence_params
          type: object
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        submit:
          description: Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default).
          type: boolean
    PostBillingPortalConfigurationsRequest:
      type: object
      required:
      - business_profile
      - features
      properties:
        business_profile:
          description: The business information shown to customers in the portal.
          properties:
            headline:
              anyOf:
              - maxLength: 60
                type: string
              - enum:
                - ''
                type: string
            privacy_policy_url:
              type: string
            terms_of_service_url:
              type: string
          title: business_profile_create_param
          type: object
        default_return_url:
          anyOf:
          - type: string
          - enum:
            - ''
            type: string
          description: The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        features:
          description: Information about the features available in the portal.
          properties:
            customer_update:
              properties:
                allowed_updates:
                  anyOf:
                  - items:
                      enum:
                      - address
                      - email
                      - name
                      - phone
                      - shipping
                      - tax_id
                      type: string
                    type: array
                  - enum:
                    - ''
                    type: string
                enabled:
                  type: boolean
              required:
              - enabled
              title: customer_update_creation_param
              type: object
            invoice_history:
              properties:
                enabled:
                  type: boolean
              required:
              - enabled
              title: invoice_list_param
              type: object
            payment_method_update:
              properties:
                enabled:
                  type: boolean
              required:
              - enabled
              title: payment_method_update_param
              type: object
            subscription_cancel:
              properties:
                cancellation_reason:
                  properties:
                    enabled:
                      type: boolean
                    options:
                      anyOf:
                      - items:
                          enum:
                          - customer_service
                          - low_quality
                          - missing_features
                          - other
                          - switched_service
                          - too_complex
                          - too_expensive
                          - unused
                          type: string
                        type: array
                      - enum:
                        - ''
                        type: string
                  required:
                  - enabled
                  - options
                  title: subscription_cancellation_reason_creation_param
                  type: object
                enabled:
                  type: boolean
                mode:
                  enum:
                  - at_period_end
                  - immediately
                  type: string
                proration_behavior:
                  enum:
                  - always_invoice
                  - create_prorations
                  - none
                  type: string
              required:
              - enabled
              title: subscription_cancel_creation_param
              type: object
            subscription_pause:
              properties:
                enabled:
                  type: boolean
              title: subscription_pause_param
              type: object
            subscription_update:
              properties:
                default_allowed_updates:
                  anyOf:
                  - items:
                      enum:
                      - price
                      - promotion_code
                      - quantity
                      type: string
                    type: array
                  - enum:
                    - ''
                    type: string
                enabled:
                  type: boolean
                products:
                  anyOf:
                  - items:
                      properties:
                        prices:
                          items:
                            maxLength: 5000
                            type: string
                          type: array
                        product:
                          maxLength: 5000
                          type: string
                      required:
                      - prices
                      - product
                      title: subscription_update_product_param
                      type: object
                    type: array
                  - enum:
                    - ''
                    type: string
                proration_behavior:
                  enum:
                  - always_invoice
                  - create_prorations
                  - none
                  type: string
              required:
              - default_allowed_updates
              - enabled
              - products
              title: subscription_update_creation_param
              type: object
          title: features_creation_param
          type: object
        login_page:
          description: The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
          properties:
            enabled:
              type: boolean
          required:
          - enabled
          title: login_page_create_param
          type: object
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
    PostPaymentMethodsPaymentMethodRequest:
      type: object
      properties:
        billing_details:
          description: Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
          properties:
            address:
              anyOf:
              - properties:
                  city:
                    maxLength: 5000
                    type: string
                  country:
                    maxLength: 5000
                    type: string
                  line1:
                    maxLength: 5000
                    type: string
                  line2:
                    maxLength: 5000
                    type: string
                  postal_code:
                    maxLength: 5000
                    type: string
                  state:
                    maxLength: 5000
                    type: string
                title: billing_details_address
                type: object
              - enum:
                - ''
                type: string
            email:
              anyOf:
              - type: string
              - enum:
                - ''
                type: string
            name:
              anyOf:
              - maxLength: 5000
                type: string
              - enum:
                - ''
                type: string
            phone:
              anyOf:
              - maxLength: 5000
                type: string
              - enum:
                - ''
                type: string
          title: billing_details_inner_params
          type: object
        card:
          description: If this is a `card` PaymentMethod, this hash contains the user's card details.
          properties:
            exp_month:
              type: integer
            exp_year:
              type: integer
          title: update_api_param
          type: object
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        link:
          description: If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
          properties: {}
          title: param
          type: object
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        us_bank_account:
          description: If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
          properties:
            account_holder_type:
              enum:
              - company
              - individual
              type: string
          title: update_param
          type: object
    price:
      description: 'Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.

        [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.


        For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.


        Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).'
      properties:
        active:
          description: Whether the price can be used for new purchases.
          type: boolean
        billing_scheme:
          description: Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
          enum:
          - per_unit
          - tiered
          type: string
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: 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).
          type: string
        currency_options:
          additionalProperties:
            $ref: '#/components/schemas/currency_option'
          description: Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
          type: object
        custom_unit_amount:
          anyOf:
          - $ref: '#/components/schemas/custom_unit_amount'
          description: When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
          nullable: true
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        lookup_key:
          description: A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
          maxLength: 5000
          nullable: true
          type: string
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          type: object
        nickname:
          description: A brief description of the price, hidden from customers.
          maxLength: 5000
          nullable: true
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - price
          type: string
        product:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/product'
          - $ref: '#/components/schemas/deleted_product'
          description: The ID of the product this price is associated with.
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/product'
            - $ref: '#/components/schemas/deleted_product'
        recurring:
          anyOf:
          - $ref: '#/components/schemas/recurring'
          description: The recurring components of a price such as `interval` and `usage_type`.
          nullable: true
        tax_behavior:
          description: Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
          enum:
          - exclusive
          - inclusive
          - unspecified
          nullable: true
          type: string
        tiers:
          description: Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
          items:
            $ref: '#/components/schemas/price_tier'
          type: array
        tiers_mode:
          description: Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.
          enum:
          - graduated
          - volume
          nullable: true
          type: string
        transform_quantity:
          anyOf:
          - $ref: '#/components/schemas/transform_quantity'
          description: Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
          nullable: true
        type:
          description: One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
          enum:
          - one_time
          - recurring
          type: string
        unit_amount:
          description: The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.
          nullable: true
          type: integer
        unit_amount_decimal:
          description: The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.
          format: decimal
          nullable: true
          type: string
      required:
      - active
      - billing_scheme
      - created
      - currency
      - id
      - livemode
      - metadata
      - object
      - product
      - type
      title: Price
      type: object
      x-expandableFields:
      - currency_options
      - custom_unit_amount
      - product
      - recurring
      - tiers
      - transform_quantity
      x-resourceId: price
    customer:
      description: 'This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer.


        Related guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment)'
      properties:
        address:
          anyOf:
          - $ref: '#/components/schemas/address'
          description: The customer's address.
          nullable: true
        balance:
          description: The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize.
          type: integer
        cash_balance:
          anyOf:
          - $ref: '#/components/schemas/cash_balance'
          description: The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically.
          nullable: true
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.
          maxLength: 5000
          nullable: true
          type: string
        default_source:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/bank_account'
          - $ref: '#/components/schemas/card'
          - $ref: '#/components/schemas/source'
          description: 'ID of the default payment source for the customer.


            If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.'
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/bank_account'
            - $ref: '#/components/schemas/card'
            - $ref: '#/components/schemas/source'
          x-stripeBypassValidation: true
        delinquent:
          description: 'Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.


            If an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn''t reset to `false`.


            If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`.'
          nullable: true
          type: boolean
        description:
          description: An arbitrary string attached to the object. Often useful for displaying to users.
          maxLength: 5000
          nullable: true
          type: string
        discount:
          anyOf:
          - $ref: '#/components/schemas/discount'
          description: Describes the current discount active on the customer, if there is one.
          nullable: true
        email:
          description: The customer's email address.
          maxLength: 5000
          nullable: true
          type: string
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        invoice_credit_balance:
          additionalProperties:
            type: integer
          description: The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.
          type: object
        invoice_prefix:
          description: The prefix for the customer used to generate unique invoice numbers.
          maxLength: 5000
          nullable: true
          type: string
        invoice_settings:
          $ref: '#/components/schemas/invoice_setting_customer_setting'
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          type: object
        name:
          description: The customer's full name or business name.
          maxLength: 5000
          nullable: true
          type: string
        next_invoice_sequence:
          description: The suffix of the customer's next invoice number (for example, 0001).
          type: integer
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - customer
          type: string
        phone:
          description: The customer's phone number.
          maxLength: 5000
          nullable: true
          type: string
        preferred_locales:
          description: The customer's preferred locales (languages), ordered by preference.
          items:
            maxLength: 5000
            type: string
          nullable: true
          type: array
        shipping:
          anyOf:
          - $ref: '#/components/schemas/shipping'
          description: Mailing and shipping address for the customer. Appears on invoices emailed to this customer.
          nullable: true
        sources:
          description: The customer's payment sources, if any.
          properties:
            data:
              description: Details about each object.
              items:
                anyOf:
                - $ref: '#/components/schemas/bank_account'
                - $ref: '#/components/schemas/card'
                - $ref: '#/components/schemas/source'
                title: Polymorphic
                x-stripeBypassValidation: true
              type: array
            has_more:
              description: True if this list has another page of items after this one that can be fetched.
              type: boolean
            object:
              description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
              enum:
              - list
              type: string
            url:
              description: The URL where this list can be accessed.
              maxLength: 5000
              type: string
          required:
          - data
          - has_more
          - object
          - url
          title: ApmsSourcesSourceList
          type: object
          x-expandableFields:
          - data
        subscriptions:
          description: The customer's current subscriptions, if any.
          properties:
            data:
              description: Details about each object.
              items:
                $ref: '#/components/schemas/subscription'
              type: array
            has_more:
              description: True if this list has another page of items after this one that can be fetched.
              type: boolean
            object:
              description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
              enum:
              - list
              type: string
            url:
              description: The URL where this list can be accessed.
              maxLength: 5000
              type: string
          required:
          - data
          - has_more
          - object
          - url
          title: SubscriptionList
          type: object
          x-expandableFields:
          - data
        tax:
          $ref: '#/components/schemas/customer_tax'
        tax_exempt:
          description: 'Describes the customer''s tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**.'
          enum:
          - exempt
          - none
          - reverse
          nullable: true
          type: string
        tax_ids:
          description: The customer's tax IDs.
          properties:
            data:
              description: Details about each object.
              items:
                $ref: '#/components/schemas/tax_id'
              type: array
            has_more:
              description: True if this list has another page of items after this one that can be fetched.
              type: boolean
            object:
              description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
              enum:
              - list
              type: string
            url:
              description: The URL where this list can be accessed.
              maxLength: 5000
              type: string
          required:
          - data
          - has_more
          - object
          - url
          title: TaxIDsList
          type: object
          x-expandableFields:
          - data
        test_clock:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/test_helpers.test_clock'
          description: ID of the test clock that this customer belongs to.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/test_helpers.test_clock'
      required:
      - created
      - id
      - livemode
      - object
      title: Customer
      type: object
      x-expandableFields:
      - address
      - cash_balance
      - default_source
      - discount
      - invoice_settings
      - shipping
      - sources
      - subscriptions
      - tax
      - tax_ids
      - test_clock
      x-resourceId: customer
    PostIssuingDisputesDisputeSubmitRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
    PostBillingPortalSessionsRequest:
      type: object
      required:
      - customer
      properties:
        configuration:
          description: The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
          maxLength: 5000
          type: string
        customer:
          description: The ID of an existing customer.
          maxLength: 5000
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        flow_data:
          description: Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
          properties:
            after_completion:
              properties:
                hosted_confirmation:
                  properties:
                    custom_message:
                      maxLength: 500
                      type: string
                  title: after_completion_hosted_confirmation_param
                  type: object
                redirect:
                  properties:
                    return_url:
                      type: string
                  required:
                  - return_url
                  title: after_completion_redirect_param
                  type: object
                type:
                  enum:
                  - hosted_confirmation
                  - portal_homepage
                  - redirect
                  type: string
              required:
              - type
              title: flow_data_after_completion_param
              type: object
            subscription_cancel:
              properties:
                retention:
                  properties:
                    coupon_offer:
                      properties:
                        coupon:
                          maxLength: 5000
                          type: string
                      required:
                      - coupon
                      title: coupon_offer_param
                      type: object
                    type:
                      enum:
                      - coupon_offer
                      type: string
                  required:
                  - coupon_offer
                  - type
                  title: retention_param
                  type: object
                subscription:
                  maxLength: 5000
                  type: string
              required:
              - subscription
              title: flow_data_subscription_cancel_param
              type: object
            subscription_update:
              properties:
                subscription:
                  maxLength: 5000
                  type: string
              required:
              - subscription
              title: flow_data_subscription_update_param
              type: object
            subscription_update_confirm:
              properties:
                discounts:
                  items:
                    properties:
                      coupon:
                        maxLength: 5000
                        type: string
                      promotion_code:
                        maxLength: 5000
                        type: string
                    title: subscription_update_confirm_discount_params
                    type: object
                  type: array
                items:
                  items:
                    properties:
                      id:
                        maxLength: 5000
                        type: string
                      price:
                        maxLength: 5000
                        type: string
                      quantity:
                        type: integer
                    required:
                    - id
                    title: subscription_update_confirm_item_params
                    type: object
                  type: array
                subscription:
                  maxLength: 5000
                  type: string
              required:
              - items
              - subscription
              title: flow_data_subscription_update_confirm_param
              type: object
            type:
              enum:
              - payment_method_update
              - subscription_cancel
              - subscription_update
              - subscription_update_confirm
              type: string
          required:
          - type
          title: flow_data_param
          type: object
        locale:
          description: The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
          enum:
          - auto
          - bg
          - cs
          - da
          - de
          - el
          - en
          - en-AU
          - en-CA
          - en-GB
          - en-IE
          - en-IN
          - en-NZ
          - en-SG
          - 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
          type: string
        on_behalf_of:
          description: The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
          type: string
        return_url:
          description: The default URL to redirect customers to when they click on the portal's link to return to your website.
          type: string
    credit_note:
      description: 'Issue a credit note to adjust an invoice''s amount after the invoice is finalized.


        Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)'
      properties:
        amount:
          description: The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
          type: integer
        amount_shipping:
          description: This is the sum of all the shipping amounts.
          type: integer
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: 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).
          type: string
        customer:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/customer'
          - $ref: '#/components/schemas/deleted_customer'
          description: ID of the customer.
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/customer'
            - $ref: '#/components/schemas/deleted_customer'
        customer_balance_transaction:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/customer_balance_transaction'
          description: Customer balance transaction related to this credit note.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/customer_balance_transaction'
        discount_amount:
          description: The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
          type: integer
        discount_amounts:
          description: The aggregate amounts calculated per discount for all line items.
          items:
            $ref: '#/components/schemas/discounts_resource_discount_amount'
          type: array
        effective_at:
          description: The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
          format: unix-time
          nullable: true
          type: integer
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        invoice:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/invoice'
          description: ID of the invoice.
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/invoice'
        lines:
          description: Line items that make up the credit note
          properties:
            data:
              description: Details about each object.
              items:
                $ref: '#/components/schemas/credit_note_line_item'
              type: array
            has_more:
              description: True if this list has another page of items after this one that can be fetched.
              type: boolean
            object:
              description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
              enum:
              - list
              type: string
            url:
              description: The URL where this list can be accessed.
              maxLength: 5000
              type: string
          required:
          - data
          - has_more
          - object
          - url
          title: CreditNoteLinesList
          type: object
          x-expandableFields:
          - data
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        memo:
          description: Customer-facing text that appears on the credit note PDF.
          maxLength: 5000
          nullable: true
          type: string
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          nullable: true
          type: object
        number:
          description: A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
          maxLength: 5000
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - credit_note
          type: string
        out_of_band_amount:
          description: Amount that was credited outside of Stripe.
          nullable: true
          type: integer
        pdf:
          description: The link to download the PDF of the credit note.
          maxLength: 5000
          type: string
        reason:
          description: Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
          enum:
          - duplicate
          - fraudulent
          - order_change
          - product_unsatisfactory
          nullable: true
          type: string
        refund:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/refund'
          description: Refund related to this credit note.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/refund'
        shipping_cost:
          anyOf:
          - $ref: '#/components/schemas/invoices_shipping_cost'
          description: The details of the cost of shipping, including the ShippingRate applied to the invoice.
          nullable: true
        status:
          description: Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
          enum:
          - issued
          - void
          type: string
        subtotal:
          description: The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
          type: integer
        subtotal_excluding_tax:
          description: The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
          nullable: true
          type: integer
        tax_amounts:
          description: The aggregate amounts calculated per tax rate for all line items.
          items:
            $ref: '#/components/schemas/credit_note_tax_amount'
          type: array
        total:
          description: The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
          type: integer
        total_excluding_tax:
          description: The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
          nullable: true
          type: integer
        type:
          description: Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid.
          enum:
          - post_payment
          - pre_payment
          type: string
        voided_at:
          description: The time that the credit note was voided.
          format: unix-time
          nullable: true
          type: integer
      required:
      - amount
      - amount_shipping
      - created
      - currency
      - customer
      - discount_amount
      - discount_amounts
      - id
      - invoice
      - lines
      - livemode
      - number
      - object
      - pdf
      - status
      - subtotal
      - tax_amounts
      - total
      - type
      title: CreditNote
      type: object
      x-expandableFields:
      - customer
      - customer_balance_transaction
      - discount_amounts
      - invoice
      - lines
      - refund
      - shipping_cost
      - tax_amounts
      x-resourceId: credit_note
    PostFinancialConnectionsAccountsAccountDisconnectRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostLinkAccountSessionsRequest:
      type: object
      required:
      - account_holder
      - permissions
      properties:
        account_holder:
          description: The account holder to link accounts for.
          properties:
            account:
              maxLength: 5000
              type: string
            customer:
              maxLength: 5000
              type: string
            type:
              enum:
              - account
              - customer
              type: string
          required:
          - type
          title: accountholder_params
          type: object
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        filters:
          description: Filters to restrict the kinds of accounts to collect.
          properties:
            countries:
              items:
                maxLength: 5000
                type: string
              type: array
          required:
          - countries
          title: filters_params
          type: object
        permissions:
          description: 'List of data features that you would like to request access to.


            Possible values are `balances`, `transactions`, `ownership`, and `payment_method`.'
          items:
            enum:
            - balances
            - ownership
            - payment_method
            - transactions
            maxLength: 5000
            type: string
            x-stripeBypassValidation: true
          type: array
        prefetch:
          description: List of data features that you would like to retrieve upon account creation.
          items:
            enum:
            - balances
            - ownership
            - transactions
            type: string
            x-stripeBypassValidation: true
          type: array
        return_url:
          description: For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
          maxLength: 5000
          type: string
    PostIssuingTransactionsTransactionRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
    PostCustomersCustomerTaxIdsRequest:
      type: object
      required:
      - type
      - value
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        type:
          description: Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`
          enum:
          - ad_nrt
          - ae_trn
          - ar_cuit
          - au_abn
          - au_arn
          - bg_uic
          - bo_tin
          - br_cnpj
          - br_cpf
          - ca_bn
          - ca_gst_hst
          - ca_pst_bc
          - ca_pst_mb
          - ca_pst_sk
          - ca_qst
          - ch_vat
          - cl_tin
          - cn_tin
          - co_nit
          - cr_tin
          - do_rcn
          - ec_ruc
          - eg_tin
          - es_cif
          - eu_oss_vat
          - eu_vat
          - gb_vat
          - ge_vat
          - hk_br
          - hu_tin
          - id_npwp
          - il_vat
          - in_gst
          - is_vat
          - jp_cn
          - jp_rn
          - jp_trn
          - ke_pin
          - kr_brn
          - li_uid
          - mx_rfc
          - my_frp
          - my_itn
          - my_sst
          - no_vat
          - nz_gst
          - pe_ruc
          - ph_tin
          - ro_tin
          - rs_pib
          - ru_inn
          - ru_kpp
          - sa_vat
          - sg_gst
          - sg_uen
          - si_tin
          - sv_nit
          - th_vat
          - tr_tin
          - tw_vat
          - ua_vat
          - us_ein
          - uy_ruc
          - ve_rif
          - vn_tin
          - za_vat
          maxLength: 5000
          type: string
          x-stripeBypassValidation: true
        value:
          description: Value of the tax ID.
          type: string
    PostPayoutsPayoutRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
    PostPaymentMethodConfigurationsConfigurationRequest:
      type: object
      properties:
        acss_debit:
          description: Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        active:
          description: Whether the configuration can be used for new payments.
          type: boolean
        affirm:
          description: '[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.'
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        afterpay_clearpay:
          description: Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        alipay:
          description: Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        apple_pay:
          description: Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        apple_pay_later:
          description: Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        au_becs_debit:
          description: Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        bacs_debit:
          description: Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        bancontact:
          description: Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        blik:
          description: BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        boleto:
          description: Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        card:
          description: Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        cartes_bancaires:
          description: Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        cashapp:
          description: Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        eps:
          description: EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        fpx:
          description: Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        giropay:
          description: giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        google_pay:
          description: Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        grabpay:
          description: GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        ideal:
          description: iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        jcb:
          description: JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        klarna:
          description: Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        konbini:
          description: Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        link:
          description: '[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.'
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        name:
          description: Configuration name.
          maxLength: 100
          type: string
        oxxo:
          description: OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        p24:
          description: Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        paynow:
          description: PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        paypal:
          description: PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        promptpay:
          description: PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        revolut_pay:
          description: Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        sepa_debit:
          description: The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        sofort:
          description: Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        us_bank_account:
          description: Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
        wechat_pay:
          description: WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.
          properties:
            display_preference:
              properties:
                preference:
                  enum:
                  - none
                  - 'off'
                  - 'on'
                  type: string
              title: display_preference_param
              type: object
          title: payment_method_param
          type: object
    cash_balance:
      description: A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.
      properties:
        available:
          additionalProperties:
            type: integer
          description: A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
          nullable: true
          type: object
        customer:
          description: The ID of the customer whose cash balance this object represents.
          maxLength: 5000
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - cash_balance
          type: string
        settings:
          $ref: '#/components/schemas/customer_balance_customer_balance_settings'
      required:
      - customer
      - livemode
      - object
      - settings
      title: cash_balance
      type: object
      x-expandableFields:
      - settings
      x-resourceId: cash_balance
    PostLinkedAccountsAccountDisconnectRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostIssuingAuthorizationsAuthorizationApproveRequest:
      type: object
      properties:
        amount:
          description: If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request).
          type: integer
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
    PostCustomersCustomerBankAccountsIdRequest:
      type: object
      properties:
        account_holder_name:
          description: The name of the person or business that owns the bank account.
          maxLength: 5000
          type: string
        account_holder_type:
          description: The type of entity that holds the account. This can be either `individual` or `company`.
          enum:
          - company
          - individual
          maxLength: 5000
          type: string
        address_city:
          description: City/District/Suburb/Town/Village.
          maxLength: 5000
          type: string
        address_country:
          description: Billing address country, if provided when creating card.
          maxLength: 5000
          type: string
        address_line1:
          description: Address line 1 (Street address/PO Box/Company name).
          maxLength: 5000
          type: string
        address_line2:
          description: Address line 2 (Apartment/Suite/Unit/Building).
          maxLength: 5000
          type: string
        address_state:
          description: State/County/Province/Region.
          maxLength: 5000
          type: string
        address_zip:
          description: ZIP or postal code.
          maxLength: 5000
          type: string
        exp_month:
          description: Two digit number representing the card’s expiration month.
          maxLength: 5000
          type: string
        exp_year:
          description: Four digit number representing the card’s expiration year.
          maxLength: 5000
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        name:
          description: Cardholder name.
          maxLength: 5000
          type: string
        owner:
          properties:
            address:
              properties:
                city:
                  maxLength: 5000
                  type: string
                country:
                  maxLength: 5000
                  type: string
                line1:
                  maxLength: 5000
                  type: string
                line2:
                  maxLength: 5000
                  type: string
                postal_code:
                  maxLength: 5000
                  type: string
                state:
                  maxLength: 5000
                  type: string
              title: source_address
              type: object
            email:
              type: string
            name:
              maxLength: 5000
              type: string
            phone:
              maxLength: 5000
              type: string
          title: owner
          type: object
    PostCouponsRequest:
      type: object
      properties:
        amount_off:
          description: A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
          type: integer
        applies_to:
          description: A hash containing directions for what this Coupon will apply discounts to.
          properties:
            products:
              items:
                maxLength: 5000
                type: string
              type: array
          title: applies_to_params
          type: object
        currency:
          description: Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
          type: string
        currency_options:
          additionalProperties:
            properties:
              amount_off:
                type: integer
            required:
            - amount_off
            title: currency_option
            type: object
          description: Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
          type: object
        duration:
          description: Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
          enum:
          - forever
          - once
          - repeating
          type: string
          x-stripeBypassValidation: true
        duration_in_months:
          description: Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
          type: integer
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        id:
          description: Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.
          maxLength: 5000
          type: string
        max_redemptions:
          description: A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.
          type: integer
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        name:
          description: Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
          maxLength: 40
          type: string
        percent_off:
          description: A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
          type: number
        redeem_by:
          description: Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.
          format: unix-time
          type: integer
    identity.verification_report:
      description: 'A VerificationReport is the result of an attempt to collect and verify data from a user.

        The collection of verification checks performed is determined from the `type` and `options`

        parameters used. You can find the result of each verification check performed in the

        appropriate sub-resource: `document`, `id_number`, `selfie`.


        Each VerificationReport contains a copy of any data collected by the user as well as

        reference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)

        API. To configure and create VerificationReports, use the

        [VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.


        Related guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).'
      properties:
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        document:
          $ref: '#/components/schemas/gelato_document_report'
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        id_number:
          $ref: '#/components/schemas/gelato_id_number_report'
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - identity.verification_report
          type: string
        options:
          $ref: '#/components/schemas/gelato_verification_report_options'
        selfie:
          $ref: '#/components/schemas/gelato_selfie_report'
        type:
          description: Type of report.
          enum:
          - document
          - id_number
          type: string
          x-stripeBypassValidation: true
        verification_session:
          description: ID of the VerificationSession that created this report.
          maxLength: 5000
          nullable: true
          type: string
      required:
      - created
      - id
      - livemode
      - object
      title: GelatoVerificationReport
      type: object
      x-expandableFields:
      - document
      - id_number
      - options
      - selfie
      x-resourceId: identity.verification_report
    bank_account:
      description: 'These bank accounts are payment methods on `Customer` objects.


        On the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer

        destinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts).

        They can be bank accounts or debit cards as well, and are documented in the links above.


        Related guide: [Bank debits and transfers](https://stripe.com/docs/payments/bank-debits-transfers)'
      properties:
        account:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/account'
          description: The ID of the account that the bank account is associated with.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/account'
        account_holder_name:
          description: The name of the person or business that owns the bank account.
          maxLength: 5000
          nullable: true
          type: string
        account_holder_type:
          description: The type of entity that holds the account. This can be either `individual` or `company`.
          maxLength: 5000
          nullable: true
          type: string
        account_type:
          description: The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
          maxLength: 5000
          nullable: true
          type: string
        available_payout_methods:
          description: A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.
          items:
            enum:
            - instant
            - standard
            type: string
          nullable: true
          type: array
        bank_name:
          description: Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
          maxLength: 5000
          nullable: true
          type: string
        country:
          description: Two-letter ISO code representing the country the bank account is located in.
          maxLength: 5000
          type: string
        currency:
          description: Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
          type: string
        customer:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/customer'
          - $ref: '#/components/schemas/deleted_customer'
          description: The ID of the customer that the bank account is associated with.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/customer'
            - $ref: '#/components/schemas/deleted_customer'
        default_for_currency:
          description: Whether this bank account is the default external account for its currency.
          nullable: true
          type: boolean
        fingerprint:
          description: Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
          maxLength: 5000
          nullable: true
          type: string
        future_requirements:
          anyOf:
          - $ref: '#/components/schemas/external_account_requirements'
          description: Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
          nullable: true
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        last4:
          description: The last four digits of the bank account number.
          maxLength: 5000
          type: string
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          nullable: true
          type: object
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - bank_account
          type: string
        requirements:
          anyOf:
          - $ref: '#/components/schemas/external_account_requirements'
          description: Information about the requirements for the bank account, including what information needs to be collected.
          nullable: true
        routing_number:
          description: The routing transit number for the bank account.
          maxLength: 5000
          nullable: true
          type: string
        status:
          description: 'For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn''t had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we''ll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.


            For external accounts, possible values are `new`, `errored` and `verification_failed`. If a payouts fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In India, if we can''t [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we''ll set the status to `verification_failed`. Other validations aren''t run against external accounts because they''re only used for payouts. This means the other statuses don''t apply.'
          maxLength: 5000
          type: string
      required:
      - country
      - currency
      - id
      - last4
      - object
      - status
      title: BankAccount
      type: object
      x-expandableFields:
      - account
      - customer
      - future_requirements
      - requirements
      x-resourceId: bank_account
    PostPaymentIntentsIntentRequest:
      type: object
      properties:
        amount:
          description: Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
          type: integer
        application_fee_amount:
          anyOf:
          - type: integer
          - enum:
            - ''
            type: string
          description: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
        capture_method:
          description: Controls when the funds will be captured from the customer's account.
          enum:
          - automatic
          - automatic_async
          - manual
          type: string
        currency:
          description: 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).
          type: string
        customer:
          description: 'ID of the Customer this PaymentIntent belongs to, if one exists.


            Payment methods attached to other Customers cannot be used with this PaymentIntent.


            If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent''s payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.'
          maxLength: 5000
          type: string
        description:
          description: An arbitrary string attached to the object. Often useful for displaying to users.
          maxLength: 1000
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        payment_method:
          description: ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent.
          maxLength: 5000
          type: string
        payment_method_configuration:
          description: The ID of the payment method configuration to use with this PaymentIntent.
          maxLength: 100
          type: string
        payment_method_data:
          description: 'If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear

            in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)

            property on the PaymentIntent.'
          properties:
            acss_debit:
              properties:
                account_number:
                  maxLength: 5000
                  type: string
                institution_number:
                  maxLength: 5000
                  type: string
                transit_number:
                  maxLength: 5000
                  type: string
              required:
              - account_number
              - institution_number
              - transit_number
              title: payment_method_param
              type: object
            affirm:
              properties: {}
              title: param
              type: object
            afterpay_clearpay:
              properties: {}
              title: param
              type: object
            alipay:
              properties: {}
              title: param
              type: object
            au_becs_debit:
              properties:
                account_number:
                  maxLength: 5000
                  type: string
                bsb_number:
                  maxLength: 5000
                  type: string
              required:
              - account_number
              - bsb_number
              title: param
              type: object
            bacs_debit:
              properties:
                account_number:
                  maxLength: 5000
                  type: string
                sort_code:
                  maxLength: 5000
                  type: string
              title: param
              type: object
            bancontact:
              properties: {}
              title: param
              type: object
            billing_details:
              properties:
                address:
                  anyOf:
                  - properties:
                      city:
                        maxLength: 5000
                        type: string
                      country:
                        maxLength: 5000
                        type: string
                      line1:
                        maxLength: 5000
                        type: string
                      line2:
                        maxLength: 5000
                        type: string
                      postal_code:
                        maxLength: 5000
                        type: string
                      state:
                        maxLength: 5000
                        type: string
                    title: billing_details_address
                    type: object
                  - enum:
                    - ''
                    type: string
                email:
                  anyOf:
                  - type: string
                  - enum:
                    - ''
                    type: string
                name:
                  anyOf:
                  - maxLength: 5000
                    type: string
                  - enum:
                    - ''
                    type: string
                phone:
                  anyOf:
                  - maxLength: 5000
                    type: string
                  - enum:
                    - ''
                    type: string
              title: billing_details_inner_params
              type: object
            blik:
              properties: {}
              title: param
              type: object
            boleto:
              properties:
                tax_id:
                  maxLength: 5000
                  type: string
              required:
              - tax_id
              title: param
              type: object
            cashapp:
              properties: {}
              title: param
              type: object
            customer_balance:
              properties: {}
              title: param
              type: object
            eps:
              properties:
                bank:
                  enum:
                  - arzte_und_apotheker_bank
                  - austrian_anadi_bank_ag
                  - bank_austria
                  - bankhaus_carl_spangler
                  - bankhaus_schelhammer_und_schattera_ag
                  - bawag_psk_ag
                  - bks_bank_ag
                  - brull_kallmus_bank_ag
                  - btv_vier_lander_bank
                  - capital_bank_grawe_gruppe_ag
                  - deutsche_bank_ag
                  - dolomitenbank
                  - easybank_ag
                  - erste_bank_und_sparkassen
                  - hypo_alpeadriabank_international_ag
                  - hypo_bank_burgenland_aktiengesellschaft
                  - hypo_noe_lb_fur_niederosterreich_u_wien
                  - hypo_oberosterreich_salzburg_steiermark
                  - hypo_tirol_bank_ag
                  - hypo_vorarlberg_bank_ag
                  - marchfelder_bank
                  - oberbank_ag
                  - raiffeisen_bankengruppe_osterreich
                  - schoellerbank_ag
                  - sparda_bank_wien
                  - volksbank_gruppe
                  - volkskreditbank_ag
                  - vr_bank_braunau
                  maxLength: 5000
                  type: string
              title: param
              type: object
            fpx:
              properties:
                bank:
                  enum:
                  - affin_bank
                  - agrobank
                  - alliance_bank
                  - ambank
                  - bank_islam
                  - bank_muamalat
                  - bank_of_china
                  - bank_rakyat
                  - bsn
                  - cimb
                  - deutsche_bank
                  - hong_leong_bank
                  - hsbc
                  - kfh
                  - maybank2e
                  - maybank2u
                  - ocbc
                  - pb_enterprise
                  - public_bank
                  - rhb
                  - standard_chartered
                  - uob
                  maxLength: 5000
                  type: string
                  x-stripeBypassValidation: true
              required:
              - bank
              title: param
              type: object
            giropay:
              properties: {}
              title: param
              type: object
            grabpay:
              properties: {}
              title: param
              type: object
            ideal:
              properties:
                bank:
                  enum:
                  - abn_amro
                  - asn_bank
                  - bunq
                  - handelsbanken
                  - ing
                  - knab
                  - moneyou
                  - n26
                  - rabobank
                  - regiobank
                  - revolut
                  - sns_bank
                  - triodos_bank
                  - van_lanschot
                  - yoursafe
                  maxLength: 5000
                  type: string
              title: param
              type: object
            interac_present:
              properties: {}
              title: param
              type: object
            klarna:
              properties:
                dob:
                  properties:
                    day:
                      type: integer
                    month:
                      type: integer
                    year:
                      type: integer
                  required:
                  - day
                  - month
                  - year
                  title: date_of_birth
                  type: object
              title: param
              type: object
            konbini:
              properties: {}
              title: param
              type: object
            link:
              properties: {}
              title: param
              type: object
            metadata:
              additionalProperties:
                type: string
              type: object
            oxxo:
              properties: {}
              title: param
              type: object
            p24:
              properties:
                bank:
                  enum:
                  - alior_bank
                  - bank_millennium
                  - bank_nowy_bfg_sa
                  - bank_pekao_sa
                  - banki_spbdzielcze
                  - blik
                  - bnp_paribas
                  - boz
                  - citi_handlowy
                  - credit_agricole
                  - envelobank
                  - etransfer_pocztowy24
                  - getin_bank
                  - ideabank
                  - ing
                  - inteligo
                  - mbank_mtransfer
                  - nest_przelew
                  - noble_pay
                  - pbac_z_ipko
                  - plus_bank
                  - santander_przelew24
                  - tmobile_usbugi_bankowe
                  - toyota_bank
                  - volkswagen_bank
                  type: string
                  x-stripeBypassValidation: true
              title: param
              type: object
            paynow:
              properties: {}
              title: param
              type: object
            paypal:
              properties: {}
              title: param
              type: object
            pix:
              properties: {}
              title: param
              type: object
            promptpay:
              properties: {}
              title: param
              type: object
            radar_options:
              properties:
                session:
                  maxLength: 5000
                  type: string
              title: radar_options
              type: object
            revolut_pay:
              properties: {}
              title: param
              type: object
            sepa_debit:
              properties:
                iban:
                  maxLength: 5000
                  type: string
              required:
              - iban
              title: param
              type: object
            sofort:
              properties:
                country:
                  enum:
                  - AT
                  - BE
                  - DE
                  - ES
                  - IT
                  - NL
                  type: string
              required:
              - country
              title: param
              type: object
            type:
              enum:
              - acss_debit
              - affirm
              - afterpay_clearpay
              - alipay
              - au_becs_debit
              - bacs_debit
              - bancontact
              - blik
              - boleto
              - cashapp
              - customer_balance
              - eps
              - fpx
              - giropay
              - grabpay
              - ideal
              - klarna
              - konbini
              - link
              - oxxo
              - p24
              - paynow
              - paypal
              - pix
              - promptpay
              - revolut_pay
              - sepa_debit
              - sofort
              - us_bank_account
              - wechat_pay
              - zip
              type: string
              x-stripeBypassValidation: true
            us_bank_account:
              properties:
                account_holder_type:
                  enum:
                  - company
                  - individual
                  type: string
                account_number:
                  maxLength: 5000
                  type: string
                account_type:
                  enum:
                  - checking
                  - savings
                  type: string
                financial_connections_account:
                  maxLength: 5000
                  type: string
                routing_number:
                  maxLength: 5000
                  type: string
              title: payment_method_param
              type: object
            wechat_pay:
              properties: {}
              title: param
              type: object
            zip:
              properties: {}
              title: param
              type: object
          required:
          - type
          title: payment_method_data_params
          type: object
        payment_method_options:
          description: Payment-method-specific configuration for this PaymentIntent.
          properties:
            acss_debit:
              anyOf:
              - properties:
                  mandate_options:
                    properties:
                      custom_mandate_url:
                        anyOf:
                        - type: string
                        - enum:
                          - ''
                          type: string
                      interval_description:
                        maxLength: 500
                        type: string
                      payment_schedule:
                        enum:
                        - combined
                        - interval
                        - sporadic
                        type: string
                      transaction_type:
                        enum:
                        - business
                        - personal
                        type: string
                    title: payment_intent_payment_method_options_mandate_options_param
                    type: object
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                  verification_method:
                    enum:
                    - automatic
                    - instant
                    - microdeposits
                    type: string
                    x-stripeBypassValidation: true
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            affirm:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  preferred_locale:
                    maxLength: 30
                    type: string
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            afterpay_clearpay:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  reference:
                    maxLength: 128
                    type: string
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                    x-stripeBypassValidation: true
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            alipay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            au_becs_debit:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            bacs_debit:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            bancontact:
              anyOf:
              - properties:
                  preferred_language:
                    enum:
                    - de
                    - en
                    - fr
                    - nl
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            blik:
              anyOf:
              - properties:
                  code:
                    maxLength: 5000
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            boleto:
              anyOf:
              - properties:
                  expires_after_days:
                    type: integer
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            card:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  cvc_token:
                    maxLength: 5000
                    type: string
                  installments:
                    properties:
                      enabled:
                        type: boolean
                      plan:
                        anyOf:
                        - properties:
                            count:
                              type: integer
                            interval:
                              enum:
                              - month
                              type: string
                            type:
                              enum:
                              - fixed_count
                              type: string
                          required:
                          - count
                          - interval
                          - type
                          title: installment_plan
                          type: object
                        - enum:
                          - ''
                          type: string
                    title: installments_param
                    type: object
                  mandate_options:
                    properties:
                      amount:
                        type: integer
                      amount_type:
                        enum:
                        - fixed
                        - maximum
                        type: string
                      description:
                        maxLength: 200
                        type: string
                      end_date:
                        format: unix-time
                        type: integer
                      interval:
                        enum:
                        - day
                        - month
                        - sporadic
                        - week
                        - year
                        type: string
                      interval_count:
                        type: integer
                      reference:
                        maxLength: 80
                        type: string
                      start_date:
                        format: unix-time
                        type: integer
                      supported_types:
                        items:
                          enum:
                          - india
                          type: string
                        type: array
                    required:
                    - amount
                    - amount_type
                    - interval
                    - reference
                    - start_date
                    title: mandate_options_param
                    type: object
                  network:
                    enum:
                    - amex
                    - cartes_bancaires
                    - diners
                    - discover
                    - eftpos_au
                    - interac
                    - jcb
                    - mastercard
                    - unionpay
                    - unknown
                    - visa
                    maxLength: 5000
                    type: string
                    x-stripeBypassValidation: true
                  request_extended_authorization:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_incremental_authorization:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_multicapture:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_overcapture:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_three_d_secure:
                    enum:
                    - any
                    - automatic
                    - challenge
                    type: string
                    x-stripeBypassValidation: true
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                  statement_descriptor_suffix_kana:
                    anyOf:
                    - maxLength: 22
                      type: string
                    - enum:
                      - ''
                      type: string
                  statement_descriptor_suffix_kanji:
                    anyOf:
                    - maxLength: 17
                      type: string
                    - enum:
                      - ''
                      type: string
                  three_d_secure:
                    properties:
                      ares_trans_status:
                        enum:
                        - A
                        - C
                        - I
                        - N
                        - R
                        - U
                        - Y
                        type: string
                      cryptogram:
                        maxLength: 5000
                        type: string
                      electronic_commerce_indicator:
                        enum:
                        - '01'
                        - '02'
                        - '05'
                        - '06'
                        - '07'
                        type: string
                        x-stripeBypassValidation: true
                      exemption_indicator:
                        enum:
                        - low_risk
                        - none
                        type: string
                      network_options:
                        properties:
                          cartes_bancaires:
                            properties:
                              cb_avalgo:
                                enum:
                                - '0'
                                - '1'
                                - '2'
                                - '3'
                                - '4'
                                - A
                                type: string
                              cb_exemption:
                                maxLength: 4
                                type: string
                              cb_score:
                                type: integer
                            required:
                            - cb_avalgo
                            title: cartes_bancaires_network_options_param
                            type: object
                        title: network_options_param
                        type: object
                      requestor_challenge_indicator:
                        maxLength: 2
                        type: string
                      transaction_id:
                        maxLength: 5000
                        type: string
                      version:
                        enum:
                        - 1.0.2
                        - 2.1.0
                        - 2.2.0
                        type: string
                        x-stripeBypassValidation: true
                    required:
                    - cryptogram
                    - transaction_id
                    - version
                    title: payment_method_options_param
                    type: object
                title: payment_intent_param
                type: object
              - enum:
                - ''
                type: string
            card_present:
              anyOf:
              - properties:
                  request_extended_authorization:
                    type: boolean
                  request_incremental_authorization_support:
                    type: boolean
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            cashapp:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            customer_balance:
              anyOf:
              - properties:
                  bank_transfer:
                    properties:
                      eu_bank_transfer:
                        properties:
                          country:
                            maxLength: 5000
                            type: string
                        required:
                        - country
                        title: eu_bank_transfer_params
                        type: object
                      requested_address_types:
                        items:
                          enum:
                          - aba
                          - iban
                          - sepa
                          - sort_code
                          - spei
                          - swift
                          - zengin
                          type: string
                          x-stripeBypassValidation: true
                        type: array
                      type:
                        enum:
                        - eu_bank_transfer
                        - gb_bank_transfer
                        - jp_bank_transfer
                        - mx_bank_transfer
                        - us_bank_transfer
                        type: string
                        x-stripeBypassValidation: true
                    required:
                    - type
                    title: bank_transfer_param
                    type: object
                  funding_type:
                    enum:
                    - bank_transfer
                    type: string
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            eps:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            fpx:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            giropay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            grabpay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            ideal:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            interac_present:
              anyOf:
              - properties: {}
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            klarna:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  preferred_locale:
                    enum:
                    - cs-CZ
                    - da-DK
                    - de-AT
                    - de-CH
                    - de-DE
                    - el-GR
                    - en-AT
                    - en-AU
                    - en-BE
                    - en-CA
                    - en-CH
                    - en-CZ
                    - en-DE
                    - en-DK
                    - en-ES
                    - en-FI
                    - en-FR
                    - en-GB
                    - en-GR
                    - en-IE
                    - en-IT
                    - en-NL
                    - en-NO
                    - en-NZ
                    - en-PL
                    - en-PT
                    - en-SE
                    - en-US
                    - es-ES
                    - es-US
                    - fi-FI
                    - fr-BE
                    - fr-CA
                    - fr-CH
                    - fr-FR
                    - it-CH
                    - it-IT
                    - nb-NO
                    - nl-BE
                    - nl-NL
                    - pl-PL
                    - pt-PT
                    - sv-FI
                    - sv-SE
                    type: string
                    x-stripeBypassValidation: true
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                    x-stripeBypassValidation: true
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            konbini:
              anyOf:
              - properties:
                  confirmation_number:
                    anyOf:
                    - maxLength: 11
                      type: string
                    - enum:
                      - ''
                      type: string
                  expires_after_days:
                    anyOf:
                    - type: integer
                    - enum:
                      - ''
                      type: string
                  expires_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                  product_description:
                    anyOf:
                    - maxLength: 22
                      type: string
                    - enum:
                      - ''
                      type: string
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            link:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            oxxo:
              anyOf:
              - properties:
                  expires_after_days:
                    type: integer
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            p24:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                  tos_shown_and_accepted:
                    type: boolean
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            paynow:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            paypal:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  preferred_locale:
                    enum:
                    - 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
                    type: string
                    x-stripeBypassValidation: true
                  reference:
                    maxLength: 127
                    type: string
                  risk_correlation_id:
                    maxLength: 32
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            pix:
              anyOf:
              - properties:
                  expires_after_seconds:
                    type: integer
                  expires_at:
                    format: unix-time
                    type: integer
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            promptpay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            revolut_pay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            sepa_debit:
              anyOf:
              - properties:
                  mandate_options:
                    properties: {}
                    title: payment_method_options_mandate_options_param
                    type: object
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            sofort:
              anyOf:
              - properties:
                  preferred_language:
                    enum:
                    - ''
                    - de
                    - en
                    - es
                    - fr
                    - it
                    - nl
                    - pl
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            us_bank_account:
              anyOf:
              - properties:
                  financial_connections:
                    properties:
                      permissions:
                        items:
                          enum:
                          - balances
                          - ownership
                          - payment_method
                          - transactions
                          maxLength: 5000
                          type: string
                          x-stripeBypassValidation: true
                        type: array
                      prefetch:
                        items:
                          enum:
                          - balances
                          - transactions
                          type: string
                          x-stripeBypassValidation: true
                        type: array
                      return_url:
                        maxLength: 5000
                        type: string
                    title: linked_account_options_param
                    type: object
                  mandate_options:
                    properties:
                      collection_method:
                        enum:
                        - ''
                        - paper
                        type: string
                        x-stripeBypassValidation: true
                    title: mandate_options_param
                    type: object
                  networks:
                    properties:
                      requested:
                        items:
                          enum:
                          - ach
                          - us_domestic_wire
                          type: string
                        type: array
                    title: networks_options_param
                    type: object
                  preferred_settlement_speed:
                    enum:
                    - ''
                    - fastest
                    - standard
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                  verification_method:
                    enum:
                    - automatic
                    - instant
                    - microdeposits
                    type: string
                    x-stripeBypassValidation: true
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            wechat_pay:
              anyOf:
              - properties:
                  app_id:
                    maxLength: 5000
                    type: string
                  client:
                    enum:
                    - android
                    - ios
                    - web
                    type: string
                    x-stripeBypassValidation: true
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                required:
                - client
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            zip:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
          title: payment_method_options_param
          type: object
        payment_method_types:
          description: The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
          items:
            maxLength: 5000
            type: string
          type: array
        receipt_email:
          anyOf:
          - type: string
          - enum:
            - ''
            type: string
          description: Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
        setup_future_usage:
          description: 'Indicates that you intend to make future payments with this PaymentIntent''s payment method.


            Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent''s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.


            When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).


            If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.'
          enum:
          - ''
          - off_session
          - on_session
          type: string
        shipping:
          anyOf:
          - properties:
              address:
                properties:
                  city:
                    maxLength: 5000
                    type: string
                  country:
                    maxLength: 5000
                    type: string
                  line1:
                    maxLength: 5000
                    type: string
                  line2:
                    maxLength: 5000
                    type: string
                  postal_code:
                    maxLength: 5000
                    type: string
                  state:
                    maxLength: 5000
                    type: string
                title: optional_fields_address
                type: object
              carrier:
                maxLength: 5000
                type: string
              name:
                maxLength: 5000
                type: string
              phone:
                maxLength: 5000
                type: string
              tracking_number:
                maxLength: 5000
                type: string
            required:
            - address
            - name
            title: optional_fields_shipping
            type: object
          - enum:
            - ''
            type: string
          description: Shipping information for this PaymentIntent.
        statement_descriptor:
          description: For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.
          maxLength: 22
          type: string
        statement_descriptor_suffix:
          description: Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
          maxLength: 22
          type: string
        transfer_data:
          description: Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
          properties:
            amount:
              type: integer
          title: transfer_data_update_params
          type: object
        transfer_group:
          description: A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
          type: string
    PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequest:
      type: object
      properties:
        add_invoice_items:
          description: A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
          items:
            properties:
              price:
                maxLength: 5000
                type: string
              price_data:
                properties:
                  currency:
                    type: string
                  product:
                    maxLength: 5000
                    type: string
                  tax_behavior:
                    enum:
                    - exclusive
                    - inclusive
                    - unspecified
                    type: string
                  unit_amount:
                    type: integer
                  unit_amount_decimal:
                    format: decimal
                    type: string
                required:
                - currency
                - product
                title: one_time_price_data_with_negative_amounts
                type: object
              quantity:
                type: integer
              tax_rates:
                anyOf:
                - items:
                    maxLength: 5000
                    type: string
                  type: array
                - enum:
                  - ''
                  type: string
            title: add_invoice_item_entry
            type: object
          type: array
        application_fee_percent:
          description: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
          type: number
        automatic_tax:
          description: Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
          properties:
            enabled:
              type: boolean
          required:
          - enabled
          title: automatic_tax_config
          type: object
        billing_cycle_anchor:
          description: Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
          enum:
          - now
          - unchanged
          maxLength: 5000
          type: string
          x-stripeBypassValidation: true
        billing_thresholds:
          anyOf:
          - properties:
              amount_gte:
                type: integer
              reset_billing_cycle_anchor:
                type: boolean
            title: billing_thresholds_param
            type: object
          - enum:
            - ''
            type: string
          description: Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
        cancel_at:
          anyOf:
          - format: unix-time
            type: integer
          - enum:
            - ''
            type: string
          description: A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
        cancel_at_period_end:
          description: Boolean indicating whether this subscription should cancel at the end of the current period.
          type: boolean
        cancellation_details:
          description: Details about why this subscription was cancelled
          properties:
            comment:
              anyOf:
              - maxLength: 5000
                type: string
              - enum:
                - ''
                type: string
            feedback:
              enum:
              - ''
              - customer_service
              - low_quality
              - missing_features
              - other
              - switched_service
              - too_complex
              - too_expensive
              - unused
              type: string
          title: cancellation_details_param
          type: object
        collection_method:
          description: Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
          enum:
          - charge_automatically
          - send_invoice
          type: string
        coupon:
          description: The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.
          maxLength: 5000
          type: string
        days_until_due:
          description: Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
          type: integer
        default_payment_method:
          description: ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
          maxLength: 5000
          type: string
        default_source:
          anyOf:
          - maxLength: 5000
            type: string
          - enum:
            - ''
            type: string
          description: ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
        default_tax_rates:
          anyOf:
          - items:
              maxLength: 5000
              type: string
            type: array
          - enum:
            - ''
            type: string
          description: 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. Pass an empty string to remove previously-defined tax rates.
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        items:
          description: A list of up to 20 subscription items, each with an attached price.
          items:
            properties:
              billing_thresholds:
                anyOf:
                - properties:
                    usage_gte:
                      type: integer
                  required:
                  - usage_gte
                  title: item_billing_thresholds_param
                  type: object
                - enum:
                  - ''
                  type: string
              clear_usage:
                type: boolean
              deleted:
                type: boolean
              id:
                maxLength: 5000
                type: string
              metadata:
                anyOf:
                - additionalProperties:
                    type: string
                  type: object
                - enum:
                  - ''
                  type: string
              price:
                maxLength: 5000
                type: string
              price_data:
                properties:
                  currency:
                    type: string
                  product:
                    maxLength: 5000
                    type: string
                  recurring:
                    properties:
                      interval:
                        enum:
                        - day
                        - month
                        - week
                        - year
                        type: string
                      interval_count:
                        type: integer
                    required:
                    - interval
                    title: recurring_adhoc
                    type: object
                  tax_behavior:
                    enum:
                    - exclusive
                    - inclusive
                    - unspecified
                    type: string
                  unit_amount:
                    type: integer
                  unit_amount_decimal:
                    format: decimal
                    type: string
                required:
                - currency
                - product
                - recurring
                title: recurring_price_data
                type: object
              quantity:
                type: integer
              tax_rates:
                anyOf:
                - items:
                    maxLength: 5000
                    type: string
                  type: array
                - enum:
                  - ''
                  type: string
            title: subscription_item_update_params
            type: object
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        off_session:
          description: Indicates if a customer is on or off-session while an invoice payment is attempted.
          type: boolean
        pause_collection:
          anyOf:
          - properties:
              behavior:
                enum:
                - keep_as_draft
                - mark_uncollectible
                - void
                type: string
              resumes_at:
                format: unix-time
                type: integer
            required:
            - behavior
            title: pause_collection_param
            type: object
          - enum:
            - ''
            type: string
          description: If specified, payment collection for this subscription will be paused.
        payment_behavior:
          description: 'Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription''s invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.


            Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice''s payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.


            Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).


            Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription''s invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.'
          enum:
          - allow_incomplete
          - default_incomplete
          - error_if_incomplete
          - pending_if_incomplete
          type: string
        payment_settings:
          description: Payment settings to pass to invoices created by the subscription.
          properties:
            payment_method_options:
              properties:
                acss_debit:
                  anyOf:
                  - properties:
                      mandate_options:
                        properties:
                          transaction_type:
                            enum:
                            - business
                            - personal
                            type: string
                        title: mandate_options_param
                        type: object
                      verification_method:
                        enum:
                        - automatic
                        - instant
                        - microdeposits
                        type: string
                        x-stripeBypassValidation: true
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                bancontact:
                  anyOf:
                  - properties:
                      preferred_language:
                        enum:
                        - de
                        - en
                        - fr
                        - nl
                        type: string
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                card:
                  anyOf:
                  - properties:
                      mandate_options:
                        properties:
                          amount:
                            type: integer
                          amount_type:
                            enum:
                            - fixed
                            - maximum
                            type: string
                          description:
                            maxLength: 200
                            type: string
                        title: mandate_options_param
                        type: object
                      network:
                        enum:
                        - amex
                        - cartes_bancaires
                        - diners
                        - discover
                        - eftpos_au
                        - interac
                        - jcb
                        - mastercard
                        - unionpay
                        - unknown
                        - visa
                        maxLength: 5000
                        type: string
                        x-stripeBypassValidation: true
                      request_three_d_secure:
                        enum:
                        - any
                        - automatic
                        type: string
                    title: subscription_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                customer_balance:
                  anyOf:
                  - properties:
                      bank_transfer:
                        properties:
                          eu_bank_transfer:
                            properties:
                              country:
                                maxLength: 5000
                                type: string
                            required:
                            - country
                            title: eu_bank_transfer_param
                            type: object
                          type:
                            type: string
                        title: bank_transfer_param
                        type: object
                      funding_type:
                        type: string
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                konbini:
                  anyOf:
                  - properties: {}
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                us_bank_account:
                  anyOf:
                  - properties:
                      financial_connections:
                        properties:
                          permissions:
                            items:
                              enum:
                              - balances
                              - ownership
                              - payment_method
                              - transactions
                              maxLength: 5000
                              type: string
                              x-stripeBypassValidation: true
                            type: array
                          prefetch:
                            items:
                              enum:
                              - balances
                              - transactions
                              type: string
                              x-stripeBypassValidation: true
                            type: array
                        title: invoice_linked_account_options_param
                        type: object
                      verification_method:
                        enum:
                        - automatic
                        - instant
                        - microdeposits
                        type: string
                        x-stripeBypassValidation: true
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
              title: payment_method_options
              type: object
            payment_method_types:
              anyOf:
              - items:
                  enum:
                  - ach_credit_transfer
                  - ach_debit
                  - acss_debit
                  - au_becs_debit
                  - bacs_debit
                  - bancontact
                  - boleto
                  - card
                  - cashapp
                  - customer_balance
                  - fpx
                  - giropay
                  - grabpay
                  - ideal
                  - konbini
                  - link
                  - paynow
                  - paypal
                  - promptpay
                  - sepa_debit
                  - sofort
                  - us_bank_account
                  - wechat_pay
                  type: string
                  x-stripeBypassValidation: true
                type: array
              - enum:
                - ''
                type: string
            save_default_payment_method:
              enum:
              - 'off'
              - on_subscription
              type: string
          title: payment_settings
          type: object
        pending_invoice_item_interval:
          anyOf:
          - properties:
              interval:
                enum:
                - day
                - month
                - week
                - year
                type: string
              interval_count:
                type: integer
            required:
            - interval
            title: pending_invoice_item_interval_params
            type: object
          - enum:
            - ''
            type: string
          description: Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
        promotion_code:
          description: The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.
          maxLength: 5000
          type: string
        proration_behavior:
          description: Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
          enum:
          - always_invoice
          - create_prorations
          - none
          type: string
        proration_date:
          description: 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](https://stripe.com/docs/api#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.
          format: unix-time
          type: integer
        transfer_data:
          anyOf:
          - properties:
              amount_percent:
                type: number
              destination:
                type: string
            required:
            - destination
            title: transfer_data_specs
            type: object
          - enum:
            - ''
            type: string
          description: 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. This will be unset if you POST an empty value.
        trial_end:
          anyOf:
          - enum:
            - now
            maxLength: 5000
            type: string
          - format: unix-time
            type: integer
          description: Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
        trial_from_plan:
          description: Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
          type: boolean
        trial_settings:
          description: Settings related to subscription trials.
          properties:
            end_behavior:
              properties:
                missing_payment_method:
                  enum:
                  - cancel
                  - create_invoice
                  - pause
                  type: string
              required:
              - missing_payment_method
              title: end_behavior
              type: object
          required:
          - end_behavior
          title: trial_settings_config
          type: object
    PostInvoicesInvoicePayRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        forgive:
          description: "In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. \n\nPassing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`."
          type: boolean
        mandate:
          anyOf:
          - maxLength: 5000
            type: string
          - enum:
            - ''
            type: string
          description: ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set.
        off_session:
          description: Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session).
          type: boolean
        paid_out_of_band:
          description: Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`.
          type: boolean
        payment_method:
          description: A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.
          maxLength: 5000
          type: string
        source:
          description: A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.
          maxLength: 5000
          type: string
    issuing.card:
      description: You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders.
      properties:
        brand:
          description: The brand of the card.
          maxLength: 5000
          type: string
        cancellation_reason:
          description: The reason why the card was canceled.
          enum:
          - design_rejected
          - lost
          - stolen
          nullable: true
          type: string
          x-stripeBypassValidation: true
        cardholder:
          $ref: '#/components/schemas/issuing.cardholder'
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK.
          type: string
        cvc:
          description: The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint.
          maxLength: 5000
          type: string
        exp_month:
          description: The expiration month of the card.
          type: integer
        exp_year:
          description: The expiration year of the card.
          type: integer
        financial_account:
          description: The financial account this card is attached to.
          maxLength: 5000
          nullable: true
          type: string
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        last4:
          description: The last 4 digits of the card number.
          maxLength: 5000
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          type: object
        number:
          description: The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint.
          maxLength: 5000
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - issuing.card
          type: string
        replaced_by:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/issuing.card'
          description: The latest card that replaces this card, if any.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/issuing.card'
        replacement_for:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/issuing.card'
          description: The card this card replaces, if any.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/issuing.card'
        replacement_reason:
          description: The reason why the previous card needed to be replaced.
          enum:
          - damaged
          - expired
          - lost
          - stolen
          nullable: true
          type: string
          x-stripeBypassValidation: true
        shipping:
          anyOf:
          - $ref: '#/components/schemas/issuing_card_shipping'
          description: Where and how the card will be shipped.
          nullable: true
        spending_controls:
          $ref: '#/components/schemas/issuing_card_authorization_controls'
        status:
          description: Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.
          enum:
          - active
          - canceled
          - inactive
          type: string
          x-stripeBypassValidation: true
        type:
          description: The type of the card.
          enum:
          - physical
          - virtual
          type: string
        wallets:
          anyOf:
          - $ref: '#/components/schemas/issuing_card_wallets'
          description: Information relating to digital wallets (like Apple Pay and Google Pay).
          nullable: true
      required:
      - brand
      - cardholder
      - created
      - currency
      - exp_month
      - exp_year
      - id
      - last4
      - livemode
      - metadata
      - object
      - spending_controls
      - status
      - type
      title: IssuingCard
      type: object
      x-expandableFields:
      - cardholder
      - replaced_by
      - replacement_for
      - shipping
      - spending_controls
      - wallets
      x-resourceId: issuing.card
    PostPaymentMethodDomainsPaymentMethodDomainValidateRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostIssuingAuthorizationsAuthorizationRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
    PostPlansRequest:
      type: object
      required:
      - currency
      - interval
      properties:
        active:
          description: Whether the plan is currently available for new subscriptions. Defaults to `true`.
          type: boolean
        aggregate_usage:
          description: Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.
          enum:
          - last_during_period
          - last_ever
          - max
          - sum
          type: string
        amount:
          description: A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis.
          type: integer
        amount_decimal:
          description: Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set.
          format: decimal
          type: string
        billing_scheme:
          description: Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
          enum:
          - per_unit
          - tiered
          type: string
        currency:
          description: 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).
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        id:
          description: An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.
          maxLength: 5000
          type: string
        interval:
          description: Specifies billing frequency. Either `day`, `week`, `month` or `year`.
          enum:
          - day
          - month
          - week
          - year
          type: string
        interval_count:
          description: The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
          type: integer
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        nickname:
          description: A brief description of the plan, hidden from customers.
          maxLength: 5000
          type: string
        product:
          anyOf:
          - description: The product whose pricing the created plan will represent. This can either be the ID of an existing product, or a dictionary containing fields used to create a [service product](https://stripe.com/docs/api#product_object-type).
            properties:
              active:
                type: boolean
              id:
                maxLength: 5000
                type: string
              metadata:
                additionalProperties:
                  type: string
                type: object
              name:
                maxLength: 5000
                type: string
              statement_descriptor:
                maxLength: 22
                type: string
              tax_code:
                maxLength: 5000
                type: string
              unit_label:
                maxLength: 12
                type: string
            required:
            - name
            title: inline_product_params
            type: object
          - description: The ID of the product whose pricing the created plan will represent.
            maxLength: 5000
            type: string
        tiers:
          description: Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
          items:
            properties:
              flat_amount:
                type: integer
              flat_amount_decimal:
                format: decimal
                type: string
              unit_amount:
                type: integer
              unit_amount_decimal:
                format: decimal
                type: string
              up_to:
                anyOf:
                - enum:
                  - inf
                  maxLength: 5000
                  type: string
                - type: integer
            required:
            - up_to
            title: tier
            type: object
          type: array
        tiers_mode:
          description: Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.
          enum:
          - graduated
          - volume
          type: string
        transform_usage:
          description: Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
          properties:
            divide_by:
              type: integer
            round:
              enum:
              - down
              - up
              type: string
          required:
          - divide_by
          - round
          title: transform_usage_param
          type: object
        trial_period_days:
          description: Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
          type: integer
        usage_type:
          description: Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
          enum:
          - licensed
          - metered
          type: string
    PostCustomersCustomerBankAccountsRequest:
      type: object
      properties:
        alipay_account:
          description: A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details.
          maxLength: 5000
          type: string
        bank_account:
          anyOf:
          - properties:
              account_holder_name:
                maxLength: 5000
                type: string
              account_holder_type:
                enum:
                - company
                - individual
                maxLength: 5000
                type: string
              account_number:
                maxLength: 5000
                type: string
              country:
                maxLength: 5000
                type: string
              currency:
                type: string
              object:
                enum:
                - bank_account
                maxLength: 5000
                type: string
              routing_number:
                maxLength: 5000
                type: string
            required:
            - account_number
            - country
            title: customer_payment_source_bank_account
            type: object
          - maxLength: 5000
            type: string
          description: Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details.
        card:
          anyOf:
          - properties:
              address_city:
                maxLength: 5000
                type: string
              address_country:
                maxLength: 5000
                type: string
              address_line1:
                maxLength: 5000
                type: string
              address_line2:
                maxLength: 5000
                type: string
              address_state:
                maxLength: 5000
                type: string
              address_zip:
                maxLength: 5000
                type: string
              cvc:
                maxLength: 5000
                type: string
              exp_month:
                type: integer
              exp_year:
                type: integer
              metadata:
                additionalProperties:
                  type: string
                type: object
              name:
                maxLength: 5000
                type: string
              number:
                maxLength: 5000
                type: string
              object:
                enum:
                - card
                maxLength: 5000
                type: string
            required:
            - exp_month
            - exp_year
            - number
            title: customer_payment_source_card
            type: object
          - maxLength: 5000
            type: string
          description: A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).
          x-stripeBypassValidation: true
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        source:
          description: Please refer to full [documentation](https://stripe.com/docs/api) instead.
          maxLength: 5000
          type: string
          x-stripeBypassValidation: true
    PostCheckoutSessionsSessionExpireRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostIssuingSettlementsSettlementRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
    PostInvoicesInvoiceRequest:
      type: object
      properties:
        account_tax_ids:
          anyOf:
          - items:
              maxLength: 5000
              type: string
            type: array
          - enum:
            - ''
            type: string
          description: The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
        application_fee_amount:
          description: A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
          type: integer
        auto_advance:
          description: Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice.
          type: boolean
        automatic_tax:
          description: Settings for automatic tax lookup for this invoice.
          properties:
            enabled:
              type: boolean
          required:
          - enabled
          title: automatic_tax_param
          type: object
        collection_method:
          description: Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.
          enum:
          - charge_automatically
          - send_invoice
          type: string
        custom_fields:
          anyOf:
          - items:
              properties:
                name:
                  maxLength: 30
                  type: string
                value:
                  maxLength: 30
                  type: string
              required:
              - name
              - value
              title: custom_field_params
              type: object
            type: array
          - enum:
            - ''
            type: string
          description: A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields.
        days_until_due:
          description: The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.
          type: integer
        default_payment_method:
          description: ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
          maxLength: 5000
          type: string
        default_source:
          anyOf:
          - maxLength: 5000
            type: string
          - enum:
            - ''
            type: string
          description: ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
        default_tax_rates:
          anyOf:
          - items:
              maxLength: 5000
              type: string
            type: array
          - enum:
            - ''
            type: string
          description: The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates.
        description:
          description: An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
          maxLength: 1500
          type: string
        discounts:
          anyOf:
          - items:
              properties:
                coupon:
                  maxLength: 5000
                  type: string
                discount:
                  maxLength: 5000
                  type: string
              title: discounts_data_param
              type: object
            type: array
          - enum:
            - ''
            type: string
          description: The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts.
        due_date:
          description: The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.
          format: unix-time
          type: integer
        effective_at:
          anyOf:
          - format: unix-time
            type: integer
          - enum:
            - ''
            type: string
          description: The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        footer:
          description: Footer to be displayed on the invoice.
          maxLength: 5000
          type: string
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        on_behalf_of:
          anyOf:
          - type: string
          - enum:
            - ''
            type: string
          description: The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
        payment_settings:
          description: Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
          properties:
            default_mandate:
              anyOf:
              - maxLength: 5000
                type: string
              - enum:
                - ''
                type: string
            payment_method_options:
              properties:
                acss_debit:
                  anyOf:
                  - properties:
                      mandate_options:
                        properties:
                          transaction_type:
                            enum:
                            - business
                            - personal
                            type: string
                        title: mandate_options_param
                        type: object
                      verification_method:
                        enum:
                        - automatic
                        - instant
                        - microdeposits
                        type: string
                        x-stripeBypassValidation: true
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                bancontact:
                  anyOf:
                  - properties:
                      preferred_language:
                        enum:
                        - de
                        - en
                        - fr
                        - nl
                        type: string
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                card:
                  anyOf:
                  - properties:
                      installments:
                        properties:
                          enabled:
                            type: boolean
                          plan:
                            anyOf:
                            - properties:
                                count:
                                  type: integer
                                interval:
                                  enum:
                                  - month
                                  type: string
                                type:
                                  enum:
                                  - fixed_count
                                  type: string
                              required:
                              - count
                              - interval
                              - type
                              title: installment_plan
                              type: object
                            - enum:
                              - ''
                              type: string
                        title: installments_param
                        type: object
                      request_three_d_secure:
                        enum:
                        - any
                        - automatic
                        type: string
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                customer_balance:
                  anyOf:
                  - properties:
                      bank_transfer:
                        properties:
                          eu_bank_transfer:
                            properties:
                              country:
                                maxLength: 5000
                                type: string
                            required:
                            - country
                            title: eu_bank_transfer_param
                            type: object
                          type:
                            type: string
                        title: bank_transfer_param
                        type: object
                      funding_type:
                        type: string
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                konbini:
                  anyOf:
                  - properties: {}
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                us_bank_account:
                  anyOf:
                  - properties:
                      financial_connections:
                        properties:
                          permissions:
                            items:
                              enum:
                              - balances
                              - ownership
                              - payment_method
                              - transactions
                              maxLength: 5000
                              type: string
                              x-stripeBypassValidation: true
                            type: array
                          prefetch:
                            items:
                              enum:
                              - balances
                              - transactions
                              type: string
                              x-stripeBypassValidation: true
                            type: array
                        title: invoice_linked_account_options_param
                        type: object
                      verification_method:
                        enum:
                        - automatic
                        - instant
                        - microdeposits
                        type: string
                        x-stripeBypassValidation: true
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
              title: payment_method_options
              type: object
            payment_method_types:
              anyOf:
              - items:
                  enum:
                  - ach_credit_transfer
                  - ach_debit
                  - acss_debit
                  - au_becs_debit
                  - bacs_debit
                  - bancontact
                  - boleto
                  - card
                  - cashapp
                  - customer_balance
                  - fpx
                  - giropay
                  - grabpay
                  - ideal
                  - konbini
                  - link
                  - paynow
                  - paypal
                  - promptpay
                  - sepa_debit
                  - sofort
                  - us_bank_account
                  - wechat_pay
                  type: string
                  x-stripeBypassValidation: true
                type: array
              - enum:
                - ''
                type: string
          title: payment_settings
          type: object
        rendering:
          description: The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
          properties:
            amount_tax_display:
              enum:
              - ''
              - exclude_tax
              - include_inclusive_tax
              type: string
            pdf:
              properties:
                page_size:
                  enum:
                  - a4
                  - auto
                  - letter
                  type: string
              title: rendering_pdf_param
              type: object
          title: rendering_param
          type: object
        shipping_cost:
          anyOf:
          - properties:
              shipping_rate:
                maxLength: 5000
                type: string
              shipping_rate_data:
                properties:
                  delivery_estimate:
                    properties:
                      maximum:
                        properties:
                          unit:
                            enum:
                            - business_day
                            - day
                            - hour
                            - month
                            - week
                            type: string
                          value:
                            type: integer
                        required:
                        - unit
                        - value
                        title: delivery_estimate_bound
                        type: object
                      minimum:
                        properties:
                          unit:
                            enum:
                            - business_day
                            - day
                            - hour
                            - month
                            - week
                            type: string
                          value:
                            type: integer
                        required:
                        - unit
                        - value
                        title: delivery_estimate_bound
                        type: object
                    title: delivery_estimate
                    type: object
                  display_name:
                    maxLength: 100
                    type: string
                  fixed_amount:
                    properties:
                      amount:
                        type: integer
                      currency:
                        type: string
                      currency_options:
                        additionalProperties:
                          properties:
                            amount:
                              type: integer
                            tax_behavior:
                              enum:
                              - exclusive
                              - inclusive
                              - unspecified
                              type: string
                          required:
                          - amount
                          title: currency_option
                          type: object
                        type: object
                    required:
                    - amount
                    - currency
                    title: fixed_amount
                    type: object
                  metadata:
                    additionalProperties:
                      type: string
                    type: object
                  tax_behavior:
                    enum:
                    - exclusive
                    - inclusive
                    - unspecified
                    type: string
                  tax_code:
                    type: string
                  type:
                    enum:
                    - fixed_amount
                    type: string
                required:
                - display_name
                title: method_params
                type: object
            title: shipping_cost
            type: object
          - enum:
            - ''
            type: string
          description: Settings for the cost of shipping for this invoice.
        shipping_details:
          anyOf:
          - properties:
              address:
                properties:
                  city:
                    maxLength: 5000
                    type: string
                  country:
                    maxLength: 5000
                    type: string
                  line1:
                    maxLength: 5000
                    type: string
                  line2:
                    maxLength: 5000
                    type: string
                  postal_code:
                    maxLength: 5000
                    type: string
                  state:
                    maxLength: 5000
                    type: string
                title: optional_fields_address
                type: object
              name:
                maxLength: 5000
                type: string
              phone:
                anyOf:
                - maxLength: 5000
                  type: string
                - enum:
                  - ''
                  type: string
            required:
            - address
            - name
            title: recipient_shipping_with_optional_fields_address
            type: object
          - enum:
            - ''
            type: string
          description: Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.
        statement_descriptor:
          description: Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.
          maxLength: 22
          type: string
        transfer_data:
          anyOf:
          - properties:
              amount:
                type: integer
              destination:
                type: string
            required:
            - destination
            title: transfer_data_specs
            type: object
          - enum:
            - ''
            type: string
          description: If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value.
    PostIssuingCardholdersRequest:
      type: object
      required:
      - billing
      - name
      properties:
        billing:
          description: The cardholder's billing address.
          properties:
            address:
              properties:
                city:
                  maxLength: 5000
                  type: string
                country:
                  maxLength: 5000
                  type: string
                line1:
                  maxLength: 5000
                  type: string
                line2:
                  maxLength: 5000
                  type: string
                postal_code:
                  maxLength: 5000
                  type: string
                state:
                  maxLength: 5000
                  type: string
              required:
              - city
              - country
              - line1
              - postal_code
              title: required_address
              type: object
          required:
          - address
          title: billing_specs
          type: object
        company:
          description: Additional information about a `company` cardholder.
          properties:
            tax_id:
              maxLength: 5000
              type: string
          title: company_param
          type: object
        email:
          description: The cardholder's email address.
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        individual:
          description: Additional information about an `individual` cardholder.
          properties:
            card_issuing:
              properties:
                user_terms_acceptance:
                  properties:
                    date:
                      format: unix-time
                      type: integer
                    ip:
                      type: string
                    user_agent:
                      anyOf:
                      - maxLength: 5000
                        type: string
                      - enum:
                        - ''
                        type: string
                  title: terms_acceptance_param
                  type: object
              title: card_issuing_param
              type: object
            dob:
              properties:
                day:
                  type: integer
                month:
                  type: integer
                year:
                  type: integer
              required:
              - day
              - month
              - year
              title: date_of_birth_specs
              type: object
            first_name:
              type: string
            last_name:
              type: string
            verification:
              properties:
                document:
                  properties:
                    back:
                      maxLength: 5000
                      type: string
                    front:
                      maxLength: 5000
                      type: string
                  title: person_verification_document_param
                  type: object
              title: person_verification_param
              type: object
          title: individual_param
          type: object
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        name:
          description: The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers.
          type: string
        phone_number:
          description: The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.
          type: string
        preferred_locales:
          description: "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder."
          items:
            enum:
            - de
            - en
            - es
            - fr
            - it
            type: string
          type: array
        spending_controls:
          description: Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
          properties:
            allowed_categories:
              items:
                enum:
                - ac_refrigeration_repair
                - accounting_bookkeeping_services
                - advertising_services
                - agricultural_cooperative
                - airlines_air_carriers
                - airports_flying_fields
                - ambulance_services
                - amusement_parks_carnivals
                - antique_reproductions
                - antique_shops
                - aquariums
                - architectural_surveying_services
                - art_dealers_and_galleries
                - artists_supply_and_craft_shops
                - auto_and_home_supply_stores
                - auto_body_repair_shops
                - auto_paint_shops
                - auto_service_shops
                - automated_cash_disburse
                - automated_fuel_dispensers
                - automobile_associations
                - automotive_parts_and_accessories_stores
                - automotive_tire_stores
                - bail_and_bond_payments
                - bakeries
                - bands_orchestras
                - barber_and_beauty_shops
                - betting_casino_gambling
                - bicycle_shops
                - billiard_pool_establishments
                - boat_dealers
                - boat_rentals_and_leases
                - book_stores
                - books_periodicals_and_newspapers
                - bowling_alleys
                - bus_lines
                - business_secretarial_schools
                - buying_shopping_services
                - cable_satellite_and_other_pay_television_and_radio
                - camera_and_photographic_supply_stores
                - candy_nut_and_confectionery_stores
                - car_and_truck_dealers_new_used
                - car_and_truck_dealers_used_only
                - car_rental_agencies
                - car_washes
                - carpentry_services
                - carpet_upholstery_cleaning
                - caterers
                - charitable_and_social_service_organizations_fundraising
                - chemicals_and_allied_products
                - child_care_services
                - childrens_and_infants_wear_stores
                - chiropodists_podiatrists
                - chiropractors
                - cigar_stores_and_stands
                - civic_social_fraternal_associations
                - cleaning_and_maintenance
                - clothing_rental
                - colleges_universities
                - commercial_equipment
                - commercial_footwear
                - commercial_photography_art_and_graphics
                - commuter_transport_and_ferries
                - computer_network_services
                - computer_programming
                - computer_repair
                - computer_software_stores
                - computers_peripherals_and_software
                - concrete_work_services
                - construction_materials
                - consulting_public_relations
                - correspondence_schools
                - cosmetic_stores
                - counseling_services
                - country_clubs
                - courier_services
                - court_costs
                - credit_reporting_agencies
                - cruise_lines
                - dairy_products_stores
                - dance_hall_studios_schools
                - dating_escort_services
                - dentists_orthodontists
                - department_stores
                - detective_agencies
                - digital_goods_applications
                - digital_goods_games
                - digital_goods_large_volume
                - digital_goods_media
                - direct_marketing_catalog_merchant
                - direct_marketing_combination_catalog_and_retail_merchant
                - direct_marketing_inbound_telemarketing
                - direct_marketing_insurance_services
                - direct_marketing_other
                - direct_marketing_outbound_telemarketing
                - direct_marketing_subscription
                - direct_marketing_travel
                - discount_stores
                - doctors
                - door_to_door_sales
                - drapery_window_covering_and_upholstery_stores
                - drinking_places
                - drug_stores_and_pharmacies
                - drugs_drug_proprietaries_and_druggist_sundries
                - dry_cleaners
                - durable_goods
                - duty_free_stores
                - eating_places_restaurants
                - educational_services
                - electric_razor_stores
                - electric_vehicle_charging
                - electrical_parts_and_equipment
                - electrical_services
                - electronics_repair_shops
                - electronics_stores
                - elementary_secondary_schools
                - emergency_services_gcas_visa_use_only
                - employment_temp_agencies
                - equipment_rental
                - exterminating_services
                - family_clothing_stores
                - fast_food_restaurants
                - financial_institutions
                - fines_government_administrative_entities
                - fireplace_fireplace_screens_and_accessories_stores
                - floor_covering_stores
                - florists
                - florists_supplies_nursery_stock_and_flowers
                - freezer_and_locker_meat_provisioners
                - fuel_dealers_non_automotive
                - funeral_services_crematories
                - furniture_home_furnishings_and_equipment_stores_except_appliances
                - furniture_repair_refinishing
                - furriers_and_fur_shops
                - general_services
                - gift_card_novelty_and_souvenir_shops
                - glass_paint_and_wallpaper_stores
                - glassware_crystal_stores
                - golf_courses_public
                - government_licensed_horse_dog_racing_us_region_only
                - government_licensed_online_casions_online_gambling_us_region_only
                - government_owned_lotteries_non_us_region
                - government_owned_lotteries_us_region_only
                - government_services
                - grocery_stores_supermarkets
                - hardware_equipment_and_supplies
                - hardware_stores
                - health_and_beauty_spas
                - hearing_aids_sales_and_supplies
                - heating_plumbing_a_c
                - hobby_toy_and_game_shops
                - home_supply_warehouse_stores
                - hospitals
                - hotels_motels_and_resorts
                - household_appliance_stores
                - industrial_supplies
                - information_retrieval_services
                - insurance_default
                - insurance_underwriting_premiums
                - intra_company_purchases
                - jewelry_stores_watches_clocks_and_silverware_stores
                - landscaping_services
                - laundries
                - laundry_cleaning_services
                - legal_services_attorneys
                - luggage_and_leather_goods_stores
                - lumber_building_materials_stores
                - manual_cash_disburse
                - marinas_service_and_supplies
                - marketplaces
                - masonry_stonework_and_plaster
                - massage_parlors
                - medical_and_dental_labs
                - medical_dental_ophthalmic_and_hospital_equipment_and_supplies
                - medical_services
                - membership_organizations
                - mens_and_boys_clothing_and_accessories_stores
                - mens_womens_clothing_stores
                - metal_service_centers
                - miscellaneous
                - miscellaneous_apparel_and_accessory_shops
                - miscellaneous_auto_dealers
                - miscellaneous_business_services
                - miscellaneous_food_stores
                - miscellaneous_general_merchandise
                - miscellaneous_general_services
                - miscellaneous_home_furnishing_specialty_stores
                - miscellaneous_publishing_and_printing
                - miscellaneous_recreation_services
                - miscellaneous_repair_shops
                - miscellaneous_specialty_retail
                - mobile_home_dealers
                - motion_picture_theaters
                - motor_freight_carriers_and_trucking
                - motor_homes_dealers
                - motor_vehicle_supplies_and_new_parts
                - motorcycle_shops_and_dealers
                - motorcycle_shops_dealers
                - music_stores_musical_instruments_pianos_and_sheet_music
                - news_dealers_and_newsstands
                - non_fi_money_orders
                - non_fi_stored_value_card_purchase_load
                - nondurable_goods
                - nurseries_lawn_and_garden_supply_stores
                - nursing_personal_care
                - office_and_commercial_furniture
                - opticians_eyeglasses
                - optometrists_ophthalmologist
                - orthopedic_goods_prosthetic_devices
                - osteopaths
                - package_stores_beer_wine_and_liquor
                - paints_varnishes_and_supplies
                - parking_lots_garages
                - passenger_railways
                - pawn_shops
                - pet_shops_pet_food_and_supplies
                - petroleum_and_petroleum_products
                - photo_developing
                - photographic_photocopy_microfilm_equipment_and_supplies
                - photographic_studios
                - picture_video_production
                - piece_goods_notions_and_other_dry_goods
                - plumbing_heating_equipment_and_supplies
                - political_organizations
                - postal_services_government_only
                - precious_stones_and_metals_watches_and_jewelry
                - professional_services
                - public_warehousing_and_storage
                - quick_copy_repro_and_blueprint
                - railroads
                - real_estate_agents_and_managers_rentals
                - record_stores
                - recreational_vehicle_rentals
                - religious_goods_stores
                - religious_organizations
                - roofing_siding_sheet_metal
                - secretarial_support_services
                - security_brokers_dealers
                - service_stations
                - sewing_needlework_fabric_and_piece_goods_stores
                - shoe_repair_hat_cleaning
                - shoe_stores
                - small_appliance_repair
                - snowmobile_dealers
                - special_trade_services
                - specialty_cleaning
                - sporting_goods_stores
                - sporting_recreation_camps
                - sports_and_riding_apparel_stores
                - sports_clubs_fields
                - stamp_and_coin_stores
                - stationary_office_supplies_printing_and_writing_paper
                - stationery_stores_office_and_school_supply_stores
                - swimming_pools_sales
                - t_ui_travel_germany
                - tailors_alterations
                - tax_payments_government_agencies
                - tax_preparation_services
                - taxicabs_limousines
                - telecommunication_equipment_and_telephone_sales
                - telecommunication_services
                - telegraph_services
                - tent_and_awning_shops
                - testing_laboratories
                - theatrical_ticket_agencies
                - timeshares
                - tire_retreading_and_repair
                - tolls_bridge_fees
                - tourist_attractions_and_exhibits
                - towing_services
                - trailer_parks_campgrounds
                - transportation_services
                - travel_agencies_tour_operators
                - truck_stop_iteration
                - truck_utility_trailer_rentals
                - typesetting_plate_making_and_related_services
                - typewriter_stores
                - u_s_federal_government_agencies_or_departments
                - uniforms_commercial_clothing
                - used_merchandise_and_secondhand_stores
                - utilities
                - variety_stores
                - veterinary_services
                - video_amusement_game_supplies
                - video_game_arcades
                - video_tape_rental_stores
                - vocational_trade_schools
                - watch_jewelry_repair
                - welding_repair
                - wholesale_clubs
                - wig_and_toupee_stores
                - wires_money_orders
                - womens_accessory_and_specialty_shops
                - womens_ready_to_wear_stores
                - wrecking_and_salvage_yards
                maxLength: 5000
                type: string
              type: array
            blocked_categories:
              items:
                enum:
                - ac_refrigeration_repair
                - accounting_bookkeeping_services
                - advertising_services
                - agricultural_cooperative
                - airlines_air_carriers
                - airports_flying_fields
                - ambulance_services
                - amusement_parks_carnivals
                - antique_reproductions
                - antique_shops
                - aquariums
                - architectural_surveying_services
                - art_dealers_and_galleries
                - artists_supply_and_craft_shops
                - auto_and_home_supply_stores
                - auto_body_repair_shops
                - auto_paint_shops
                - auto_service_shops
                - automated_cash_disburse
                - automated_fuel_dispensers
                - automobile_associations
                - automotive_parts_and_accessories_stores
                - automotive_tire_stores
                - bail_and_bond_payments
                - bakeries
                - bands_orchestras
                - barber_and_beauty_shops
                - betting_casino_gambling
                - bicycle_shops
                - billiard_pool_establishments
                - boat_dealers
                - boat_rentals_and_leases
                - book_stores
                - books_periodicals_and_newspapers
                - bowling_alleys
                - bus_lines
                - business_secretarial_schools
                - buying_shopping_services
                - cable_satellite_and_other_pay_television_and_radio
                - camera_and_photographic_supply_stores
                - candy_nut_and_confectionery_stores
                - car_and_truck_dealers_new_used
                - car_and_truck_dealers_used_only
                - car_rental_agencies
                - car_washes
                - carpentry_services
                - carpet_upholstery_cleaning
                - caterers
                - charitable_and_social_service_organizations_fundraising
                - chemicals_and_allied_products
                - child_care_services
                - childrens_and_infants_wear_stores
                - chiropodists_podiatrists
                - chiropractors
                - cigar_stores_and_stands
                - civic_social_fraternal_associations
                - cleaning_and_maintenance
                - clothing_rental
                - colleges_universities
                - commercial_equipment
                - commercial_footwear
                - commercial_photography_art_and_graphics
                - commuter_transport_and_ferries
                - computer_network_services
                - computer_programming
                - computer_repair
                - computer_software_stores
                - computers_peripherals_and_software
                - concrete_work_services
                - construction_materials
                - consulting_public_relations
                - correspondence_schools
                - cosmetic_stores
                - counseling_services
                - country_clubs
                - courier_services
                - court_costs
                - credit_reporting_agencies
                - cruise_lines
                - dairy_products_stores
                - dance_hall_studios_schools
                - dating_escort_services
                - dentists_orthodontists
                - department_stores
                - detective_agencies
                - digital_goods_applications
                - digital_goods_games
                - digital_goods_large_volume
                - digital_goods_media
                - direct_marketing_catalog_merchant
                - direct_marketing_combination_catalog_and_retail_merchant
                - direct_marketing_inbound_telemarketing
                - direct_marketing_insurance_services
                - direct_marketing_other
                - direct_marketing_outbound_telemarketing
                - direct_marketing_subscription
                - direct_marketing_travel
                - discount_stores
                - doctors
                - door_to_door_sales
                - drapery_window_covering_and_upholstery_stores
                - drinking_places
                - drug_stores_and_pharmacies
                - drugs_drug_proprietaries_and_druggist_sundries
                - dry_cleaners
                - durable_goods
                - duty_free_stores
                - eating_places_restaurants
                - educational_services
                - electric_razor_stores
                - electric_vehicle_charging
                - electrical_parts_and_equipment
                - electrical_services
                - electronics_repair_shops
                - electronics_stores
                - elementary_secondary_schools
                - emergency_services_gcas_visa_use_only
                - employment_temp_agencies
                - equipment_rental
                - exterminating_services
                - family_clothing_stores
                - fast_food_restaurants
                - financial_institutions
                - fines_government_administrative_entities
                - fireplace_fireplace_screens_and_accessories_stores
                - floor_covering_stores
                - florists
                - florists_supplies_nursery_stock_and_flowers
                - freezer_and_locker_meat_provisioners
                - fuel_dealers_non_automotive
                - funeral_services_crematories
                - furniture_home_furnishings_and_equipment_stores_except_appliances
                - furniture_repair_refinishing
                - furriers_and_fur_shops
                - general_services
                - gift_card_novelty_and_souvenir_shops
                - glass_paint_and_wallpaper_stores
                - glassware_crystal_stores
                - golf_courses_public
                - government_licensed_horse_dog_racing_us_region_only
                - government_licensed_online_casions_online_gambling_us_region_only
                - government_owned_lotteries_non_us_region
                - government_owned_lotteries_us_region_only
                - government_services
                - grocery_stores_supermarkets
                - hardware_equipment_and_supplies
                - hardware_stores
                - health_and_beauty_spas
                - hearing_aids_sales_and_supplies
                - heating_plumbing_a_c
                - hobby_toy_and_game_shops
                - home_supply_warehouse_stores
                - hospitals
                - hotels_motels_and_resorts
                - household_appliance_stores
                - industrial_supplies
                - information_retrieval_services
                - insurance_default
                - insurance_underwriting_premiums
                - intra_company_purchases
                - jewelry_stores_watches_clocks_and_silverware_stores
                - landscaping_services
                - laundries
                - laundry_cleaning_services
                - legal_services_attorneys
                - luggage_and_leather_goods_stores
                - lumber_building_materials_stores
                - manual_cash_disburse
                - marinas_service_and_supplies
                - marketplaces
                - masonry_stonework_and_plaster
                - massage_parlors
                - medical_and_dental_labs
                - medical_dental_ophthalmic_and_hospital_equipment_and_supplies
                - medical_services
                - membership_organizations
                - mens_and_boys_clothing_and_accessories_stores
                - mens_womens_clothing_stores
                - metal_service_centers
                - miscellaneous
                - miscellaneous_apparel_and_accessory_shops
                - miscellaneous_auto_dealers
                - miscellaneous_business_services
                - miscellaneous_food_stores
                - miscellaneous_general_merchandise
                - miscellaneous_general_services
                - miscellaneous_home_furnishing_specialty_stores
                - miscellaneous_publishing_and_printing
                - miscellaneous_recreation_services
                - miscellaneous_repair_shops
                - miscellaneous_specialty_retail
                - mobile_home_dealers
                - motion_picture_theaters
                - motor_freight_carriers_and_trucking
                - motor_homes_dealers
                - motor_vehicle_supplies_and_new_parts
                - motorcycle_shops_and_dealers
                - motorcycle_shops_dealers
                - music_stores_musical_instruments_pianos_and_sheet_music
                - news_dealers_and_newsstands
                - non_fi_money_orders
                - non_fi_stored_value_card_purchase_load
                - nondurable_goods
                - nurseries_lawn_and_garden_supply_stores
                - nursing_personal_care
                - office_and_commercial_furniture
                - opticians_eyeglasses
                - optometrists_ophthalmologist
                - orthopedic_goods_prosthetic_devices
                - osteopaths
                - package_stores_beer_wine_and_liquor
                - paints_varnishes_and_supplies
                - parking_lots_garages
                - passenger_railways
                - pawn_shops
                - pet_shops_pet_food_and_supplies
                - petroleum_and_petroleum_products
                - photo_developing
                - photographic_photocopy_microfilm_equipment_and_supplies
                - photographic_studios
                - picture_video_production
                - piece_goods_notions_and_other_dry_goods
                - plumbing_heating_equipment_and_supplies
                - political_organizations
                - postal_services_government_only
                - precious_stones_and_metals_watches_and_jewelry
                - professional_services
                - public_warehousing_and_storage
                - quick_copy_repro_and_blueprint
                - railroads
                - real_estate_agents_and_managers_rentals
                - record_stores
                - recreational_vehicle_rentals
                - religious_goods_stores
                - religious_organizations
                - roofing_siding_sheet_metal
                - secretarial_support_services
                - security_brokers_dealers
                - service_stations
                - sewing_needlework_fabric_and_piece_goods_stores
                - shoe_repair_hat_cleaning
                - shoe_stores
                - small_appliance_repair
                - snowmobile_dealers
                - special_trade_services
                - specialty_cleaning
                - sporting_goods_stores
                - sporting_recreation_camps
                - sports_and_riding_apparel_stores
                - sports_clubs_fields
                - stamp_and_coin_stores
                - stationary_office_supplies_printing_and_writing_paper
                - stationery_stores_office_and_school_supply_stores
                - swimming_pools_sales
                - t_ui_travel_germany
                - tailors_alterations
                - tax_payments_government_agencies
                - tax_preparation_services
                - taxicabs_limousines
                - telecommunication_equipment_and_telephone_sales
                - telecommunication_services
                - telegraph_services
                - tent_and_awning_shops
                - testing_laboratories
                - theatrical_ticket_agencies
                - timeshares
                - tire_retreading_and_repair
                - tolls_bridge_fees
                - tourist_attractions_and_exhibits
                - towing_services
                - trailer_parks_campgrounds
                - transportation_services
                - travel_agencies_tour_operators
                - truck_stop_iteration
                - truck_utility_trailer_rentals
                - typesetting_plate_making_and_related_services
                - typewriter_stores
                - u_s_federal_government_agencies_or_departments
                - uniforms_commercial_clothing
                - used_merchandise_and_secondhand_stores
                - utilities
                - variety_stores
                - veterinary_services
                - video_amusement_game_supplies
                - video_game_arcades
                - video_tape_rental_stores
                - vocational_trade_schools
                - watch_jewelry_repair
                - welding_repair
                - wholesale_clubs
                - wig_and_toupee_stores
                - wires_money_orders
                - womens_accessory_and_specialty_shops
                - womens_ready_to_wear_stores
                - wrecking_and_salvage_yards
                maxLength: 5000
                type: string
              type: array
            spending_limits:
              items:
                properties:
                  amount:
                    type: integer
                  categories:
                    items:
                      enum:
                      - ac_refrigeration_repair
                      - accounting_bookkeeping_services
                      - advertising_services
                      - agricultural_cooperative
                      - airlines_air_carriers
                      - airports_flying_fields
                      - ambulance_services
                      - amusement_parks_carnivals
                      - antique_reproductions
                      - antique_shops
                      - aquariums
                      - architectural_surveying_services
                      - art_dealers_and_galleries
                      - artists_supply_and_craft_shops
                      - auto_and_home_supply_stores
                      - auto_body_repair_shops
                      - auto_paint_shops
                      - auto_service_shops
                      - automated_cash_disburse
                      - automated_fuel_dispensers
                      - automobile_associations
                      - automotive_parts_and_accessories_stores
                      - automotive_tire_stores
                      - bail_and_bond_payments
                      - bakeries
                      - bands_orchestras
                      - barber_and_beauty_shops
                      - betting_casino_gambling
                      - bicycle_shops
                      - billiard_pool_establishments
                      - boat_dealers
                      - boat_rentals_and_leases
                      - book_stores
                      - books_periodicals_and_newspapers
                      - bowling_alleys
                      - bus_lines
                      - business_secretarial_schools
                      - buying_shopping_services
                      - cable_satellite_and_other_pay_television_and_radio
                      - camera_and_photographic_supply_stores
                      - candy_nut_and_confectionery_stores
                      - car_and_truck_dealers_new_used
                      - car_and_truck_dealers_used_only
                      - car_rental_agencies
                      - car_washes
                      - carpentry_services
                      - carpet_upholstery_cleaning
                      - caterers
                      - charitable_and_social_service_organizations_fundraising
                      - chemicals_and_allied_products
                      - child_care_services
                      - childrens_and_infants_wear_stores
                      - chiropodists_podiatrists
                      - chiropractors
                      - cigar_stores_and_stands
                      - civic_social_fraternal_associations
                      - cleaning_and_maintenance
                      - clothing_rental
                      - colleges_universities
                      - commercial_equipment
                      - commercial_footwear
                      - commercial_photography_art_and_graphics
                      - commuter_transport_and_ferries
                      - computer_network_services
                      - computer_programming
                      - computer_repair
                      - computer_software_stores
                      - computers_peripherals_and_software
                      - concrete_work_services
                      - construction_materials
                      - consulting_public_relations
                      - correspondence_schools
                      - cosmetic_stores
                      - counseling_services
                      - country_clubs
                      - courier_services
                      - court_costs
                      - credit_reporting_agencies
                      - cruise_lines
                      - dairy_products_stores
                      - dance_hall_studios_schools
                      - dating_escort_services
                      - dentists_orthodontists
                      - department_stores
                      - detective_agencies
                      - digital_goods_applications
                      - digital_goods_games
                      - digital_goods_large_volume
                      - digital_goods_media
                      - direct_marketing_catalog_merchant
                      - direct_marketing_combination_catalog_and_retail_merchant
                      - direct_marketing_inbound_telemarketing
                      - direct_marketing_insurance_services
                      - direct_marketing_other
                      - direct_marketing_outbound_telemarketing
                      - direct_marketing_subscription
                      - direct_marketing_travel
                      - discount_stores
                      - doctors
                      - door_to_door_sales
                      - drapery_window_covering_and_upholstery_stores
                      - drinking_places
                      - drug_stores_and_pharmacies
                      - drugs_drug_proprietaries_and_druggist_sundries
                      - dry_cleaners
                      - durable_goods
                      - duty_free_stores
                      - eating_places_restaurants
                      - educational_services
                      - electric_razor_stores
                      - electric_vehicle_charging
                      - electrical_parts_and_equipment
                      - electrical_services
                      - electronics_repair_shops
                      - electronics_stores
                      - elementary_secondary_schools
                      - emergency_services_gcas_visa_use_only
                      - employment_temp_agencies
                      - equipment_rental
                      - exterminating_services
                      - family_clothing_stores
                      - fast_food_restaurants
                      - financial_institutions
                      - fines_government_administrative_entities
                      - fireplace_fireplace_screens_and_accessories_stores
                      - floor_covering_stores
                      - florists
                      - florists_supplies_nursery_stock_and_flowers
                      - freezer_and_locker_meat_provisioners
                      - fuel_dealers_non_automotive
                      - funeral_services_crematories
                      - furniture_home_furnishings_and_equipment_stores_except_appliances
                      - furniture_repair_refinishing
                      - furriers_and_fur_shops
                      - general_services
                      - gift_card_novelty_and_souvenir_shops
                      - glass_paint_and_wallpaper_stores
                      - glassware_crystal_stores
                      - golf_courses_public
                      - government_licensed_horse_dog_racing_us_region_only
                      - government_licensed_online_casions_online_gambling_us_region_only
                      - government_owned_lotteries_non_us_region
                      - government_owned_lotteries_us_region_only
                      - government_services
                      - grocery_stores_supermarkets
                      - hardware_equipment_and_supplies
                      - hardware_stores
                      - health_and_beauty_spas
                      - hearing_aids_sales_and_supplies
                      - heating_plumbing_a_c
                      - hobby_toy_and_game_shops
                      - home_supply_warehouse_stores
                      - hospitals
                      - hotels_motels_and_resorts
                      - household_appliance_stores
                      - industrial_supplies
                      - information_retrieval_services
                      - insurance_default
                      - insurance_underwriting_premiums
                      - intra_company_purchases
                      - jewelry_stores_watches_clocks_and_silverware_stores
                      - landscaping_services
                      - laundries
                      - laundry_cleaning_services
                      - legal_services_attorneys
                      - luggage_and_leather_goods_stores
                      - lumber_building_materials_stores
                      - manual_cash_disburse
                      - marinas_service_and_supplies
                      - marketplaces
                      - masonry_stonework_and_plaster
                      - massage_parlors
                      - medical_and_dental_labs
                      - medical_dental_ophthalmic_and_hospital_equipment_and_supplies
                      - medical_services
                      - membership_organizations
                      - mens_and_boys_clothing_and_accessories_stores
                      - mens_womens_clothing_stores
                      - metal_service_centers
                      - miscellaneous
                      - miscellaneous_apparel_and_accessory_shops
                      - miscellaneous_auto_dealers
                      - miscellaneous_business_services
                      - miscellaneous_food_stores
                      - miscellaneous_general_merchandise
                      - miscellaneous_general_services
                      - miscellaneous_home_furnishing_specialty_stores
                      - miscellaneous_publishing_and_printing
                      - miscellaneous_recreation_services
                      - miscellaneous_repair_shops
                      - miscellaneous_specialty_retail
                      - mobile_home_dealers
                      - motion_picture_theaters
                      - motor_freight_carriers_and_trucking
                      - motor_homes_dealers
                      - motor_vehicle_supplies_and_new_parts
                      - motorcycle_shops_and_dealers
                      - motorcycle_shops_dealers
                      - music_stores_musical_instruments_pianos_and_sheet_music
                      - news_dealers_and_newsstands
                      - non_fi_money_orders
                      - non_fi_stored_value_card_purchase_load
                      - nondurable_goods
                      - nurseries_lawn_and_garden_supply_stores
                      - nursing_personal_care
                      - office_and_commercial_furniture
                      - opticians_eyeglasses
                      - optometrists_ophthalmologist
                      - orthopedic_goods_prosthetic_devices
                      - osteopaths
                      - package_stores_beer_wine_and_liquor
                      - paints_varnishes_and_supplies
                      - parking_lots_garages
                      - passenger_railways
                      - pawn_shops
                      - pet_shops_pet_food_and_supplies
                      - petroleum_and_petroleum_products
                      - photo_developing
                      - photographic_photocopy_microfilm_equipment_and_supplies
                      - photographic_studios
                      - picture_video_production
                      - piece_goods_notions_and_other_dry_goods
                      - plumbing_heating_equipment_and_supplies
                      - political_organizations
                      - postal_services_government_only
                      - precious_stones_and_metals_watches_and_jewelry
                      - professional_services
                      - public_warehousing_and_storage
                      - quick_copy_repro_and_blueprint
                      - railroads
                      - real_estate_agents_and_managers_rentals
                      - record_stores
                      - recreational_vehicle_rentals
                      - religious_goods_stores
                      - religious_organizations
                      - roofing_siding_sheet_metal
                      - secretarial_support_services
                      - security_brokers_dealers
                      - service_stations
                      - sewing_needlework_fabric_and_piece_goods_stores
                      - shoe_repair_hat_cleaning
                      - shoe_stores
                      - small_appliance_repair
                      - snowmobile_dealers
                      - special_trade_services
                      - specialty_cleaning
                      - sporting_goods_stores
                      - sporting_recreation_camps
                      - sports_and_riding_apparel_stores
                      - sports_clubs_fields
                      - stamp_and_coin_stores
                      - stationary_office_supplies_printing_and_writing_paper
                      - stationery_stores_office_and_school_supply_stores
                      - swimming_pools_sales
                      - t_ui_travel_germany
                      - tailors_alterations
                      - tax_payments_government_agencies
                      - tax_preparation_services
                      - taxicabs_limousines
                      - telecommunication_equipment_and_telephone_sales
                      - telecommunication_services
                      - telegraph_services
                      - tent_and_awning_shops
                      - testing_laboratories
                      - theatrical_ticket_agencies
                      - timeshares
                      - tire_retreading_and_repair
                      - tolls_bridge_fees
                      - tourist_attractions_and_exhibits
                      - towing_services
                      - trailer_parks_campgrounds
                      - transportation_services
                      - travel_agencies_tour_operators
                      - truck_stop_iteration
                      - truck_utility_trailer_rentals
                      - typesetting_plate_making_and_related_services
                      - typewriter_stores
                      - u_s_federal_government_agencies_or_departments
                      - uniforms_commercial_clothing
                      - used_merchandise_and_secondhand_stores
                      - utilities
                      - variety_stores
                      - veterinary_services
                      - video_amusement_game_supplies
                      - video_game_arcades
                      - video_tape_rental_stores
                      - vocational_trade_schools
                      - watch_jewelry_repair
                      - welding_repair
                      - wholesale_clubs
                      - wig_and_toupee_stores
                      - wires_money_orders
                      - womens_accessory_and_specialty_shops
                      - womens_ready_to_wear_stores
                      - wrecking_and_salvage_yards
                      maxLength: 5000
                      type: string
                    type: array
                  interval:
                    enum:
                    - all_time
                    - daily
                    - monthly
                    - per_authorization
                    - weekly
                    - yearly
                    type: string
                required:
                - amount
                - interval
                title: spending_limits_param
                type: object
              type: array
            spending_limits_currency:
              type: string
          title: authorization_controls_param_v2
          type: object
        status:
          description: Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`.
          enum:
          - active
          - inactive
          type: string
        type:
          description: One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details.
          enum:
          - company
          - individual
          type: string
          x-stripeBypassValidation: true
    PostBillingPortalConfigurationsConfigurationRequest:
      type: object
      properties:
        active:
          description: Whether the configuration is active and can be used to create portal sessions.
          type: boolean
        business_profile:
          description: The business information shown to customers in the portal.
          properties:
            headline:
              anyOf:
              - maxLength: 60
                type: string
              - enum:
                - ''
                type: string
            privacy_policy_url:
              anyOf:
              - type: string
              - enum:
                - ''
                type: string
            terms_of_service_url:
              anyOf:
              - type: string
              - enum:
                - ''
                type: string
          title: business_profile_update_param
          type: object
        default_return_url:
          anyOf:
          - type: string
          - enum:
            - ''
            type: string
          description: The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        features:
          description: Information about the features available in the portal.
          properties:
            customer_update:
              properties:
                allowed_updates:
                  anyOf:
                  - items:
                      enum:
                      - address
                      - email
                      - name
                      - phone
                      - shipping
                      - tax_id
                      type: string
                    type: array
                  - enum:
                    - ''
                    type: string
                enabled:
                  type: boolean
              title: customer_update_updating_param
              type: object
            invoice_history:
              properties:
                enabled:
                  type: boolean
              required:
              - enabled
              title: invoice_list_param
              type: object
            payment_method_update:
              properties:
                enabled:
                  type: boolean
              required:
              - enabled
              title: payment_method_update_param
              type: object
            subscription_cancel:
              properties:
                cancellation_reason:
                  properties:
                    enabled:
                      type: boolean
                    options:
                      anyOf:
                      - items:
                          enum:
                          - customer_service
                          - low_quality
                          - missing_features
                          - other
                          - switched_service
                          - too_complex
                          - too_expensive
                          - unused
                          type: string
                        type: array
                      - enum:
                        - ''
                        type: string
                  required:
                  - enabled
                  title: subscription_cancellation_reason_updating_param
                  type: object
                enabled:
                  type: boolean
                mode:
                  enum:
                  - at_period_end
                  - immediately
                  type: string
                proration_behavior:
                  enum:
                  - always_invoice
                  - create_prorations
                  - none
                  type: string
              title: subscription_cancel_updating_param
              type: object
            subscription_pause:
              properties:
                enabled:
                  type: boolean
              title: subscription_pause_param
              type: object
            subscription_update:
              properties:
                default_allowed_updates:
                  anyOf:
                  - items:
                      enum:
                      - price
                      - promotion_code
                      - quantity
                      type: string
                    type: array
                  - enum:
                    - ''
                    type: string
                enabled:
                  type: boolean
                products:
                  anyOf:
                  - items:
                      properties:
                        prices:
                          items:
                            maxLength: 5000
                            type: string
                          type: array
                        product:
                          maxLength: 5000
                          type: string
                      required:
                      - prices
                      - product
                      title: subscription_update_product_param
                      type: object
                    type: array
                  - enum:
                    - ''
                    type: string
                proration_behavior:
                  enum:
                  - always_invoice
                  - create_prorations
                  - none
                  type: string
              title: subscription_update_updating_param
              type: object
          title: features_updating_param
          type: object
        login_page:
          description: The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
          properties:
            enabled:
              type: boolean
          required:
          - enabled
          title: login_page_update_param
          type: object
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
    customer_balance_transaction:
      description: 'Each customer has a [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) value,

        which denotes a debit or credit that''s automatically applied to their next invoice upon finalization.

        You may modify the value directly by using the [update customer API](https://stripe.com/docs/api/customers/update),

        or by creating a Customer Balance Transaction, which increments or decrements the customer''s `balance` by the specified `amount`.


        Related guide: [Customer balance](https://stripe.com/docs/billing/customer/balance)'
      properties:
        amount:
          description: The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`.
          type: integer
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        credit_note:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/credit_note'
          description: The ID of the credit note (if any) related to the transaction.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/credit_note'
        currency:
          description: 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).
          type: string
        customer:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/customer'
          description: The ID of the customer the transaction belongs to.
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/customer'
        description:
          description: An arbitrary string attached to the object. Often useful for displaying to users.
          maxLength: 5000
          nullable: true
          type: string
        ending_balance:
          description: The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.
          type: integer
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        invoice:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/invoice'
          description: The ID of the invoice (if any) related to the transaction.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/invoice'
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          nullable: true
          type: object
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - customer_balance_transaction
          type: string
        type:
          description: 'Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, or `unapplied_from_invoice`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types.'
          enum:
          - adjustment
          - applied_to_invoice
          - credit_note
          - initial
          - invoice_overpaid
          - invoice_too_large
          - invoice_too_small
          - migration
          - unapplied_from_invoice
          - unspent_receiver_credit
          type: string
      required:
      - amount
      - created
      - currency
      - customer
      - ending_balance
      - id
      - livemode
      - object
      - type
      title: CustomerBalanceTransaction
      type: object
      x-expandableFields:
      - credit_note
      - customer
      - invoice
      x-resourceId: customer_balance_transaction
    PostFinancialConnectionsAccountsAccountSubscribeRequest:
      type: object
      required:
      - features
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        features:
          description: The list of account features to which you would like to subscribe.`.
          items:
            enum:
            - transactions
            type: string
            x-stripeBypassValidation: true
          type: array
    issuing.token:
      description: An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe.
      properties:
        card:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/issuing.card'
          description: Card associated with this token.
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/issuing.card'
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        device_fingerprint:
          description: The hashed ID derived from the device ID from the card network associated with the token
          maxLength: 5000
          nullable: true
          type: string
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        last4:
          description: The last four digits of the token.
          maxLength: 5000
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        network:
          description: The token service provider / card network associated with the token.
          enum:
          - mastercard
          - visa
          type: string
        network_data:
          $ref: '#/components/schemas/issuing_network_token_network_data'
        network_updated_at:
          description: Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - issuing.token
          type: string
        status:
          description: The usage state of the token.
          enum:
          - active
          - deleted
          - requested
          - suspended
          type: string
        wallet_provider:
          description: The digital wallet for this token, if one was used.
          enum:
          - apple_pay
          - google_pay
          - samsung_pay
          type: string
      required:
      - card
      - created
      - id
      - livemode
      - network
      - network_updated_at
      - object
      - status
      title: IssuingNetworkToken
      type: object
      x-expandableFields:
      - card
      - network_data
      x-resourceId: issuing.token
    PostInvoicesInvoiceFinalizeRequest:
      type: object
      properties:
        auto_advance:
          description: Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.
          type: boolean
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostCustomersCustomerBalanceTransactionsTransactionRequest:
      type: object
      properties:
        description:
          description: An arbitrary string attached to the object. Often useful for displaying to users.
          maxLength: 350
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
    PostPaymentMethodsPaymentMethodDetachRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    issuing.transaction:
      description: 'Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving

        your Stripe account, such as a completed purchase or refund, is represented by an Issuing

        `Transaction` object.


        Related guide: [Issued card transactions](https://stripe.com/docs/issuing/purchases/transactions)'
      properties:
        amount:
          description: The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
          type: integer
        amount_details:
          anyOf:
          - $ref: '#/components/schemas/issuing_transaction_amount_details'
          description: Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
          nullable: true
        authorization:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/issuing.authorization'
          description: The `Authorization` object that led to this transaction.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/issuing.authorization'
        balance_transaction:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/balance_transaction'
          description: ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/balance_transaction'
        card:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/issuing.card'
          description: The card used to make this transaction.
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/issuing.card'
        cardholder:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/issuing.cardholder'
          description: The cardholder to whom this transaction belongs.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/issuing.cardholder'
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: 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).
          type: string
        dispute:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/issuing.dispute'
          description: If you've disputed the transaction, the ID of the dispute.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/issuing.dispute'
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        merchant_amount:
          description: The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency.
          type: integer
        merchant_currency:
          description: The currency with which the merchant is taking payment.
          type: string
        merchant_data:
          $ref: '#/components/schemas/issuing_authorization_merchant_data'
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          type: object
        network_data:
          anyOf:
          - $ref: '#/components/schemas/issuing_transaction_network_data'
          description: Details about the transaction, such as processing dates, set by the card network.
          nullable: true
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - issuing.transaction
          type: string
        purchase_details:
          anyOf:
          - $ref: '#/components/schemas/issuing_transaction_purchase_details'
          description: Additional purchase information that is optionally provided by the merchant.
          nullable: true
        token:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/issuing.token'
          description: '[Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.'
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/issuing.token'
        treasury:
          anyOf:
          - $ref: '#/components/schemas/issuing_transaction_treasury'
          description: '[Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts'
          nullable: true
        type:
          description: The nature of the transaction.
          enum:
          - capture
          - refund
          type: string
          x-stripeBypassValidation: true
        wallet:
          description: The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`.
          enum:
          - apple_pay
          - google_pay
          - samsung_pay
          nullable: true
          type: string
      required:
      - amount
      - card
      - created
      - currency
      - id
      - livemode
      - merchant_amount
      - merchant_currency
      - merchant_data
      - metadata
      - object
      - type
      title: IssuingTransaction
      type: object
      x-expandableFields:
      - amount_details
      - authorization
      - balance_transaction
      - card
      - cardholder
      - dispute
      - merchant_data
      - network_data
      - purchase_details
      - token
      - treasury
      x-resourceId: issuing.transaction
    PostIdentityVerificationSessionsRequest:
      type: object
      required:
      - type
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        options:
          description: A set of options for the session’s verification checks.
          properties:
            document:
              anyOf:
              - properties:
                  allowed_types:
                    items:
                      enum:
                      - driving_license
                      - id_card
                      - passport
                      type: string
                    type: array
                  require_id_number:
                    type: boolean
                  require_live_capture:
                    type: boolean
                  require_matching_selfie:
                    type: boolean
                title: document_options
                type: object
              - enum:
                - ''
                type: string
          title: session_options_param
          type: object
        return_url:
          description: The URL that the user will be redirected to upon completing the verification flow.
          type: string
        type:
          description: The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
          enum:
          - document
          - id_number
          type: string
          x-stripeBypassValidation: true
    billing_portal.session:
      description: 'The Billing customer portal is a Stripe-hosted UI for subscription and

        billing management.


        A portal configuration describes the functionality and features that you

        want to provide to your customers through the portal.


        A portal session describes the instantiation of the customer portal for

        a particular customer. By visiting the session''s URL, the customer

        can manage their subscriptions and billing details. For security reasons,

        sessions are short-lived and will expire if the customer does not visit the URL.

        Create sessions on-demand when customers intend to manage their subscriptions

        and billing details.


        Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal).'
      properties:
        configuration:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/billing_portal.configuration'
          description: The configuration used by this session, describing the features available.
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/billing_portal.configuration'
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        customer:
          description: The ID of the customer for this session.
          maxLength: 5000
          type: string
        flow:
          anyOf:
          - $ref: '#/components/schemas/portal_flows_flow'
          description: Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
          nullable: true
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        locale:
          description: The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
          enum:
          - auto
          - bg
          - cs
          - da
          - de
          - el
          - en
          - en-AU
          - en-CA
          - en-GB
          - en-IE
          - en-IN
          - en-NZ
          - en-SG
          - 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
          nullable: true
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - billing_portal.session
          type: string
        on_behalf_of:
          description: The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
          maxLength: 5000
          nullable: true
          type: string
        return_url:
          description: The URL to redirect customers to when they click on the portal's link to return to your website.
          maxLength: 5000
          nullable: true
          type: string
        url:
          description: The short-lived URL of the session that gives customers access to the customer portal.
          maxLength: 5000
          type: string
      required:
      - configuration
      - created
      - customer
      - id
      - livemode
      - object
      - url
      title: PortalSession
      type: object
      x-expandableFields:
      - configuration
      - flow
      x-resourceId: billing_portal.session
    PostCustomersCustomerBankAccountsIdVerifyRequest:
      type: object
      properties:
        amounts:
          description: Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.
          items:
            type: integer
          type: array
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostCustomersCustomerCashBalanceRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        settings:
          description: A hash of settings for this cash balance.
          properties:
            reconciliation_mode:
              enum:
              - automatic
              - manual
              - merchant_default
              type: string
          title: balance_settings_param
          type: object
    PostCouponsCouponRequest:
      type: object
      properties:
        currency_options:
          additionalProperties:
            properties:
              amount_off:
                type: integer
            required:
            - amount_off
            title: currency_option
            type: object
          description: Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
          type: object
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        name:
          description: Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
          maxLength: 40
          type: string
    PostFinancialConnectionsSessionsRequest:
      type: object
      required:
      - account_holder
      - permissions
      properties:
        account_holder:
          description: The account holder to link accounts for.
          properties:
            account:
              maxLength: 5000
              type: string
            customer:
              maxLength: 5000
              type: string
            type:
              enum:
              - account
              - customer
              type: string
          required:
          - type
          title: accountholder_params
          type: object
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        filters:
          description: Filters to restrict the kinds of accounts to collect.
          properties:
            countries:
              items:
                maxLength: 5000
                type: string
              type: array
          required:
          - countries
          title: filters_params
          type: object
        permissions:
          description: 'List of data features that you would like to request access to.


            Possible values are `balances`, `transactions`, `ownership`, and `payment_method`.'
          items:
            enum:
            - balances
            - ownership
            - payment_method
            - transactions
            maxLength: 5000
            type: string
            x-stripeBypassValidation: true
          type: array
        prefetch:
          description: List of data features that you would like to retrieve upon account creation.
          items:
            enum:
            - balances
            - ownership
            - transactions
            type: string
            x-stripeBypassValidation: true
          type: array
        return_url:
          description: For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
          maxLength: 5000
          type: string
    PostCreditNotesIdVoidRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    invoiceitem:
      description: 'Invoice Items represent the component lines of an [invoice](https://stripe.com/docs/api/invoices). An invoice item is added to an

        invoice by creating or updating it with an `invoice` field, at which point it will be included as

        [an invoice line item](https://stripe.com/docs/api/invoices/line_item) within

        [invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines).


        Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined

        with a [subscription](https://stripe.com/docs/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge

        or credit the customer’s card only at the end of a regular billing cycle. This is useful for combining several charges

        (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.


        Related guides: [Integrate with the Invoicing API](https://stripe.com/docs/invoicing/integration), [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items).'
      properties:
        amount:
          description: Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.
          type: integer
        currency:
          description: 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).
          type: string
        customer:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/customer'
          - $ref: '#/components/schemas/deleted_customer'
          description: The ID of the customer who will be billed when this invoice item is billed.
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/customer'
            - $ref: '#/components/schemas/deleted_customer'
        date:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        description:
          description: An arbitrary string attached to the object. Often useful for displaying to users.
          maxLength: 5000
          nullable: true
          type: string
        discountable:
          description: If true, discounts will apply to this invoice item. Always false for prorations.
          type: boolean
        discounts:
          description: The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
          items:
            anyOf:
            - maxLength: 5000
              type: string
            - $ref: '#/components/schemas/discount'
            x-expansionResources:
              oneOf:
              - $ref: '#/components/schemas/discount'
          nullable: true
          type: array
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        invoice:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/invoice'
          description: The ID of the invoice this invoice item belongs to.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/invoice'
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          nullable: true
          type: object
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - invoiceitem
          type: string
        period:
          $ref: '#/components/schemas/invoice_line_item_period'
        price:
          anyOf:
          - $ref: '#/components/schemas/price'
          description: The price of the invoice item.
          nullable: true
        proration:
          description: Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
          type: boolean
        quantity:
          description: Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
          type: integer
        subscription:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/subscription'
          description: The subscription that this invoice item has been created for, if any.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/subscription'
        subscription_item:
          description: The subscription item that this invoice item has been created for, if any.
          maxLength: 5000
          type: string
        tax_rates:
          description: The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.
          items:
            $ref: '#/components/schemas/tax_rate'
          nullable: true
          type: array
        test_clock:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/test_helpers.test_clock'
          description: ID of the test clock this invoice item belongs to.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/test_helpers.test_clock'
        unit_amount:
          description: Unit amount (in the `currency` specified) of the invoice item.
          nullable: true
          type: integer
        unit_amount_decimal:
          description: Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
          format: decimal
          nullable: true
          type: string
      required:
      - amount
      - currency
      - customer
      - date
      - discountable
      - id
      - livemode
      - object
      - period
      - proration
      - quantity
      title: InvoiceItem
      type: object
      x-expandableFields:
      - customer
      - discounts
      - invoice
      - period
      - price
      - subscription
      - tax_rates
      - test_clock
      x-resourceId: invoiceitem
    PostPayoutsPayoutReverseRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
    subscription:
      description: 'Subscriptions allow you to charge a customer on a recurring basis.


        Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating)'
      properties:
        application:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/application'
          - $ref: '#/components/schemas/deleted_application'
          description: ID of the Connect Application that created the subscription.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/application'
            - $ref: '#/components/schemas/deleted_application'
        application_fee_percent:
          description: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
          nullable: true
          type: number
        automatic_tax:
          $ref: '#/components/schemas/subscription_automatic_tax'
        billing_cycle_anchor:
          description: Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
          format: unix-time
          type: integer
        billing_thresholds:
          anyOf:
          - $ref: '#/components/schemas/subscription_billing_thresholds'
          description: Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
          nullable: true
        cancel_at:
          description: A date in the future at which the subscription will automatically get canceled
          format: unix-time
          nullable: true
          type: integer
        cancel_at_period_end:
          description: 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.
          type: boolean
        canceled_at:
          description: If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
          format: unix-time
          nullable: true
          type: integer
        cancellation_details:
          anyOf:
          - $ref: '#/components/schemas/cancellation_details'
          description: Details about why this subscription was cancelled
          nullable: true
        collection_method:
          description: Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
          enum:
          - charge_automatically
          - send_invoice
          type: string
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: 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).
          type: string
        current_period_end:
          description: End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
          format: unix-time
          type: integer
        current_period_start:
          description: Start of the current period that the subscription has been invoiced for.
          format: unix-time
          type: integer
        customer:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/customer'
          - $ref: '#/components/schemas/deleted_customer'
          description: ID of the customer who owns the subscription.
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/customer'
            - $ref: '#/components/schemas/deleted_customer'
        days_until_due:
          description: Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
          nullable: true
          type: integer
        default_payment_method:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/payment_method'
          description: ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/payment_method'
        default_source:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/bank_account'
          - $ref: '#/components/schemas/card'
          - $ref: '#/components/schemas/source'
          description: ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/bank_account'
            - $ref: '#/components/schemas/card'
            - $ref: '#/components/schemas/source'
          x-stripeBypassValidation: true
        default_tax_rates:
          description: 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.
          items:
            $ref: '#/components/schemas/tax_rate'
          nullable: true
          type: array
        description:
          description: The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
          maxLength: 500
          nullable: true
          type: string
        discount:
          anyOf:
          - $ref: '#/components/schemas/discount'
          description: Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.
          nullable: true
        ended_at:
          description: If the subscription has ended, the date the subscription ended.
          format: unix-time
          nullable: true
          type: integer
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        items:
          description: List of subscription items, each with an attached price.
          properties:
            data:
              description: Details about each object.
              items:
                $ref: '#/components/schemas/subscription_item'
              type: array
            has_more:
              description: True if this list has another page of items after this one that can be fetched.
              type: boolean
            object:
              description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
              enum:
              - list
              type: string
            url:
              description: The URL where this list can be accessed.
              maxLength: 5000
              type: string
          required:
          - data
          - has_more
          - object
          - url
          title: SubscriptionItemList
          type: object
          x-expandableFields:
          - data
        latest_invoice:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/invoice'
          description: The most recent invoice this subscription has generated.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/invoice'
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          type: object
        next_pending_invoice_item_invoice:
          description: Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.
          format: unix-time
          nullable: true
          type: integer
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - subscription
          type: string
        on_behalf_of:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/account'
          description: The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/account'
        pause_collection:
          anyOf:
          - $ref: '#/components/schemas/subscriptions_resource_pause_collection'
          description: If specified, payment collection for this subscription will be paused.
          nullable: true
        payment_settings:
          anyOf:
          - $ref: '#/components/schemas/subscriptions_resource_payment_settings'
          description: Payment settings passed on to invoices created by the subscription.
          nullable: true
        pending_invoice_item_interval:
          anyOf:
          - $ref: '#/components/schemas/subscription_pending_invoice_item_interval'
          description: Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
          nullable: true
        pending_setup_intent:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/setup_intent'
          description: You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) 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. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2).
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/setup_intent'
        pending_update:
          anyOf:
          - $ref: '#/components/schemas/subscriptions_resource_pending_update'
          description: If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
          nullable: true
        schedule:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/subscription_schedule'
          description: The schedule attached to the subscription
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/subscription_schedule'
        start_date:
          description: Date when the subscription was first created. The date might differ from the `created` date due to backdating.
          format: unix-time
          type: integer
        status:
          description: "Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` state. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal state, the open invoice will be voided and no further invoices will be generated. \n\nA subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. \n\nIf subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). \n\nIf subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices."
          enum:
          - active
          - canceled
          - incomplete
          - incomplete_expired
          - past_due
          - paused
          - trialing
          - unpaid
          type: string
        test_clock:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/test_helpers.test_clock'
          description: ID of the test clock this subscription belongs to.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/test_helpers.test_clock'
        transfer_data:
          anyOf:
          - $ref: '#/components/schemas/subscription_transfer_data'
          description: The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
          nullable: true
        trial_end:
          description: If the subscription has a trial, the end of that trial.
          format: unix-time
          nullable: true
          type: integer
        trial_settings:
          anyOf:
          - $ref: '#/components/schemas/subscriptions_trials_resource_trial_settings'
          description: Settings related to subscription trials.
          nullable: true
        trial_start:
          description: If the subscription has a trial, the beginning of that trial.
          format: unix-time
          nullable: true
          type: integer
      required:
      - automatic_tax
      - billing_cycle_anchor
      - cancel_at_period_end
      - collection_method
      - created
      - currency
      - current_period_end
      - current_period_start
      - customer
      - id
      - items
      - livemode
      - metadata
      - object
      - start_date
      - status
      title: Subscription
      type: object
      x-expandableFields:
      - application
      - automatic_tax
      - billing_thresholds
      - cancellation_details
      - customer
      - default_payment_method
      - default_source
      - default_tax_rates
      - discount
      - items
      - latest_invoice
      - on_behalf_of
      - pause_collection
      - payment_settings
      - pending_invoice_item_interval
      - pending_setup_intent
      - pending_update
      - schedule
      - test_clock
      - transfer_data
      - trial_settings
      x-resourceId: subscription
    PostPaymentIntentsIntentApplyCustomerBalanceRequest:
      type: object
      properties:
        amount:
          description: 'Amount that you intend to apply to this PaymentIntent from the customer’s cash balance.


            A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency).


            The maximum amount is the amount of the PaymentIntent.


            When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent.'
          type: integer
        currency:
          description: 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).
          type: string
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    issuing.cardholder:
      description: 'An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards.


        Related guide: [How to create a cardholder](https://stripe.com/docs/issuing/cards#create-cardholder)'
      properties:
        billing:
          $ref: '#/components/schemas/issuing_cardholder_address'
        company:
          anyOf:
          - $ref: '#/components/schemas/issuing_cardholder_company'
          description: Additional information about a `company` cardholder.
          nullable: true
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        email:
          description: The cardholder's email address.
          maxLength: 5000
          nullable: true
          type: string
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        individual:
          anyOf:
          - $ref: '#/components/schemas/issuing_cardholder_individual'
          description: Additional information about an `individual` cardholder.
          nullable: true
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          type: object
        name:
          description: The cardholder's name. This will be printed on cards issued to them.
          maxLength: 5000
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - issuing.cardholder
          type: string
        phone_number:
          description: The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.
          maxLength: 5000
          nullable: true
          type: string
        preferred_locales:
          description: "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder."
          items:
            enum:
            - de
            - en
            - es
            - fr
            - it
            type: string
          nullable: true
          type: array
        requirements:
          $ref: '#/components/schemas/issuing_cardholder_requirements'
        spending_controls:
          anyOf:
          - $ref: '#/components/schemas/issuing_cardholder_authorization_controls'
          description: Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
          nullable: true
        status:
          description: Specifies whether to permit authorizations on this cardholder's cards.
          enum:
          - active
          - blocked
          - inactive
          type: string
        type:
          description: One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details.
          enum:
          - company
          - individual
          type: string
          x-stripeBypassValidation: true
      required:
      - billing
      - created
      - id
      - livemode
      - metadata
      - name
      - object
      - requirements
      - status
      - type
      title: IssuingCardholder
      type: object
      x-expandableFields:
      - billing
      - company
      - individual
      - requirements
      - spending_controls
      x-resourceId: issuing.cardholder
    invoice:
      description: 'Invoices are statements of amounts owed by a customer, and are either

        generated one-off, or generated periodically from a subscription.


        They contain [invoice items](https://stripe.com/docs/api#Invoice Items), and proration adjustments

        that may be caused by subscription upgrades/downgrades (if necessary).


        If your invoice is configured to be billed through automatic charges,

        Stripe automatically finalizes your invoice and attempts payment. Note

        that finalizing the invoice,

        [when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does

        not happen immediately as the invoice is created. Stripe waits

        until one hour after the last webhook was successfully sent (or the last

        webhook timed out after failing). If you (and the platforms you may have

        connected to) have no webhooks configured, Stripe waits one hour after

        creation to finalize the invoice.


        If your invoice is configured to be billed by sending an email, then based on your

        [email settings](https://dashboard.stripe.com/account/billing/automatic),

        Stripe will email the invoice to your customer and await payment. These

        emails can contain a link to a hosted page to pay the invoice.


        Stripe applies any customer credit on the account before determining the

        amount due for the invoice (i.e., the amount that will be actually

        charged). If the amount due for the invoice is less than Stripe''s [minimum allowed charge

        per currency](/docs/currencies#minimum-and-maximum-charge-amounts), the

        invoice is automatically marked paid, and we add the amount due to the

        customer''s credit balance which is applied to the next invoice.


        More details on the customer''s credit balance are

        [here](https://stripe.com/docs/billing/customer/balance).


        Related guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)'
      properties:
        account_country:
          description: The country of the business associated with this invoice, most often the business creating the invoice.
          maxLength: 5000
          nullable: true
          type: string
        account_name:
          description: The public name of the business associated with this invoice, most often the business creating the invoice.
          maxLength: 5000
          nullable: true
          type: string
        account_tax_ids:
          description: The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
          items:
            anyOf:
            - maxLength: 5000
              type: string
            - $ref: '#/components/schemas/tax_id'
            - $ref: '#/components/schemas/deleted_tax_id'
            x-expansionResources:
              oneOf:
              - $ref: '#/components/schemas/tax_id'
              - $ref: '#/components/schemas/deleted_tax_id'
          nullable: true
          type: array
        amount_due:
          description: Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.
          type: integer
        amount_paid:
          description: The amount, in cents (or local equivalent), that was paid.
          type: integer
        amount_remaining:
          description: The difference between amount_due and amount_paid, in cents (or local equivalent).
          type: integer
        amount_shipping:
          description: This is the sum of all the shipping amounts.
          type: integer
        application:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/application'
          - $ref: '#/components/schemas/deleted_application'
          description: ID of the Connect Application that created the invoice.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/application'
            - $ref: '#/components/schemas/deleted_application'
        application_fee_amount:
          description: The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.
          nullable: true
          type: integer
        attempt_count:
          description: Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.
          type: integer
        attempted:
          description: Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.
          type: boolean
        auto_advance:
          description: Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.
          type: boolean
        automatic_tax:
          $ref: '#/components/schemas/automatic_tax'
        billing_reason:
          description: 'Indicates the reason why the invoice was created.


            * `manual`: Unrelated to a subscription, for example, created via the invoice editor.

            * `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.

            * `subscription_create`: A new subscription was created.

            * `subscription_cycle`: A subscription advanced into a new period.

            * `subscription_threshold`: A subscription reached a billing threshold.

            * `subscription_update`: A subscription was updated.

            * `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.'
          enum:
          - automatic_pending_invoice_item_invoice
          - manual
          - quote_accept
          - subscription
          - subscription_create
          - subscription_cycle
          - subscription_threshold
          - subscription_update
          - upcoming
          nullable: true
          type: string
        charge:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/charge'
          description: ID of the latest charge generated for this invoice, if any.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/charge'
        collection_method:
          description: Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
          enum:
          - charge_automatically
          - send_invoice
          type: string
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        currency:
          description: 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).
          type: string
        custom_fields:
          description: Custom fields displayed on the invoice.
          items:
            $ref: '#/components/schemas/invoice_setting_custom_field'
          nullable: true
          type: array
        customer:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/customer'
          - $ref: '#/components/schemas/deleted_customer'
          description: The ID of the customer who will be billed.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/customer'
            - $ref: '#/components/schemas/deleted_customer'
        customer_address:
          anyOf:
          - $ref: '#/components/schemas/address'
          description: The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
          nullable: true
        customer_email:
          description: The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.
          maxLength: 5000
          nullable: true
          type: string
        customer_name:
          description: The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.
          maxLength: 5000
          nullable: true
          type: string
        customer_phone:
          description: The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.
          maxLength: 5000
          nullable: true
          type: string
        customer_shipping:
          anyOf:
          - $ref: '#/components/schemas/shipping'
          description: The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.
          nullable: true
        customer_tax_exempt:
          description: The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.
          enum:
          - exempt
          - none
          - reverse
          nullable: true
          type: string
        customer_tax_ids:
          description: The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.
          items:
            $ref: '#/components/schemas/invoices_resource_invoice_tax_id'
          nullable: true
          type: array
        default_payment_method:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/payment_method'
          description: ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/payment_method'
        default_source:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/bank_account'
          - $ref: '#/components/schemas/card'
          - $ref: '#/components/schemas/source'
          description: ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/bank_account'
            - $ref: '#/components/schemas/card'
            - $ref: '#/components/schemas/source'
          x-stripeBypassValidation: true
        default_tax_rates:
          description: The tax rates applied to this invoice, if any.
          items:
            $ref: '#/components/schemas/tax_rate'
          type: array
        description:
          description: An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
          maxLength: 5000
          nullable: true
          type: string
        discount:
          anyOf:
          - $ref: '#/components/schemas/discount'
          description: Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.
          nullable: true
        discounts:
          description: The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
          items:
            anyOf:
            - maxLength: 5000
              type: string
            - $ref: '#/components/schemas/discount'
            - $ref: '#/components/schemas/deleted_discount'
            x-expansionResources:
              oneOf:
              - $ref: '#/components/schemas/discount'
              - $ref: '#/components/schemas/deleted_discount'
          nullable: true
          type: array
        due_date:
          description: The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.
          format: unix-time
          nullable: true
          type: integer
        effective_at:
          description: The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
          format: unix-time
          nullable: true
          type: integer
        ending_balance:
          description: Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
          nullable: true
          type: integer
        footer:
          description: Footer displayed on the invoice.
          maxLength: 5000
          nullable: true
          type: string
        from_invoice:
          anyOf:
          - $ref: '#/components/schemas/invoices_from_invoice'
          description: Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.
          nullable: true
        hosted_invoice_url:
          description: The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
          maxLength: 5000
          nullable: true
          type: string
        id:
          description: Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details.
          maxLength: 5000
          type: string
        invoice_pdf:
          description: The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
          maxLength: 5000
          nullable: true
          type: string
        last_finalization_error:
          anyOf:
          - $ref: '#/components/schemas/api_errors'
          description: The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
          nullable: true
        latest_revision:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/invoice'
          description: The ID of the most recent non-draft revision of this invoice
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/invoice'
        lines:
          description: 'The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.'
          properties:
            data:
              description: Details about each object.
              items:
                $ref: '#/components/schemas/line_item'
              type: array
            has_more:
              description: True if this list has another page of items after this one that can be fetched.
              type: boolean
            object:
              description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
              enum:
              - list
              type: string
            url:
              description: The URL where this list can be accessed.
              maxLength: 5000
              type: string
          required:
          - data
          - has_more
          - object
          - url
          title: InvoiceLinesList
          type: object
          x-expandableFields:
          - data
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          nullable: true
          type: object
        next_payment_attempt:
          description: The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.
          format: unix-time
          nullable: true
          type: integer
        number:
          description: A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
          maxLength: 5000
          nullable: true
          type: string
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - invoice
          type: string
        on_behalf_of:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/account'
          description: The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/account'
        paid:
          description: Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.
          type: boolean
        paid_out_of_band:
          description: Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe.
          type: boolean
        payment_intent:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/payment_intent'
          description: The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/payment_intent'
        payment_settings:
          $ref: '#/components/schemas/invoices_payment_settings'
        period_end:
          description: End of the usage period during which invoice items were added to this invoice.
          format: unix-time
          type: integer
        period_start:
          description: Start of the usage period during which invoice items were added to this invoice.
          format: unix-time
          type: integer
        post_payment_credit_notes_amount:
          description: Total amount of all post-payment credit notes issued for this invoice.
          type: integer
        pre_payment_credit_notes_amount:
          description: Total amount of all pre-payment credit notes issued for this invoice.
          type: integer
        quote:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/quote'
          description: The quote this invoice was generated from.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/quote'
        receipt_number:
          description: This is the transaction number that appears on email receipts sent for this invoice.
          maxLength: 5000
          nullable: true
          type: string
        rendering:
          anyOf:
          - $ref: '#/components/schemas/invoices_invoice_rendering'
          description: The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
          nullable: true
        shipping_cost:
          anyOf:
          - $ref: '#/components/schemas/invoices_shipping_cost'
          description: The details of the cost of shipping, including the ShippingRate applied on the invoice.
          nullable: true
        shipping_details:
          anyOf:
          - $ref: '#/components/schemas/shipping'
          description: Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.
          nullable: true
        starting_balance:
          description: Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
          type: integer
        statement_descriptor:
          description: Extra information about an invoice for the customer's credit card statement.
          maxLength: 5000
          nullable: true
          type: string
        status:
          description: The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)
          enum:
          - draft
          - open
          - paid
          - uncollectible
          - void
          nullable: true
          type: string
          x-stripeBypassValidation: true
        status_transitions:
          $ref: '#/components/schemas/invoices_status_transitions'
        subscription:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/subscription'
          description: The subscription that this invoice was prepared for, if any.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/subscription'
        subscription_details:
          anyOf:
          - $ref: '#/components/schemas/subscription_details_data'
          description: Details about the subscription that created this invoice.
          nullable: true
        subscription_proration_date:
          description: Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
          type: integer
        subtotal:
          description: Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
          type: integer
        subtotal_excluding_tax:
          description: The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
          nullable: true
          type: integer
        tax:
          description: The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.
          nullable: true
          type: integer
        test_clock:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/test_helpers.test_clock'
          description: ID of the test clock this invoice belongs to.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/test_helpers.test_clock'
        threshold_reason:
          $ref: '#/components/schemas/invoice_threshold_reason'
        total:
          description: Total after discounts and taxes.
          type: integer
        total_discount_amounts:
          description: The aggregate amounts calculated per discount across all line items.
          items:
            $ref: '#/components/schemas/discounts_resource_discount_amount'
          nullable: true
          type: array
        total_excluding_tax:
          description: The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
          nullable: true
          type: integer
        total_tax_amounts:
          description: The aggregate amounts calculated per tax rate for all line items.
          items:
            $ref: '#/components/schemas/invoice_tax_amount'
          type: array
        transfer_data:
          anyOf:
          - $ref: '#/components/schemas/invoice_transfer_data'
          description: The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.
          nullable: true
        webhooks_delivered_at:
          description: Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
          format: unix-time
          nullable: true
          type: integer
      required:
      - amount_due
      - amount_paid
      - amount_remaining
      - amount_shipping
      - attempt_count
      - attempted
      - automatic_tax
      - collection_method
      - created
      - currency
      - default_tax_rates
      - lines
      - livemode
      - object
      - paid
      - paid_out_of_band
      - payment_settings
      - period_end
      - period_start
      - post_payment_credit_notes_amount
      - pre_payment_credit_notes_amount
      - starting_balance
      - status_transitions
      - subtotal
      - total
      - total_tax_amounts
      title: Invoice
      type: object
      x-expandableFields:
      - account_tax_ids
      - application
      - automatic_tax
      - charge
      - custom_fields
      - customer
      - customer_address
      - customer_shipping
      - customer_tax_ids
      - default_payment_method
      - default_source
      - default_tax_rates
      - discount
      - discounts
      - from_invoice
      - last_finalization_error
      - latest_revision
      - lines
      - on_behalf_of
      - payment_intent
      - payment_settings
      - quote
      - rendering
      - shipping_cost
      - shipping_details
      - status_transitions
      - subscription
      - subscription_details
      - test_clock
      - threshold_reason
      - total_discount_amounts
      - total_tax_amounts
      - transfer_data
      x-resourceId: invoice
    PostPaymentMethodDomainsPaymentMethodDomainRequest:
      type: object
      properties:
        enabled:
          description: Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.
          type: boolean
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
    PostInvoicesRequest:
      type: object
      properties:
        account_tax_ids:
          anyOf:
          - items:
              maxLength: 5000
              type: string
            type: array
          - enum:
            - ''
            type: string
          description: The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
        application_fee_amount:
          description: A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
          type: integer
        auto_advance:
          description: Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.
          type: boolean
        automatic_tax:
          description: Settings for automatic tax lookup for this invoice.
          properties:
            enabled:
              type: boolean
          required:
          - enabled
          title: automatic_tax_param
          type: object
        collection_method:
          description: Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`.
          enum:
          - charge_automatically
          - send_invoice
          type: string
        currency:
          description: The currency to create this invoice in. Defaults to that of `customer` if not specified.
          type: string
        custom_fields:
          anyOf:
          - items:
              properties:
                name:
                  maxLength: 30
                  type: string
                value:
                  maxLength: 30
                  type: string
              required:
              - name
              - value
              title: custom_field_params
              type: object
            type: array
          - enum:
            - ''
            type: string
          description: A list of up to 4 custom fields to be displayed on the invoice.
        customer:
          description: The ID of the customer who will be billed.
          maxLength: 5000
          type: string
        days_until_due:
          description: The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
          type: integer
        default_payment_method:
          description: ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
          maxLength: 5000
          type: string
        default_source:
          description: ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
          maxLength: 5000
          type: string
        default_tax_rates:
          description: The tax rates that will apply to any line item that does not have `tax_rates` set.
          items:
            maxLength: 5000
            type: string
          type: array
        description:
          description: An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
          maxLength: 1500
          type: string
        discounts:
          anyOf:
          - items:
              properties:
                coupon:
                  maxLength: 5000
                  type: string
                discount:
                  maxLength: 5000
                  type: string
              title: discounts_data_param
              type: object
            type: array
          - enum:
            - ''
            type: string
          description: The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts.
        due_date:
          description: The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`.
          format: unix-time
          type: integer
        effective_at:
          description: The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
          format: unix-time
          type: integer
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        footer:
          description: Footer to be displayed on the invoice.
          maxLength: 5000
          type: string
        from_invoice:
          description: Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.
          properties:
            action:
              enum:
              - revision
              maxLength: 5000
              type: string
            invoice:
              maxLength: 5000
              type: string
          required:
          - action
          - invoice
          title: from_invoice
          type: object
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        on_behalf_of:
          description: The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
          type: string
        payment_settings:
          description: Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
          properties:
            default_mandate:
              anyOf:
              - maxLength: 5000
                type: string
              - enum:
                - ''
                type: string
            payment_method_options:
              properties:
                acss_debit:
                  anyOf:
                  - properties:
                      mandate_options:
                        properties:
                          transaction_type:
                            enum:
                            - business
                            - personal
                            type: string
                        title: mandate_options_param
                        type: object
                      verification_method:
                        enum:
                        - automatic
                        - instant
                        - microdeposits
                        type: string
                        x-stripeBypassValidation: true
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                bancontact:
                  anyOf:
                  - properties:
                      preferred_language:
                        enum:
                        - de
                        - en
                        - fr
                        - nl
                        type: string
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                card:
                  anyOf:
                  - properties:
                      installments:
                        properties:
                          enabled:
                            type: boolean
                          plan:
                            anyOf:
                            - properties:
                                count:
                                  type: integer
                                interval:
                                  enum:
                                  - month
                                  type: string
                                type:
                                  enum:
                                  - fixed_count
                                  type: string
                              required:
                              - count
                              - interval
                              - type
                              title: installment_plan
                              type: object
                            - enum:
                              - ''
                              type: string
                        title: installments_param
                        type: object
                      request_three_d_secure:
                        enum:
                        - any
                        - automatic
                        type: string
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                customer_balance:
                  anyOf:
                  - properties:
                      bank_transfer:
                        properties:
                          eu_bank_transfer:
                            properties:
                              country:
                                maxLength: 5000
                                type: string
                            required:
                            - country
                            title: eu_bank_transfer_param
                            type: object
                          type:
                            type: string
                        title: bank_transfer_param
                        type: object
                      funding_type:
                        type: string
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                konbini:
                  anyOf:
                  - properties: {}
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
                us_bank_account:
                  anyOf:
                  - properties:
                      financial_connections:
                        properties:
                          permissions:
                            items:
                              enum:
                              - balances
                              - ownership
                              - payment_method
                              - transactions
                              maxLength: 5000
                              type: string
                              x-stripeBypassValidation: true
                            type: array
                          prefetch:
                            items:
                              enum:
                              - balances
                              - transactions
                              type: string
                              x-stripeBypassValidation: true
                            type: array
                        title: invoice_linked_account_options_param
                        type: object
                      verification_method:
                        enum:
                        - automatic
                        - instant
                        - microdeposits
                        type: string
                        x-stripeBypassValidation: true
                    title: invoice_payment_method_options_param
                    type: object
                  - enum:
                    - ''
                    type: string
              title: payment_method_options
              type: object
            payment_method_types:
              anyOf:
              - items:
                  enum:
                  - ach_credit_transfer
                  - ach_debit
                  - acss_debit
                  - au_becs_debit
                  - bacs_debit
                  - bancontact
                  - boleto
                  - card
                  - cashapp
                  - customer_balance
                  - fpx
                  - giropay
                  - grabpay
                  - ideal
                  - konbini
                  - link
                  - paynow
                  - paypal
                  - promptpay
                  - sepa_debit
                  - sofort
                  - us_bank_account
                  - wechat_pay
                  type: string
                  x-stripeBypassValidation: true
                type: array
              - enum:
                - ''
                type: string
          title: payment_settings
          type: object
        pending_invoice_items_behavior:
          description: How to handle pending invoice items on invoice creation. One of `include` or `exclude`. `include` will include any pending invoice items, and will create an empty draft invoice if no pending invoice items exist. `exclude` will always create an empty invoice draft regardless if there are pending invoice items or not. Defaults to `exclude` if the parameter is omitted.
          enum:
          - exclude
          - include
          - include_and_require
          type: string
        rendering:
          description: The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
          properties:
            amount_tax_display:
              enum:
              - ''
              - exclude_tax
              - include_inclusive_tax
              type: string
            pdf:
              properties:
                page_size:
                  enum:
                  - a4
                  - auto
                  - letter
                  type: string
              title: rendering_pdf_param
              type: object
          title: rendering_param
          type: object
        shipping_cost:
          description: Settings for the cost of shipping for this invoice.
          properties:
            shipping_rate:
              maxLength: 5000
              type: string
            shipping_rate_data:
              properties:
                delivery_estimate:
                  properties:
                    maximum:
                      properties:
                        unit:
                          enum:
                          - business_day
                          - day
                          - hour
                          - month
                          - week
                          type: string
                        value:
                          type: integer
                      required:
                      - unit
                      - value
                      title: delivery_estimate_bound
                      type: object
                    minimum:
                      properties:
                        unit:
                          enum:
                          - business_day
                          - day
                          - hour
                          - month
                          - week
                          type: string
                        value:
                          type: integer
                      required:
                      - unit
                      - value
                      title: delivery_estimate_bound
                      type: object
                  title: delivery_estimate
                  type: object
                display_name:
                  maxLength: 100
                  type: string
                fixed_amount:
                  properties:
                    amount:
                      type: integer
                    currency:
                      type: string
                    currency_options:
                      additionalProperties:
                        properties:
                          amount:
                            type: integer
                          tax_behavior:
                            enum:
                            - exclusive
                            - inclusive
                            - unspecified
                            type: string
                        required:
                        - amount
                        title: currency_option
                        type: object
                      type: object
                  required:
                  - amount
                  - currency
                  title: fixed_amount
                  type: object
                metadata:
                  additionalProperties:
                    type: string
                  type: object
                tax_behavior:
                  enum:
                  - exclusive
                  - inclusive
                  - unspecified
                  type: string
                tax_code:
                  type: string
                type:
                  enum:
                  - fixed_amount
                  type: string
              required:
              - display_name
              title: method_params
              type: object
          title: shipping_cost
          type: object
        shipping_details:
          description: Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.
          properties:
            address:
              properties:
                city:
                  maxLength: 5000
                  type: string
                country:
                  maxLength: 5000
                  type: string
                line1:
                  maxLength: 5000
                  type: string
                line2:
                  maxLength: 5000
                  type: string
                postal_code:
                  maxLength: 5000
                  type: string
                state:
                  maxLength: 5000
                  type: string
              title: optional_fields_address
              type: object
            name:
              maxLength: 5000
              type: string
            phone:
              anyOf:
              - maxLength: 5000
                type: string
              - enum:
                - ''
                type: string
          required:
          - address
          - name
          title: recipient_shipping_with_optional_fields_address
          type: object
        statement_descriptor:
          description: Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.
          maxLength: 22
          type: string
        subscription:
          description: The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected.
          maxLength: 5000
          type: string
        transfer_data:
          description: If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
          properties:
            amount:
              type: integer
            destination:
              type: string
          required:
          - destination
          title: transfer_data_specs
          type: object
    tax_id:
      description: 'You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account.

        Customer and account tax IDs get displayed on related invoices and credit notes.


        Related guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)'
      properties:
        country:
          description: Two-letter ISO code representing the country of the tax ID.
          maxLength: 5000
          nullable: true
          type: string
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        customer:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/customer'
          description: ID of the customer.
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/customer'
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - tax_id
          type: string
        type:
          description: Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`
          enum:
          - ad_nrt
          - ae_trn
          - ar_cuit
          - au_abn
          - au_arn
          - bg_uic
          - bo_tin
          - br_cnpj
          - br_cpf
          - ca_bn
          - ca_gst_hst
          - ca_pst_bc
          - ca_pst_mb
          - ca_pst_sk
          - ca_qst
          - ch_vat
          - cl_tin
          - cn_tin
          - co_nit
          - cr_tin
          - do_rcn
          - ec_ruc
          - eg_tin
          - es_cif
          - eu_oss_vat
          - eu_vat
          - gb_vat
          - ge_vat
          - hk_br
          - hu_tin
          - id_npwp
          - il_vat
          - in_gst
          - is_vat
          - jp_cn
          - jp_rn
          - jp_trn
          - ke_pin
          - kr_brn
          - li_uid
          - mx_rfc
          - my_frp
          - my_itn
          - my_sst
          - no_vat
          - nz_gst
          - pe_ruc
          - ph_tin
          - ro_tin
          - rs_pib
          - ru_inn
          - ru_kpp
          - sa_vat
          - sg_gst
          - sg_uen
          - si_tin
          - sv_nit
          - th_vat
          - tr_tin
          - tw_vat
          - ua_vat
          - unknown
          - us_ein
          - uy_ruc
          - ve_rif
          - vn_tin
          - za_vat
          type: string
        value:
          description: Value of the tax ID.
          maxLength: 5000
          type: string
        verification:
          anyOf:
          - $ref: '#/components/schemas/tax_id_verification'
          description: Tax ID verification information.
          nullable: true
      required:
      - created
      - id
      - livemode
      - object
      - type
      - value
      title: tax_id
      type: object
      x-expandableFields:
      - customer
      - verification
      x-resourceId: tax_id
    PostIssuingAuthorizationsAuthorizationDeclineRequest:
      type: object
      properties:
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
    PostPaymentIntentsIntentCaptureRequest:
      type: object
      properties:
        amount_to_capture:
          description: The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount is automatically refunded. Defaults to the full `amount_capturable` if it's not provided.
          type: integer
        application_fee_amount:
          description: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
          type: integer
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        final_capture:
          description: Defaults to `true`. When capturing a PaymentIntent, setting `final_capture` to `false` notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when [multicapture](https://stripe.com/docs/payments/multicapture) is available for PaymentIntents.
          type: boolean
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        statement_descriptor:
          description: For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.
          maxLength: 22
          type: string
        statement_descriptor_suffix:
          description: Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. The concatenated descriptor must be 1-22 characters long.
          maxLength: 22
          type: string
        transfer_data:
          description: 'The parameters that you can use to automatically create a transfer after the payment

            is captured. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).'
          properties:
            amount:
              type: integer
          title: transfer_data_update_params
          type: object
    identity.verification_session:
      description: 'A VerificationSession guides you through the process of collecting and verifying the identities

        of your users. It contains details about the type of verification, such as what [verification

        check](/docs/identity/verification-checks) to perform. Only create one VerificationSession for

        each verification in your system.


        A VerificationSession transitions through [multiple

        statuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through

        the verification flow. The VerificationSession contains the user''s verified data after

        verification checks are complete.


        Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)'
      properties:
        client_secret:
          description: The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.
          maxLength: 5000
          nullable: true
          type: string
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        last_error:
          anyOf:
          - $ref: '#/components/schemas/gelato_session_last_error'
          description: If present, this property tells you the last error encountered when processing the verification.
          nullable: true
        last_verification_report:
          anyOf:
          - maxLength: 5000
            type: string
          - $ref: '#/components/schemas/identity.verification_report'
          description: ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)
          nullable: true
          x-expansionResources:
            oneOf:
            - $ref: '#/components/schemas/identity.verification_report'
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: 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.
          type: object
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - identity.verification_session
          type: string
        options:
          anyOf:
          - $ref: '#/components/schemas/gelato_verification_session_options'
          description: A set of options for the session’s verification checks.
          nullable: true
        redaction:
          anyOf:
          - $ref: '#/components/schemas/verification_session_redaction'
          description: Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.
          nullable: true
        status:
          description: Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
          enum:
          - canceled
          - processing
          - requires_input
          - verified
          type: string
        type:
          description: The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
          enum:
          - document
          - id_number
          nullable: true
          type: string
          x-stripeBypassValidation: true
        url:
          description: The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.
          maxLength: 5000
          nullable: true
          type: string
        verified_outputs:
          anyOf:
          - $ref: '#/components/schemas/gelato_verified_outputs'
          description: The user’s verified data.
          nullable: true
      required:
      - created
      - id
      - livemode
      - metadata
      - object
      - status
      title: GelatoVerificationSession
      type: object
      x-expandableFields:
      - last_error
      - last_verification_report
      - options
      - redaction
      - verified_outputs
      x-resourceId: identity.verification_session
    PostIssuingDisputesRequest:
      type: object
      properties:
        amount:
          description: The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If not set, defaults to the full transaction amount.
          type: integer
        evidence:
          description: Evidence provided for the dispute.
          properties:
            canceled:
              anyOf:
              - properties:
                  additional_documentation:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  canceled_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                  cancellation_policy_provided:
                    anyOf:
                    - type: boolean
                    - enum:
                      - ''
                      type: string
                  cancellation_reason:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  expected_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                  explanation:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  product_description:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  product_type:
                    enum:
                    - ''
                    - merchandise
                    - service
                    type: string
                  return_status:
                    enum:
                    - ''
                    - merchant_rejected
                    - successful
                    type: string
                  returned_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                title: canceled
                type: object
              - enum:
                - ''
                type: string
            duplicate:
              anyOf:
              - properties:
                  additional_documentation:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  card_statement:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  cash_receipt:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  check_image:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  explanation:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  original_transaction:
                    maxLength: 5000
                    type: string
                title: duplicate
                type: object
              - enum:
                - ''
                type: string
            fraudulent:
              anyOf:
              - properties:
                  additional_documentation:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  explanation:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                title: fraudulent
                type: object
              - enum:
                - ''
                type: string
            merchandise_not_as_described:
              anyOf:
              - properties:
                  additional_documentation:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  explanation:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  received_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                  return_description:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  return_status:
                    enum:
                    - ''
                    - merchant_rejected
                    - successful
                    type: string
                  returned_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                title: merchandise_not_as_described
                type: object
              - enum:
                - ''
                type: string
            not_received:
              anyOf:
              - properties:
                  additional_documentation:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  expected_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                  explanation:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  product_description:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  product_type:
                    enum:
                    - ''
                    - merchandise
                    - service
                    type: string
                title: not_received
                type: object
              - enum:
                - ''
                type: string
            other:
              anyOf:
              - properties:
                  additional_documentation:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  explanation:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  product_description:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  product_type:
                    enum:
                    - ''
                    - merchandise
                    - service
                    type: string
                title: other
                type: object
              - enum:
                - ''
                type: string
            reason:
              enum:
              - canceled
              - duplicate
              - fraudulent
              - merchandise_not_as_described
              - not_received
              - other
              - service_not_as_described
              type: string
              x-stripeBypassValidation: true
            service_not_as_described:
              anyOf:
              - properties:
                  additional_documentation:
                    anyOf:
                    - type: string
                    - enum:
                      - ''
                      type: string
                  canceled_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                  cancellation_reason:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  explanation:
                    anyOf:
                    - maxLength: 1500
                      type: string
                    - enum:
                      - ''
                      type: string
                  received_at:
                    anyOf:
                    - format: unix-time
                      type: integer
                    - enum:
                      - ''
                      type: string
                title: service_not_as_described
                type: object
              - enum:
                - ''
                type: string
          title: evidence_param
          type: object
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        metadata:
          additionalProperties:
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          type: object
        transaction:
          description: The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`.
          maxLength: 5000
          type: string
        treasury:
          description: Params for disputes related to Treasury FinancialAccounts
          properties:
            received_debit:
              maxLength: 5000
              type: string
          required:
          - received_debit
          title: treasury_param
          type: object
    ephemeral_key:
      description: ''
      properties:
        created:
          description: Time at which the object was created. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        expires:
          description: Time at which the key will expire. Measured in seconds since the Unix epoch.
          format: unix-time
          type: integer
        id:
          description: Unique identifier for the object.
          maxLength: 5000
          type: string
        livemode:
          description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          type: boolean
        object:
          description: String representing the object's type. Objects of the same type share the same value.
          enum:
          - ephemeral_key
          type: string
        secret:
          description: The key's secret. You can use this value to make authorized requests to the Stripe API.
          maxLength: 5000
          type: string
      required:
      - created
      - expires
      - id
      - livemode
      - object
      title: EphemeralKey
      type: object
      x-expandableFields: []
      x-resourceId: ephemeral_key
    PostPricesPriceRequest:
      type: object
      properties:
        active:
          description: Whether the price can be used for new purchases. Defaults to `true`.
          type: boolean
        currency_options:
          anyOf:
          - additionalProperties:
              properties:
                custom_unit_amount:
                  properties:
                    enabled:
                      type: boolean
                    maximum:
                      type: integer
                    minimum:
                      type: integer
                    preset:
                      type: integer
                  required:
                  - enabled
                  title: custom_unit_amount
                  type: object
                tax_behavior:
                  enum:
                  - exclusive
                  - inclusive
                  - unspecified
                  type: string
                tiers:
                  items:
                    properties:
                      flat_amount:
                        type: integer
                      flat_amount_decimal:
                        format: decimal
                        type: string
                      unit_amount:
                        type: integer
                      unit_amount_decimal:
                        format: decimal
                        type: string
                      up_to:
                        anyOf:
                        - enum:
                          - inf
                          maxLength: 5000
                          type: string
                        - type: integer
                    required:
                    - up_to
                    title: tier
                    type: object
                  type: array
                unit_amount:
                  type: integer
                unit_amount_decimal:
                  format: decimal
                  type: string
              title: currency_option
              type: object
            type: object
          - enum:
            - ''
            type: string
          description: Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        lookup_key:
          description: A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
          maxLength: 200
          type: string
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - enum:
            - ''
            type: string
          description: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        nickname:
          description: A brief description of the price, hidden from customers.
          maxLength: 5000
          type: string
        tax_behavior:
          description: Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
          enum:
          - exclusive
          - inclusive
          - unspecified
          type: string
        transfer_lookup_key:
          description: If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
          type: boolean