Sign in
Customers

Get customer

Use when you need to load a single customer (e.g. for a billing portal or to attach a subscription).

get/customers/{id}

Path parameters

idstring required

Customer ID

Response

OK

address_citystring

AddressCity is the city of the customer's address

address_countrystring

AddressCountry is the country of the customer's address (ISO 3166-1 alpha-2)

address_line1string

AddressLine1 is the first line of the customer's address

address_line2string

AddressLine2 is the second line of the customer's address

address_postal_codestring

AddressPostalCode is the postal code of the customer's address

address_statestring

AddressState is the state of the customer's address

created_atstring date-time
created_bystring
emailstring

Email is the email of the customer

environment_idstring

EnvironmentID is the environment identifier for the customer

external_idstring

ExternalID is the external identifier for the customer

idstring

ID is the unique identifier for the customer

metadataobject

Metadata

namestring

Name is the name of the customer

parent_customer_idstring

Deprecated: Customer parent hierarchy is deprecated in favor of subscription-level hierarchy. Retained for backward compatibility; no hierarchy rules are enforced at the service layer. ParentCustomerID is the parent customer identifier for the customer.

status'published' | 'deleted' | 'archived'
tenant_idstring
updated_atstring date-time
updated_bystring

Changes