Retrieves a customer with a specified ID.
Retrieves a customer with a specified ID.
| expand | string Expands a request to include embedded objects within the For more information, see Expand to include embedded objects. |
| fields | string Limits the returned fields to the specified list, each field separated by a comma. The ID value is always returned. |
$customers = $client->customers()->load('myCustomerId');
200
Customer retrieved.
| id | string <= 50 characters ID of the customer. |
string or null <email> Customer's email address. | |
| firstName | string or null Customer's first name. |
| lastName | string or null Customer's last name. |
| websiteId | string <= 50 characters ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID. |
Vaulted payment instrument (object) or Alternative instrument (object) or Cash (object) or Check (object) or null | |
| createdTime | string <date-time> (CreatedTime) Date and time which is set automatically when the resource is created. |
| updatedTime | string <date-time> (UpdatedTime) Date and time which updates automatically when the resource is updated. |
| customFields | object (ResourceCustomFields) Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields. |
ContactObject (object) or null Customer's primary address. | |
object or null (Company) Company information that is associated with the customer's primary email address domain. This is a paid feature, to enable it contact Rebilly. | |
object (CustomerAverageValue) Average customer value. | |
| paymentCount | integer Total number of approved payments made by the customer. |
| lastPaymentTime | string or null <date-time> Time and date of the customer's last approved payment. |
object (CustomerLifetimeRevenue) Customer's lifetime revenue. | |
| invoiceCount | integer Total number of invoices issued to the customer. This value is auto-incrementing. If this value is |
Array of objects (Tag) List of customer tags. | |
| revision | integer Number of times the customer's data has been modified. Use this value when analyzing webhook data to determine if a change must take precedence over the current representation. |
| isEddRequired | boolean Default: false Specifies if Enhanced Due Diligence (EDD) is enabled for this customer. For more information, see Enhanced Due Diligence. |
| hasFulfilledKyc | boolean Specifies if the customer has accepted and reviewed identity and address documents, or an accepted credit file document. |
| organizationId | string <= 50 characters Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID. |
Array of objects or null (TaxNumber) Tax numbers of the customer. | |
Array of objects Related links. | |
object Embedded objects that are requested using the |
401
Unauthorized access. Invalid credentials used.
403
Access forbidden.
404
Resource not found.
{ "id": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "email": "user@example.com", "firstName": "string", "lastName": "string", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "defaultPaymentInstrument": { "method": "payment-card", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N" }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "customFields": { "foo": "bar" }, "primaryAddress": { "firstName": "Benjamin", "lastName": "Franklin", "organization": "Rebilly", "address": "36 Craven St", "address2": "string", "city": "Austin", "region": "Texas", "country": "GB", "postalCode": "WC2N 5NF", "phoneNumbers": [ { "label": "main", "value": "512-710-1640", "primary": true } ], "emails": [ { "label": "main", "value": "rebilly@example.com", "primary": true } ], "dob": "1980-04-01", "jobTitle": "CEO", "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221" }, "company": { "name": "string", "domain": "string", "yearFounded": 0, "industry": "string", "employeesCount": 0, "country": "string", "locality": "string", "_links": [ { "href": "string", "rel": "linkedin" } ] }, "averageValue": { "currency": "USD", "amount": 0.1, "amountUsd": 0.1 }, "paymentCount": 0, "lastPaymentTime": "2019-08-24T14:15:22Z", "lifetimeRevenue": { "currency": "USD", "amount": 0.1, "amountUsd": 0.1 }, "invoiceCount": 0, "tags": [ { "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21", "name": "New", "type": "customer", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { "href": "string", "rel": "self" } ] } ], "revision": 0, "isEddRequired": false, "hasFulfilledKyc": true, "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "taxNumbers": [ { "type": "eu-vat", "value": "GB980780684", "isDefault": true, "isValid": true } ], "_links": [ { "href": "string", "rel": "self" } ], "_embedded": { "leadSource": { } } }