List Customers
List customers on a plan
get/v1/planDetails/{plan_id}/customers
Fetches a list of customers on a specific plan (by default, only currently active plans are included)
Path Parameters
plan_idstring
formatuuid
Query Parameters
limitnumber
optional
Max number of results that should be returned
minimum1
maximum100
next_pagestring
optional
Cursor that indicates where the next page of results should start.
statusenum
optional
"all" OR "active" OR "ended" OR "upcoming"
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.
Returns
dataarray of object
next_pagestring
curl https://api.metronome.com/v1/planDetails/$PLAN_ID/customers \
-H "Authorization: Bearer $METRONOME_BEARER_TOKEN"
200 Example
{
"data": [
{
"customer_details": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"created_at": "2019-12-27T18:11:19.117Z",
"custom_fields": {
"foo": "string"
},
"customer_config": {
"salesforce_account_id": "salesforce_account_id"
},
"external_id": "external_id",
"ingest_aliases": [
"string"
],
"name": "name",
"archived_at": "2019-12-27T18:11:19.117Z",
"current_billable_status": {
"value": "billable",
"effective_at": "2019-12-27T18:11:19.117Z"
}
},
"plan_details": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"custom_fields": {
"foo": "string"
},
"customer_plan_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name",
"starting_on": "2019-12-27T18:11:19.117Z",
"ending_before": "2019-12-27T18:11:19.117Z"
}
}
],
"next_page": "next_page"
}