Retrieve

API Reference

V1

Customers

Get a customer

client.v1.customers.retrieve(CustomerRetrieveParamsparams, RequestOptionsoptions?): dataCustomerDetailCustomerRetrieveResponse

get/v1/customers/{customer_id}

Get a customer by Metronome ID.

Parameters

paramscustomer_idstringCustomerRetrieveParams

Hide ParametersShow Parameters

customer_idstring

formatuuid

Returns

CustomerRetrieveResponse

Hide ParametersShow Parameters

dataidstringcreated_atstringcustom_fieldsRecord<string, string>customer_configCustomerConfigexternal_idstringingest_aliasesarraynamestringarchived_atunioncurrent_billable_statusCurrentBillableStatusCustomerDetail

HTTPTypeScriptPythonGoRubyTerraform

import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

const customer = await client.v1.customers.retrieve({ customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' });

console.log(customer.data);

200 Example

{
  "data": {
    "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"
    }
  }
}