v8

latestOpenAPI 3.1.02026-08-033623795.0 MB

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.

visibilitiesstring[]

Filter to only plans matching these visibility states.

plan_typesstring[]

Filter to only plans matching these billing types.

product_idsstring[]

Filter to only plans belonging to these product identifiers.

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": [
    {
      "custom_fields": [
        {
          "field_type": "text"
        }
      ],
      "plan_type": "renewal",
      "release_method": "buy_now",
      "three_ds_level": "mandate_challenge",
      "visibility": "visible"
    }
  ]
}