Sign in
OpenAPI 3.1.02026-08-143874115.7 MB

a84d4905fdbb

Plans

List Plans

Returns a paginated list of plans belonging to an account, with optional filtering by visibility, type, release method, and product.

get/plans

Query parameters

account_idstring required

The unique identifier of the account to list plans for.

direction'asc' | 'desc'

The sort direction for results. Defaults to descending.

order'id' | 'active_members_count' | 'created_at' | 'internal_notes' | 'expiration_days'

The field to sort results by. Defaults to created_at.

release_methodsstring[]

Filter to only plans matching these release methods.

[
  "buy_now"
]
visibilitiesstring[]

Filter to only plans matching these visibility states.

[
  "visible"
]
plan_typesstring[]

Filter to only plans matching these billing types.

[
  "renewal"
]
product_idsstring[]

Filter to only plans belonging to these product identifiers.

[
  "prod_xxxxxxxxxxxxxx"
]
created_beforestring

Only return plans created before this timestamp.

created_afterstring

Only return plans created after this timestamp.

firstinteger

The number of plans to return (default and max 100).

afterstring

A cursor; returns plans after this position.

lastinteger

The number of plans to return from the end of the range.

beforestring

A cursor; returns plans before this position.

Response

plans listed

Example response

{
  "data": [
    {
      "account": {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "Shine Time Auto Detailing"
      },
      "adaptive_pricing_enabled": true,
      "billing_period": 30,
      "cancel_discount_intervals": 3,
      "cancel_discount_percentage": 20,
      "checkout_styling": {
        "background_color": "#0f172a",
        "border_style": "rounded",
        "button_color": "#f59e0b",
        "font_family": "roboto"
      },
      "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
        }
      ],
      "description": "Two hand washes a month, interior vacuum, and a quarterly sealant top-up.",
      "expiration_days": 365,
      "formatted_price": "$59.00 / month",
      "id": "plan_xxxxxxxxxxxxxx",
      "image": {
        "blurhash": "LA6bDXT$E3b:R6i+RibEIWbp%ej1",
        "url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      },
      "internal_notes": "Maintenance tier. Upsell the interior shampoo add-on at renewal.",
      "invoice": {
        "id": "inv_xxxxxxxxxxxxxx"
      },
      "metadata": {},
      "offer_cancel_discount": true,
      "payment_method_configuration": {
        "disabled": [
          "crypto"
        ],
        "enabled": [
          "card"
        ],
        "include_platform_defaults": true
      },
      "plan_type": "renewal",
      "product": {
        "id": "prod_xxxxxxxxxxxxxx",
        "title": "Ceramic Coating Package"
      },
      "purchase_url": "http://whop.com/checkout/plan_xxxxxxxxxxxxxx",
      "release_method": "buy_now",
      "renewal_price": 59,
      "split_pay_required_payments": 4,
      "strike_through_initial_price": 99,
      "strike_through_renewal_price": 79,
      "three_ds_level": "frictionless",
      "title": "Unlimited Wash Club",
      "trial_period_days": 7,
      "updated_at": "2026-01-01T12:00:00.000Z",
      "visibility": "visible"
    }
  ],
  "page_info": {
    "end_cursor": "WyJjdXJzb3IiLDFd",
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}