Checkout Configurations

List checkout configurations

Changed on

Lists checkout configurations for an account.

get/checkout_configurations

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/checkout_configurations
  • Auth: HTTP bearer

Query parameters

account_idstring required

Account ID, prefixed biz_.

plan_idstring

Only return checkout configurations for this variant ID, prefixed plan_.

created_beforestring

Only return checkout configurations created before this ISO 8601 timestamp.

created_afterstring

Only return checkout configurations created after this ISO 8601 timestamp.

order'created_at'

Field used to sort checkout configurations.

direction'asc' | 'desc'

Sort direction. Defaults to desc.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

Response

checkout configurations listed

Example response

{
  "data": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "affiliate_code": "tanyacole",
      "created_at": "2026-01-01T12:00:00.000Z",
      "currency": "usd",
      "effective_payment_method_configuration": {
        "disabled": [
          "crypto"
        ],
        "enabled": [
          "card"
        ],
        "include_platform_defaults": true
      },
      "id": "ch_xxxxxxxxxxxxxx",
      "metadata": {
        "booking_source": "front_desk"
      },
      "mode": "payment",
      "payment_method_configuration": {
        "disabled": [
          "crypto"
        ],
        "enabled": [
          "card"
        ],
        "include_platform_defaults": true
      },
      "plan": {
        "adaptive_pricing_enabled": true,
        "billing_period": 30,
        "currency": "usd",
        "expiration_days": 365,
        "id": "plan_xxxxxxxxxxxxxx",
        "plan_type": "renewal",
        "release_method": "buy_now",
        "renewal_price": 59,
        "three_ds_level": "frictionless_if_required",
        "trial_period_days": 7,
        "visibility": "visible"
      },
      "purchase_url": "https://whop.com/checkout/ch_xxxxxxxxxxxxxx/",
      "redirect_url": "https://shinetime.example/thanks",
      "three_ds_level": "frictionless_if_required",
      "updated_at": "2026-01-01T12:00:00.000Z"
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

  • ff3a76573563Revision changes
    • breaking

      for the query request parameter first, default value 20 was added

    • warning

      for the query request parameter first, the max was set to 100.00

    • warning

      added the new frictionless_if_required enum value to the /// response property for the response status

    • warning

      added the new frictionless_if_required enum value to the // response property for the response status

    • warning

      added the new mandate_if_required enum value to the /// response property for the response status

    • warning

      added the new mandate_if_required enum value to the // response property for the response status

    • info

      removed the frictionless enum value from the /// response property for the response status

    • info

      removed the frictionless enum value from the // response property for the response status

  • 23dfbe1a0d1fRevision changes
    • info

      added the optional property // to the response with the status