> ## 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 > Returns a paginated list of checkout configurations for a company, with optional filtering by plan and creation date. Required permissions: - `checkout_configuration:basic:read` ## OpenAPI ````yaml /openapi/api-v1-stable.json get /checkout_configurations openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: 2026-07-08-1 servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: Products name: Products - description: Payments name: Payments - description: Refunds name: Refunds - description: Disputes name: Disputes - description: Dispute alerts name: Dispute alerts - description: Resolution center cases name: Resolution center cases - description: Checkout configurations name: Checkout configurations - description: Setup intents name: Setup intents - description: Payment methods name: Payment methods - description: Invoices name: Invoices - description: Promo codes name: Promo codes - description: Card transactions name: Card transactions - description: Ledger accounts name: Ledger accounts - description: Withdrawals name: Withdrawals - description: Payout methods name: Payout methods - description: Verifications name: Verifications - description: Identity profiles name: Identity profiles - description: Payout accounts name: Payout accounts - description: Topups name: Topups - description: Companies name: Companies - description: Authorized users name: Authorized users - description: Fee markups name: Fee markups - description: Members name: Members - description: Memberships name: Memberships - description: Leads name: Leads - description: Entries name: Entries - description: Shipments name: Shipments - description: Reviews name: Reviews - description: Company token transactions name: Company token transactions - description: Affiliates name: Affiliates - description: Experiences name: Experiences - description: Forums name: Forums - description: Forum posts name: Forum posts - description: Chat channels name: Chat channels - description: Support channels name: Support channels - description: Messages name: Messages - description: Reactions name: Reactions - description: Dm members name: Dm members - description: Dm channels name: Dm channels - description: Notifications name: Notifications - description: Courses name: Courses - description: Course chapters name: Course chapters - description: Course lessons name: Course lessons - description: Course students name: Course students - description: Course lesson interactions name: Course lesson interactions - description: Apps name: Apps - description: Webhooks name: Webhooks - description: App builds name: App builds - description: Access tokens name: Access tokens - description: Account links name: Account links - description: Files name: Files - description: Ai chats name: Ai chats - description: Bounties name: Bounties - description: Stats name: Stats - description: Conversions name: Conversions - description: Ad reports name: Ad reports paths: /checkout_configurations: get: tags: - Checkout configurations summary: List checkout configurations description: >- Returns a paginated list of checkout configurations for a company, with optional filtering by plan and creation date. Required permissions: - `checkout_configuration:basic:read` operationId: listCheckoutConfiguration parameters: - explode: true in: query name: after required: false schema: description: >- Returns the elements in the list that come after the specified cursor. type: - string - 'null' style: form - explode: true in: query name: before required: false schema: description: >- Returns the elements in the list that come before the specified cursor. type: - string - 'null' style: form - explode: true in: query name: first required: false schema: description: Returns the first _n_ elements from the list. example: 42 type: - integer - 'null' style: form - explode: true in: query name: last required: false schema: description: Returns the last _n_ elements from the list. example: 42 type: - integer - 'null' style: form - explode: true in: query name: company_id required: true schema: description: >- The unique identifier of the company to list checkout configurations for. example: biz_xxxxxxxxxxxxxx type: string style: form - explode: true in: query name: direction required: false schema: description: >- The sort direction for ordering results, either ascending or descending. oneOf: - $ref: '#/components/schemas/Direction' - type: 'null' style: form - explode: true in: query name: plan_id required: false schema: description: >- Filter checkout configurations to only those associated with this plan identifier. example: plan_xxxxxxxxxxxxx type: - string - 'null' style: form - explode: true in: query name: created_before required: false schema: description: Only return checkout configurations created before this timestamp. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' style: form - explode: true in: query name: created_after required: false schema: description: Only return checkout configurations created after this timestamp. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' style: form responses: '200': content: application/json: schema: description: The connection type for CheckoutSession. properties: data: description: A list of nodes. items: $ref: '#/components/schemas/CheckoutConfigurationListItem' type: array page_info: $ref: '#/components/schemas/PageInfo' description: Information to aid in pagination. required: - data - page_info type: object description: A successful response '400': content: application/json: example: error: code: parameter_missing message: 'Missing required parameter: amount.' param: amount type: invalid_request_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Bad request '401': content: application/json: example: error: message: Invalid or missing API key type: unauthorized schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Unauthorized '403': content: application/json: example: error: message: You do not have permission to access this resource type: forbidden schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Forbidden '404': content: application/json: example: error: message: Resource not found type: not_found schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Not found '422': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Verification required '429': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Too many requests '500': content: application/json: example: error: message: An unexpected error occurred type: internal_server_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Internal server error security: - bearerAuth: - checkout_configuration:basic:read components: schemas: Direction: description: The direction of the sort. enum: - asc - desc type: string CheckoutConfigurationListItem: description: >- A checkout configuration is a reusable configuration for a checkout, including the plan, affiliate, and custom metadata. Payments and memberships created from a checkout session inherit its metadata. properties: affiliate_code: description: The affiliate code to use for the checkout configuration type: - string - 'null' company_id: description: The ID of the company to use for the checkout configuration type: string currency: description: >- The currency to use for the configuration when in 'setup' mode. This is used to target which currency specific payment methods are available. If not provided, it will default to 'usd' when in setup mode. oneOf: - $ref: '#/components/schemas/Currencies' - type: 'null' id: description: The unique identifier for the checkout session. example: ch_xxxxxxxxxxxxxxx type: string metadata: additionalProperties: true description: The metadata to use for the checkout configuration type: - object - 'null' mode: $ref: '#/components/schemas/CheckoutModes' description: The mode of the checkout session. payment_method_configuration: description: >- The explicit payment method configuration for the session, if any. This currently only works in 'setup' mode. Use the plan's payment_method_configuration for payment method. properties: disabled: description: >- An array of payment method identifiers that are explicitly disabled. Only applies if the include_platform_defaults is true. items: $ref: '#/components/schemas/PaymentMethodTypes' type: array enabled: description: >- An array of payment method identifiers that are explicitly enabled. This means these payment methods will be shown on checkout. Example use case is to only enable a specific payment method like cashapp, or extending the platform defaults with additional methods. items: $ref: '#/components/schemas/PaymentMethodTypes' type: array include_platform_defaults: description: >- Whether Whop's platform default payment method enablement settings are included in this configuration. The full list of default payment methods can be found in the documentation at docs.whop.com/payments. type: boolean required: - enabled - disabled - include_platform_defaults type: - object - 'null' plan: description: The plan to use for the checkout configuration properties: adaptive_pricing_enabled: description: >- Whether the creator has turned on adaptive pricing for this plan. Raw setting — does not check processor compatibility or feature flags. type: boolean billing_period: description: >- Number of days between recurring charges, such as 30 for monthly or 365 for annual. `null` for one-time plans. example: 42 type: - integer - 'null' currency: $ref: '#/components/schemas/Currencies' description: >- The currency used for all prices on this plan (e.g., 'usd', 'eur'). All monetary amounts on the plan are denominated in this currency. expiration_days: description: >- Access duration in days for expiration-based plans, such as 365 for a one-year pass. example: 42 type: - integer - 'null' id: description: The unique identifier for the plan. example: plan_xxxxxxxxxxxxx type: string initial_price: description: >- The initial purchase price in the plan's base_currency (e.g., 49.99 for $49.99). For one-time plans, this is the full price. For renewal plans, this is charged on top of the first renewal_price. example: 6.9 type: number plan_type: $ref: '#/components/schemas/PlanTypes' description: >- The billing model for this plan: 'renewal' for recurring subscriptions or 'one_time' for single payments. release_method: $ref: '#/components/schemas/ReleaseMethod' description: >- Sales method for this plan: `buy_now` for immediate purchase or `waitlist` for waitlist-based access. renewal_price: description: >- The recurring price charged every billing_period in the plan's base_currency (e.g., 9.99 for $9.99/period). Zero for one-time plans. example: 6.9 type: number three_ds_level: description: >- The 3D Secure behavior for this plan. Null means the plan inherits the account default. oneOf: - $ref: '#/components/schemas/PlanThreeDsLevels' - type: 'null' trial_period_days: description: >- Free trial days before first renewal charge. `null` if no trial is configured or the user has already used a trial for this plan. example: 42 type: - integer - 'null' visibility: $ref: '#/components/schemas/Visibility' description: >- Controls whether the plan is visible to customers. When set to 'hidden', the plan is only accessible via direct link. 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 type: - object - 'null' purchase_url: description: >- A URL you can send to customers to complete a checkout. It looks like `/checkout/plan_xxxx?session={id}` type: string redirect_url: description: >- The URL to redirect the user to after the checkout configuration is created type: - string - 'null' required: - id - company_id - mode - currency - plan - affiliate_code - metadata - redirect_url - purchase_url - payment_method_configuration type: object PageInfo: description: Information about pagination in a connection. properties: end_cursor: description: When paginating forwards, the cursor to continue. type: - string - 'null' has_next_page: description: When paginating forwards, are there more items? type: boolean has_previous_page: description: When paginating backwards, are there more items? type: boolean start_cursor: description: When paginating backwards, the cursor to continue. type: - string - 'null' required: - end_cursor - start_cursor - has_next_page - has_previous_page type: object Currencies: description: The available currencies on the platform enum: - usd - sgd - inr - aud - brl - cad - dkk - eur - nok - gbp - sek - chf - hkd - huf - jpy - mxn - myr - pln - czk - nzd - aed - eth - ape - cop - ron - thb - bgn - idr - dop - php - try - krw - twd - vnd - pkr - clp - uyu - ars - zar - dzd - tnd - mad - kes - kwd - jod - all - xcd - amd - bsd - bhd - bob - bam - khr - crc - xof - egp - etb - gmd - ghs - gtq - gyd - ils - jmd - mop - mga - mur - mdl - mnt - nad - ngn - mkd - omr - pyg - pen - qar - rwf - sar - rsd - lkr - tzs - ttd - uzs - rub - btc - cny - usdt - kzt - awg - whop_usd - xau type: string CheckoutModes: description: The different modes a checkout can be set to. enum: - payment - setup type: string PaymentMethodTypes: description: The different types of payment methods that can be used. enum: - acss_debit - affirm - afterpay_clearpay - alipay - alma - amazon_pay - apple - apple_pay - au_bank_transfer - au_becs_debit - bacs_debit - bancolombia - bancontact - billie - bizum - blik - boleto - bre_b - ca_bank_transfer - capchase_pay - card - card_installments_three - card_installments_six - card_installments_twelve - cashapp - claritypay - coinbase - crypto - custom - customer_balance - demo_pay - efecty - eps - eu_bank_transfer - fpx - gb_bank_transfer - giropay - google_pay - gopay - grabpay - id_bank_transfer - ideal - interac - kakao_pay - klarna - klarna_pay_now - konbini - kr_card - kr_market - kriya - kueski - link - mb_way - m_pesa - mercado_pago - mobilepay - mondu - multibanco - naver_pay - nequi - netbanking - ng_bank - ng_bank_transfer - ng_card - ng_market - ng_ussd - ng_wallet - nz_bank_account - oxxo - p24 - pago_efectivo - pse - pay_by_bank - payco - paynow - paypal - paypay - payto - pix - platform_balance - promptpay - qris - rechnung - revolut_pay - samsung_pay - satispay - scalapay - sencillito - sepa_debit - sequra - servipag - sezzle - shop_pay - shopeepay - sofort - south_korea_market - spei - splitit - sunbit - swish - tamara - twint - upi - us_bank_account - us_bank_transfer - venmo - vipps - webpay - wechat_pay - yape - zip - coinflow - unknown type: string PlanTypes: description: The type of plan that can be attached to a product enum: - renewal - one_time type: string ReleaseMethod: description: The methods of how a plan can be released. enum: - buy_now - waitlist type: string PlanThreeDsLevels: description: The 3D Secure behavior for a plan. enum: - mandate_challenge - frictionless type: string Visibility: description: Visibility of a resource enum: - visible - hidden - archived - quick_link type: string securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************` scheme: bearer type: http ````