Sign in
Checkout Configurations

Retrieve a checkout configuration

Retrieves a checkout configuration by ID. This endpoint is public so a checkout page can load from the configuration URL.

get/checkout_configurations/{id}

Response

checkout configuration found (unauthenticated)

account_idstring required

Account ID, prefixed biz_.

affiliate_codestring nullable

Affiliate code applied at checkout, or null when none is set.

created_atstring required

When the checkout configuration was created, as an ISO 8601 timestamp.

currencystring nullable

Currency used for setup-mode payment method availability; defaults to usd when omitted.

idstring required

Checkout configuration ID, prefixed ch_.

metadataobject nullable

Custom key-value metadata copied to payments and memberships. null without the checkout_configuration:basic:read scope.

mode'payment' | 'setup' required

Controls whether checkout charges the buyer immediately or saves payment details for later.

purchase_urlstring nullable

Checkout URL you can send to customers.

redirect_urlstring nullable

URL customers are sent to after checkout, or null when no redirect is configured.

three_ds_level'mandate_challenge' | 'mandate_if_required' | 'frictionless_if_required' | 'null' nullable

3D Secure behavior for supported on-session card payments. mandate_challenge requires a 3DS challenge before payment processing; mandate_if_required mandates a challenge only when the payment processor requires it; frictionless_if_required uses the regular frictionless 3DS flow. Payments of $1,000 or more use mandate_if_required unless mandate_challenge is selected. Risk and authentication recovery requirements can override the preference. Applies in setup mode; null uses frictionless 3DS. Payment mode uses the plan policy.

updated_atstring required

When the checkout configuration was last updated, as an ISO 8601 timestamp.

Example response

{
  "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"
}

Changes

Changed in 6 of the 74 revisions of this API.1186

  • ff3a7657356342See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

  • 23dfbe1a0d1f1See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a84d4905fdbb1See the full diff
    • ○

      the endpoint scheme security bearerAuth was added to the API

      api-security-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f1020c3ecda41See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 099fdc3be42214See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

      added the new frictionless enum value to the response property for the response status

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

      added the new mandate_challenge enum value to the response property for the response status

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

      added the new undefined enum value to the response property for the response status

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 60bbb4a6ffbc11See the full diff
    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.