Customers are your customers, sometimes known as accounts, clients, members, patrons, or players in other systems.
Retrieve a list of customers.
limit | integer [ 0 .. 1000 ] The collection items limit. |
offset | integer >= 0 The collection items offset. |
filter | string The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format. |
q | string The partial search of the text fields. |
expand | string Expand a response to get a full related object included inside of the |
fields | string Limit the returned fields to the list specified, separated by comma. Note that id is always returned. |
sort | Array of strings The collection items sort field and order (prefix with "-" for descending sort). |
A list of Customers was retrieved successfully.
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
Unauthorized access, invalid credentials were used.
Access forbidden.
$customers = $client->customers()->search([ 'filter' => 'firstName:John', ]);
[- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "defaultPaymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "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": "London",
- "region": "London",
- "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"
}, - "averageValue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "paymentCount": 0,
- "lastPaymentTime": "2019-08-24T14:15:22Z",
- "lifetimeRevenue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "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": [
- {
- "rel": "self",
- "href": "string"
}
]
}
], - "revision": 0,
- "isEddRequired": false,
- "hasFulfilledKyc": true,
- "_links": [
- {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "leadSource": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "original": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": null
}
]
}
}
}
]
}
]
Create a customer without a predefined ID. The customer's primary address will be used as the default address for payment instruments, subscriptions and invoices if none are provided.
If you wish to create the customer with a predefined
ID (which we recommend to prevent duplication), you
may use our PUT
request described below.
For more information, see preventing duplicates.
Customer resource.
websiteId | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||
paymentToken | string A write-only payment token; if supplied, it will be converted into a
payment instrument and be set as the | ||||||||||||||||||||||||||||||
Vaulted instrument (object) or Alternative Instrument (object) or Cash (object) or Check (object) (PaymentInstrument) | |||||||||||||||||||||||||||||||
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map | ||||||||||||||||||||||||||||||
object (ContactObject) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
isEddRequired | boolean Default: false Indicates if EDD is enabled for this customer. |
Customer.
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||
string <email> The customer's email. | |||||||||||||||||||||||||||||||||
firstName | string The customer's first name. | ||||||||||||||||||||||||||||||||
lastName | string The customer's last name. | ||||||||||||||||||||||||||||||||
websiteId | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||
Vaulted instrument (object) or Alternative Instrument (object) or Cash (object) or Check (object) (PaymentInstrument) | |||||||||||||||||||||||||||||||||
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||
updatedTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map | ||||||||||||||||||||||||||||||||
object (ContactObject) | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
object (CustomerAverageValue) | |||||||||||||||||||||||||||||||||
paymentCount | integer The number of approved payments for the customer. | ||||||||||||||||||||||||||||||||
lastPaymentTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||
object (CustomerLifetimeRevenue) | |||||||||||||||||||||||||||||||||
invoiceCount | integer An auto-incrementing number based on the sequence of invoices. If set to 0, then this record is a Lead, otherwise is a Customer. | ||||||||||||||||||||||||||||||||
Array of objects (Tag) A list of customer's tags. | |||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||
revision | integer The number of times the customer data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation. | ||||||||||||||||||||||||||||||||
isEddRequired | boolean Default: false Indicates if EDD is enabled for this customer. | ||||||||||||||||||||||||||||||||
hasFulfilledKyc | boolean Whether the customer has fulfilled a KYC request by providing valid identity and address documents. | ||||||||||||||||||||||||||||||||
Array of SelfLink (object) or DefaultPaymentInstrumentLink (object) or LeadSourceLink (object) or WebsiteLink (object) >= 3 items The links related to resource. | |||||||||||||||||||||||||||||||||
Array of LeadSourceEmbed (object) non-empty Any embedded objects available that are requested by the | |||||||||||||||||||||||||||||||||
Array (non-empty) Any of: Lead Source object.
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Conflict.
Invalid data was sent.
{- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "paymentToken": "string",
- "defaultPaymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "customFields": {
- "foo": "bar"
}, - "primaryAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": "Rebilly",
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "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"
}, - "isEddRequired": false
}
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "defaultPaymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "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": "London",
- "region": "London",
- "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"
}, - "averageValue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "paymentCount": 0,
- "lastPaymentTime": "2019-08-24T14:15:22Z",
- "lifetimeRevenue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "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": [
- {
- "rel": "self",
- "href": "string"
}
]
}
], - "revision": 0,
- "isEddRequired": false,
- "hasFulfilledKyc": true,
- "_links": [
- {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "leadSource": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "original": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
}
}
]
}
Retrieve a customer with specified identifier string.
expand | string Expand a response to get a full related object included inside of the |
fields | string Limit the returned fields to the list specified, separated by comma. Note that id is always returned. |
Customer was retrieved successfully.
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||
string <email> The customer's email. | |||||||||||||||||||||||||||||||||
firstName | string The customer's first name. | ||||||||||||||||||||||||||||||||
lastName | string The customer's last name. | ||||||||||||||||||||||||||||||||
websiteId | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||
Vaulted instrument (object) or Alternative Instrument (object) or Cash (object) or Check (object) (PaymentInstrument) | |||||||||||||||||||||||||||||||||
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||
updatedTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map | ||||||||||||||||||||||||||||||||
object (ContactObject) | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
object (CustomerAverageValue) | |||||||||||||||||||||||||||||||||
paymentCount | integer The number of approved payments for the customer. | ||||||||||||||||||||||||||||||||
lastPaymentTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||
object (CustomerLifetimeRevenue) | |||||||||||||||||||||||||||||||||
invoiceCount | integer An auto-incrementing number based on the sequence of invoices. If set to 0, then this record is a Lead, otherwise is a Customer. | ||||||||||||||||||||||||||||||||
Array of objects (Tag) A list of customer's tags. | |||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||
revision | integer The number of times the customer data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation. | ||||||||||||||||||||||||||||||||
isEddRequired | boolean Default: false Indicates if EDD is enabled for this customer. | ||||||||||||||||||||||||||||||||
hasFulfilledKyc | boolean Whether the customer has fulfilled a KYC request by providing valid identity and address documents. | ||||||||||||||||||||||||||||||||
Array of SelfLink (object) or DefaultPaymentInstrumentLink (object) or LeadSourceLink (object) or WebsiteLink (object) >= 3 items The links related to resource. | |||||||||||||||||||||||||||||||||
Array of LeadSourceEmbed (object) non-empty Any embedded objects available that are requested by the | |||||||||||||||||||||||||||||||||
Array (non-empty) Any of: Lead Source object.
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
$customers = $client->customers()->load('myCustomerId');
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "defaultPaymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "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": "London",
- "region": "London",
- "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"
}, - "averageValue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "paymentCount": 0,
- "lastPaymentTime": "2019-08-24T14:15:22Z",
- "lifetimeRevenue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "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": [
- {
- "rel": "self",
- "href": "string"
}
]
}
], - "revision": 0,
- "isEddRequired": false,
- "hasFulfilledKyc": true,
- "_links": [
- {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "leadSource": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "original": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
}
}
]
}
Create or update (upsert) a customer with predefined identifier string. For more information, see preventing duplicates.
Customer resource.
websiteId | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||
paymentToken | string A write-only payment token; if supplied, it will be converted into a
payment instrument and be set as the | ||||||||||||||||||||||||||||||
Vaulted instrument (object) or Alternative Instrument (object) or Cash (object) or Check (object) (PaymentInstrument) | |||||||||||||||||||||||||||||||
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map | ||||||||||||||||||||||||||||||
object (ContactObject) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
isEddRequired | boolean Default: false Indicates if EDD is enabled for this customer. |
Customer.
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||
string <email> The customer's email. | |||||||||||||||||||||||||||||||||
firstName | string The customer's first name. | ||||||||||||||||||||||||||||||||
lastName | string The customer's last name. | ||||||||||||||||||||||||||||||||
websiteId | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||
Vaulted instrument (object) or Alternative Instrument (object) or Cash (object) or Check (object) (PaymentInstrument) | |||||||||||||||||||||||||||||||||
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||
updatedTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map | ||||||||||||||||||||||||||||||||
object (ContactObject) | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
object (CustomerAverageValue) | |||||||||||||||||||||||||||||||||
paymentCount | integer The number of approved payments for the customer. | ||||||||||||||||||||||||||||||||
lastPaymentTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||
object (CustomerLifetimeRevenue) | |||||||||||||||||||||||||||||||||
invoiceCount | integer An auto-incrementing number based on the sequence of invoices. If set to 0, then this record is a Lead, otherwise is a Customer. | ||||||||||||||||||||||||||||||||
Array of objects (Tag) A list of customer's tags. | |||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||
revision | integer The number of times the customer data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation. | ||||||||||||||||||||||||||||||||
isEddRequired | boolean Default: false Indicates if EDD is enabled for this customer. | ||||||||||||||||||||||||||||||||
hasFulfilledKyc | boolean Whether the customer has fulfilled a KYC request by providing valid identity and address documents. | ||||||||||||||||||||||||||||||||
Array of SelfLink (object) or DefaultPaymentInstrumentLink (object) or LeadSourceLink (object) or WebsiteLink (object) >= 3 items The links related to resource. | |||||||||||||||||||||||||||||||||
Array of LeadSourceEmbed (object) non-empty Any embedded objects available that are requested by the | |||||||||||||||||||||||||||||||||
Array (non-empty) Any of: Lead Source object.
|
Customer.
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||
string <email> The customer's email. | |||||||||||||||||||||||||||||||||
firstName | string The customer's first name. | ||||||||||||||||||||||||||||||||
lastName | string The customer's last name. | ||||||||||||||||||||||||||||||||
websiteId | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||
Vaulted instrument (object) or Alternative Instrument (object) or Cash (object) or Check (object) (PaymentInstrument) | |||||||||||||||||||||||||||||||||
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||
updatedTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map | ||||||||||||||||||||||||||||||||
object (ContactObject) | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
object (CustomerAverageValue) | |||||||||||||||||||||||||||||||||
paymentCount | integer The number of approved payments for the customer. | ||||||||||||||||||||||||||||||||
lastPaymentTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||
object (CustomerLifetimeRevenue) | |||||||||||||||||||||||||||||||||
invoiceCount | integer An auto-incrementing number based on the sequence of invoices. If set to 0, then this record is a Lead, otherwise is a Customer. | ||||||||||||||||||||||||||||||||
Array of objects (Tag) A list of customer's tags. | |||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||
revision | integer The number of times the customer data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation. | ||||||||||||||||||||||||||||||||
isEddRequired | boolean Default: false Indicates if EDD is enabled for this customer. | ||||||||||||||||||||||||||||||||
hasFulfilledKyc | boolean Whether the customer has fulfilled a KYC request by providing valid identity and address documents. | ||||||||||||||||||||||||||||||||
Array of SelfLink (object) or DefaultPaymentInstrumentLink (object) or LeadSourceLink (object) or WebsiteLink (object) >= 3 items The links related to resource. | |||||||||||||||||||||||||||||||||
Array of LeadSourceEmbed (object) non-empty Any embedded objects available that are requested by the | |||||||||||||||||||||||||||||||||
Array (non-empty) Any of: Lead Source object.
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Conflict.
Invalid data was sent.
{- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "paymentToken": "string",
- "defaultPaymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "customFields": {
- "foo": "bar"
}, - "primaryAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": "Rebilly",
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "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"
}, - "isEddRequired": false
}
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "defaultPaymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "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": "London",
- "region": "London",
- "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"
}, - "averageValue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "paymentCount": 0,
- "lastPaymentTime": "2019-08-24T14:15:22Z",
- "lifetimeRevenue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "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": [
- {
- "rel": "self",
- "href": "string"
}
]
}
], - "revision": 0,
- "isEddRequired": false,
- "hasFulfilledKyc": true,
- "_links": [
- {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "leadSource": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "original": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
}
}
]
}
Merge one duplicate customer to another target customer and delete the. former.
Customer has been merged and removed.
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
curl -i -X DELETE \ 'https://api-sandbox.rebilly.com/organizations/unknown/customers/{id}?targetCustomerId=string' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{- "status": 401,
- "title": "string",
- "detail": "string",
- "instance": "string"
}
Retrieve a Lead Source of given customer.
Lead Source was retrieved successfully.
medium | string Lead source medium (eg search, display). |
source | string Lead source origin (eg google, yahoo). |
campaign | string Lead source campaign (eg go-big-123). |
term | string Lead source term (eg salt shakers). |
content | string Lead source content (eg smiley faces). |
affiliate | string Lead source affiliate (eg 123, Bob Smith). |
subAffiliate | string Lead source sub-affiliate also called a sub-id or click id in some circles (eg 123456). |
salesAgent | string Lead source sales agent (eg James Bond). |
clickId | string Lead source click id (may come from an ad server). |
path | string Lead source path url (eg www.example.com/some/landing/path). |
referrer | string Lead source |
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. |
Array of SelfLink (object) or CustomerLink (object) non-empty The links related to resource. | |
original | object Recursive |
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
$customer = $client->customers()->load('myCustomerId'); $leadSource = $customer->getLeadSource();
{- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "original": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
}
Create a Lead Source for a customer.
Lead Source resource.
medium | string Lead source medium (eg search, display). |
source | string Lead source origin (eg google, yahoo). |
campaign | string Lead source campaign (eg go-big-123). |
term | string Lead source term (eg salt shakers). |
content | string Lead source content (eg smiley faces). |
affiliate | string Lead source affiliate (eg 123, Bob Smith). |
subAffiliate | string Lead source sub-affiliate also called a sub-id or click id in some circles (eg 123456). |
salesAgent | string Lead source sales agent (eg James Bond). |
clickId | string Lead source click id (may come from an ad server). |
path | string Lead source path url (eg www.example.com/some/landing/path). |
referrer | string Lead source |
Lead Source was created.
medium | string Lead source medium (eg search, display). |
source | string Lead source origin (eg google, yahoo). |
campaign | string Lead source campaign (eg go-big-123). |
term | string Lead source term (eg salt shakers). |
content | string Lead source content (eg smiley faces). |
affiliate | string Lead source affiliate (eg 123, Bob Smith). |
subAffiliate | string Lead source sub-affiliate also called a sub-id or click id in some circles (eg 123456). |
salesAgent | string Lead source sales agent (eg James Bond). |
clickId | string Lead source click id (may come from an ad server). |
path | string Lead source path url (eg www.example.com/some/landing/path). |
referrer | string Lead source |
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. |
Array of SelfLink (object) or CustomerLink (object) non-empty The links related to resource. | |
original | object Recursive |
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string"
}
{- "medium": "string",
- "source": "string",
- "campaign": "string",