Skip to main content
GET
/
planDetails
/
{plan_id}
/
customers
List customers on a plan
curl --request GET \
  --url https://api.metronome.com/v1/planDetails/{plan_id}/customers \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "customer_details": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "<string>",
        "ingest_aliases": [
          "<string>"
        ],
        "name": "<string>",
        "customer_config": {
          "salesforce_account_id": "<string>"
        },
        "custom_fields": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "archived_at": "2023-11-07T05:31:56Z"
      },
      "plan_details": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "starting_on": "2023-11-07T05:31:56Z",
        "custom_fields": {},
        "customer_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "ending_before": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "next_page": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
plan_id
string<uuid>
required

Query Parameters

​
limit
integer

Max number of results that should be returned

Required range: 1 <= x <= 100
​
next_page
string

Cursor that indicates where the next page of results should start.

​
status
enum<string>

Status of customers on a given plan. Defaults to active.

  • all - Return current, past, and upcoming customers of the plan.
  • active - Return current customers of the plan.
  • ended - Return past customers of the plan.
  • upcoming - Return upcoming customers of the plan.

Multiple statuses can be OR'd together using commas, e.g. active,ended. Note: ended,upcoming combination is not yet supported.

Available options:
all,
active,
ended,
upcoming

Response

200 - application/json

Success

​
data
object[]
required
​
next_page
string | null
required