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(**kwargs) -> CursorPage<customer_detailsCustomerDetailplan_detailsobjectPlanListCustomersResponse>
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_idString
formatuuid
limitInteger
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.

statusunion
optional
: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_detailsidStringcreated_atTimecustom_fieldshashcustomer_configobjectexternal_idStringingest_aliasesarraynameStringarchived_atTimecurrent_billable_statusobjectCustomerDetail
plan_detailsobject
{ id, custom_fields, customer_plan_id, 3 more}
Hide ParametersShow Parameters
idString
formatuuid
custom_fieldshash
Hash[Symbol, String]
customer_plan_idString
formatuuid
nameString
starting_onTime

The start date of the plan

formatdate-time
ending_beforeTime
optional

The end date of the plan

formatdate-time
require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

page = metronome.v1.plans.list_customers(plan_id: "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc")

puts(page)
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"
}