> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List checkout configurations

> Lists checkout configurations for an account.



## OpenAPI

````yaml /openapi/api-v1-native.yml get /checkout_configurations
openapi: 3.1.0
info:
  title: Whop API
  description: >-
    Hand-written V1 endpoints. Merged into the GraphqlRestProxy-generated schema
    at build time.
  version: v1
servers:
  - url: https://{defaultHost}
    variables:
      defaultHost:
        default: api.whop.com/api/v1
security: []
paths:
  /checkout_configurations:
    parameters:
      - $ref: '#/components/parameters/ApiVersionDate'
    get:
      tags:
        - Checkout Configurations
      summary: List checkout configurations
      description: Lists checkout configurations for an account.
      operationId: listCheckoutConfigurations
      parameters:
        - name: company_id
          in: query
          required: true
          description: Account ID, prefixed `biz_`.
          schema:
            type: string
        - name: plan_id
          in: query
          required: false
          description: >-
            Only return checkout configurations for this plan ID, prefixed
            `plan_`.
          schema:
            type: string
        - name: created_before
          in: query
          required: false
          description: >-
            Only return checkout configurations created before this Unix
            timestamp.
          schema:
            type: integer
        - name: created_after
          in: query
          required: false
          description: >-
            Only return checkout configurations created after this Unix
            timestamp.
          schema:
            type: integer
        - name: order
          in: query
          required: false
          schema:
            type: string
            enum:
              - created_at
            default: created_at
          description: Field used to sort checkout configurations.
        - name: direction
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          description: Sort direction. Defaults to `desc`.
        - name: first
          in: query
          required: false
          description: Number of checkout configurations to return.
          schema:
            type: integer
        - name: after
          in: query
          required: false
          description: Cursor for the next page of results.
          schema:
            type: string
      responses:
        '200':
          description: checkout configurations listed
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Checkout configuration ID, prefixed `ch_`.
                        created_at:
                          type: string
                          description: >-
                            When the checkout configuration was created, as an
                            ISO 8601 timestamp.
                        updated_at:
                          type: string
                          description: >-
                            When the checkout configuration was last updated, as
                            an ISO 8601 timestamp.
                        company_id:
                          type: string
                          description: Account ID, prefixed `biz_`.
                        mode:
                          type: string
                          enum:
                            - payment
                            - setup
                          description: >-
                            Checkout mode: `payment` collects payment now;
                            `setup` saves payment details for later.
                        currency:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Currency used for setup-mode payment method
                            availability; defaults to `usd` when omitted.
                        plan:
                          type:
                            - object
                            - 'null'
                          description: >-
                            Plan used for payment checkout. `null` in setup
                            mode.
                          properties:
                            id:
                              type: string
                              description: Plan ID, prefixed `plan_`.
                            visibility:
                              type: string
                              description: >-
                                Whether the plan is visible to customers or
                                hidden from public view.
                            plan_type:
                              type: string
                              description: >-
                                Billing model for the plan: `renewal`
                                (recurring) or `one_time` (single payment).
                            release_method:
                              type: string
                              description: >-
                                Sales method for the plan, such as `buy_now` or
                                `waitlist`.
                            currency:
                              type: string
                              description: >-
                                Three-letter ISO currency code for the plan's
                                prices.
                            billing_period:
                              type:
                                - integer
                                - 'null'
                              description: >-
                                Recurring billing interval in days, such as 30
                                for monthly or 365 for annual. `null` for
                                one-time plans.
                            expiration_days:
                              type:
                                - integer
                                - 'null'
                              description: >-
                                Access duration in days for expiration-based
                                plans.
                            initial_price:
                              type: number
                              description: Initial purchase price in the plan currency.
                            renewal_price:
                              type: number
                              description: Recurring price charged each billing period.
                            trial_period_days:
                              type:
                                - integer
                                - 'null'
                              description: Free trial days before the first renewal charge.
                            three_ds_level:
                              type:
                                - string
                                - 'null'
                              description: >-
                                3D Secure behavior for this plan, or `null` to
                                use the account default.
                            adaptive_pricing_enabled:
                              type: boolean
                              description: >-
                                Whether this plan accepts local currency
                                payments via adaptive pricing.
                          required:
                            - id
                            - visibility
                            - plan_type
                            - release_method
                            - currency
                            - billing_period
                            - expiration_days
                            - initial_price
                            - renewal_price
                            - trial_period_days
                            - three_ds_level
                            - adaptive_pricing_enabled
                        affiliate_code:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Affiliate code applied at checkout, or `null` when
                            none is set.
                        metadata:
                          type:
                            - object
                            - 'null'
                          description: >-
                            Custom key-value metadata copied to payments and
                            memberships. `null` without the
                            `checkout_configuration:basic:read` scope.
                        redirect_url:
                          type:
                            - string
                            - 'null'
                          description: >-
                            URL customers are sent to after checkout, or `null`
                            when no redirect is configured.
                        purchase_url:
                          type:
                            - string
                            - 'null'
                          description: Checkout URL you can send to customers.
                        three_ds_level:
                          type:
                            - string
                            - 'null'
                          description: >-
                            3D Secure behavior for this checkout, or `null` to
                            use the account default.
                        payment_method_configuration:
                          type:
                            - object
                            - 'null'
                          description: >-
                            Payment method overrides for this checkout. `null`
                            when it uses the plan or platform defaults.
                          properties:
                            enabled:
                              type: array
                              items:
                                type: string
                              description: Payment methods explicitly enabled for checkout.
                            disabled:
                              type: array
                              items:
                                type: string
                              description: >-
                                Payment methods explicitly disabled for
                                checkout.
                            include_platform_defaults:
                              type: boolean
                              description: >-
                                Whether platform default payment methods are
                                included.
                      required:
                        - id
                        - created_at
                        - updated_at
                        - company_id
                        - mode
                  page_info:
                    type: object
                    properties:
                      end_cursor:
                        type:
                          - string
                          - 'null'
                      start_cursor:
                        type:
                          - string
                          - 'null'
                      has_next_page:
                        type: boolean
                      has_previous_page:
                        type: boolean
                    required:
                      - end_cursor
                      - start_cursor
                      - has_next_page
                      - has_previous_page
                required:
                  - data
                  - page_info
        '400':
          $ref: '#/components/responses/InvalidParameters'
          description: company_id missing
        '401':
          $ref: '#/components/responses/Unauthorized'
          description: missing or invalid authentication
      security:
        - bearerAuth: []
components:
  parameters:
    ApiVersionDate:
      name: Api-Version-Date
      in: header
      required: false
      schema:
        type: string
        example: 2026-07-08-1
      description: Pins the request to a dated API version.
  responses:
    InvalidParameters:
      description: Invalid Parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V1ErrorResponse'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V1ErrorResponse'
  schemas:
    V1ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              description: Machine-readable error code.
            message:
              type: string
              description: Human-readable error message.
          required:
            - type
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: auth-scheme
      description: >-
        An account API key, account scoped JWT, app API key, or user OAuth
        token.

````