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": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
        "created_at": "2024-01-01T00:00:00.000Z",
        "updated_at": "2024-01-01T00:00:00.000Z",
        "external_id": "team@example.com",
        "ingest_aliases": [
          "team@example.com"
        ],
        "name": "Example, Inc.",
        "customer_config": {
          "salesforce_account_id": "0015500001WO1ZiABL"
        },
        "custom_fields": {
          "x_account_id": "KyVnHhSBWl7eY2bl"
        }
      },
      "plan_details": {
        "id": "d46c3bce-40a6-4fbf-9b45-fcb00d45ad5f",
        "name": "Plan with Minimums",
        "ending_before": "2024-04-01T00:00:00Z",
        "starting_on": "2022-02-01T00:00:00Z",
        "custom_fields": {
          "x_account_id": "KyVnHhSBWl7eY2bl"
        },
        "customer_plan_id": "a23b3cf4-47fb-4c3f-bb3d-9e64f7704015"
      }
    }
  ],
  "next_page": null
}

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