Skip to content
Metronome Docs
  • Auto
  • Light
  • Dark
Talk to an expert

List Customers

API Reference
V1
Plans
List customers on a plan
v1.plans.list_customers(PlanListCustomersParams**kwargs) -> SyncCursorPage[customer_detailsCustomerDetailplan_detailsPlanDetailsPlanListCustomersResponse]
get/v1/planDetails/{plan_id}/customers

Fetches a list of customers on a specific plan (by default, only currently active plans are included)

Parameters
plan_idstr
formatuuid
limitint
optional

Max number of results that should be returned

minimum1
maximum100
next_pagestr
optional

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

statusliteral
optional
Literal["all", "active", "ended", "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.

Hide ParametersShow Parameters
"all"
"active"
"ended"
"upcoming"
Returns
PlanListCustomersResponseclass
Hide ParametersShow Parameters
customer_detailsidstrcreated_atdatetimecustom_fieldsDict[str, str]customer_configCustomerConfigexternal_idstringest_aliaseslistnamestrarchived_atdatetimecurrent_billable_statusCurrentBillableStatusCustomerDetail
plan_detailsidstrcustom_fieldsDict[str, str]customer_plan_idstrnamestrstarting_ondatetimeending_beforedatetimePlanDetails
Hide ParametersShow Parameters
idstr
formatuuid
custom_fieldsDict[str, str]
Dict[str, str]
customer_plan_idstr
formatuuid
namestr
starting_ondatetime

The start date of the plan

formatdate-time
ending_beforedatetime
optional

The end date of the plan

formatdate-time
from metronome import Metronome

client = Metronome(
    bearer_token="My Bearer Token",
)
page = client.v1.plans.list_customers(
    plan_id="d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
)
page = page.data[0]
print(page.customer_details)
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"
}