Plans

Deprecated compatibility endpoint. List variants with GET /variants instead.

get/plans

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/plans
  • Auth: one of:
    • none
    • HTTP bearer

Query parameters

account_idstring
direction'asc' | 'desc'
order'id' | 'active_members_count' | 'created_at' | 'internal_notes' | 'expiration_days'
release_methodsstring[]
visibilitiesstring[]
plan_typesstring[]
product_idsstring[]
created_beforestring
created_afterstring
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.

lastinteger

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

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

variants listed through the deprecated plans path

Example response

{
  "data": [
    {
      "account": {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "Shine Time Auto Detailing"
      },
      "adaptive_pricing_enabled": true,
      "billing_period": 30,
      "created_at": "2026-01-01T12:00:00.000Z",
      "currency": "usd",
      "custom_fields": [
        {
          "field_type": "text",
          "id": "field_xxxxxxxxxxxxxx",
          "name": "Vehicle make and model",
          "placeholder": "2021 Audi S5",
          "required": true
        }
      ],
      "formatted_price": "$59.00 / month",
      "id": "plan_xxxxxxxxxxxxxx",
      "initial_price_due": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "internal_notes": "Maintenance tier. Upsell the interior shampoo add-on at renewal.",
      "metadata": {
        "custom_cta": "subscribe",
        "custom_cta_url": "https://shinetime.example/wash-club"
      },
      "plan_type": "renewal",
      "product": {
        "id": "prod_xxxxxxxxxxxxxx",
        "title": "Ceramic Coating Package"
      },
      "purchase_url": "https://whop.com/checkout/plan_xxxxxxxxxxxxxx",
      "release_method": "buy_now",
      "renewal_price": 59,
      "three_ds_level": "mandate_challenge",
      "title": "Unlimited Wash Club",
      "updated_at": "2026-01-01T12:00:00.000Z",
      "visibility": "visible"
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

    • info

      endpoint deprecated

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

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

    • info

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