List customers on a plan
GET {{baseUrl}}/planDetails/:plan_id/customers?limit=<integer>&next_page=<string>&status=all
Fetches a list of customers on a specific plan (by default, only currently active plans are included)
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | string | Max number of results that should be returned | |
next_page | string | Cursor that indicates where the next page of results should start. | |
status | 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. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"customer_details":{"external_id":"\u003cstring\u003e","id":"\u003cuuid\u003e","name":"\u003cstring\u003e","customer_config":{"salesforce_account_id":"\u003cstring\u003e"},"ingest_aliases":["\u003cstring\u003e","\u003cstring\u003e"],"custom_fields":{"exercitation_20":"\u003cstring\u003e","veniam__9":"\u003cstring\u003e","reprehenderit_1":"\u003cstring\u003e","minim3f3":"\u003cstring\u003e"},"current_billable_status":{"value":"unbillable","effective_at":"\u003cdateTime\u003e"}},"plan_details":{"id":"\u003cuuid\u003e","name":"\u003cstring\u003e","custom_fields":{"proidente":"\u003cstring\u003e","dolore4d":"\u003cstring\u003e","enim2":"\u003cstring\u003e","esse_535":"\u003cstring\u003e"},"starting_on":"\u003cdateTime\u003e","customer_plan_id":"\u003cuuid\u003e","ending_before":"\u003cdateTime\u003e"}},{"customer_details":{"external_id":"\u003cstring\u003e","id":"\u003cuuid\u003e","name":"\u003cstring\u003e","customer_config":{"salesforce_account_id":"\u003cstring\u003e"},"ingest_aliases":["\u003cstring\u003e","\u003cstring\u003e"],"custom_fields":{"in_e26":"\u003cstring\u003e","ut_4":"\u003cstring\u003e"},"current_billable_status":{"value":"unbillable","effective_at":"\u003cdateTime\u003e"}},"plan_details":{"id":"\u003cuuid\u003e","name":"\u003cstring\u003e","custom_fields":{"incididuntb0":"\u003cstring\u003e","Excepteur_1":"\u003cstring\u003e"},"starting_on":"\u003cdateTime\u003e","customer_plan_id":"\u003cuuid\u003e","ending_before":"\u003cdateTime\u003e"}}],"next_page":"\u003cstring\u003e"}