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). |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
id | string <= 50 characters The customer identifier string. |
websiteId | string <= 50 characters The website's ID. |
VaultedInstrument (object) or AlternativePaymentInstrument (object) or CashInstrument (object) or CheckInstrument (object) (PaymentInstrument) | |
createdTime | string <date-time> The customer created time. |
updatedTime | string <date-time> The customer updated time. |
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> The most recent time of an approved payment for the customer. |
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. | |
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. |
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 |
$customers = $client->customers()->search([ 'filter' => 'firstName:John', ]);
[- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "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": null,
- "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
}
], - "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",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
], - "revision": 0,
- "_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.
Read our guide to preventing duplicates to understand more.
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
Customer resource.
websiteId | string <= 50 characters The website's ID. |
paymentToken | string A write-only payment token; if supplied, it will be converted into a
payment instrument and be set as the |
VaultedInstrument (object) or AlternativePaymentInstrument (object) or CashInstrument (object) or CheckInstrument (object) (PaymentInstrument) | |
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map |
object (ContactObject) |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
id | string <= 50 characters The customer identifier string. |
websiteId | string <= 50 characters The website's ID. |
VaultedInstrument (object) or AlternativePaymentInstrument (object) or CashInstrument (object) or CheckInstrument (object) (PaymentInstrument) | |
createdTime | string <date-time> The customer created time. |
updatedTime | string <date-time> The customer updated time. |
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> The most recent time of an approved payment for the customer. |
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. | |
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. |
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 |
{- "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": null,
- "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
}
]
}
}
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "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": null,
- "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
}
], - "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",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
], - "revision": 0,
- "_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.
id required | string <= 50 characters ^[@~\-\.\w]+$ The resource 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. |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
id | string <= 50 characters The customer identifier string. |
websiteId | string <= 50 characters The website's ID. |
VaultedInstrument (object) or AlternativePaymentInstrument (object) or CashInstrument (object) or CheckInstrument (object) (PaymentInstrument) | |
createdTime | string <date-time> The customer created time. |
updatedTime | string <date-time> The customer updated time. |
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> The most recent time of an approved payment for the customer. |
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. | |
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. |
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 |
$customers = $client->customers()->load('myCustomerId');
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "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": null,
- "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
}
], - "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",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
], - "revision": 0,
- "_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. Read our guide to preventing duplicates to understand more.
id required | string <= 50 characters ^[@~\-\.\w]+$ The resource identifier string. |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
Customer resource.
websiteId | string <= 50 characters The website's ID. |
paymentToken | string A write-only payment token; if supplied, it will be converted into a
payment instrument and be set as the |
VaultedInstrument (object) or AlternativePaymentInstrument (object) or CashInstrument (object) or CheckInstrument (object) (PaymentInstrument) | |
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map |
object (ContactObject) |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
id | string <= 50 characters The customer identifier string. |
websiteId | string <= 50 characters The website's ID. |
VaultedInstrument (object) or AlternativePaymentInstrument (object) or CashInstrument (object) or CheckInstrument (object) (PaymentInstrument) | |
createdTime | string <date-time> The customer created time. |
updatedTime | string <date-time> The customer updated time. |
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> The most recent time of an approved payment for the customer. |
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. | |
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. |
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 |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
id | string <= 50 characters The customer identifier string. |
websiteId | string <= 50 characters The website's ID. |
VaultedInstrument (object) or AlternativePaymentInstrument (object) or CashInstrument (object) or CheckInstrument (object) (PaymentInstrument) | |
createdTime | string <date-time> The customer created time. |
updatedTime | string <date-time> The customer updated time. |
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> The most recent time of an approved payment for the customer. |
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. | |
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. |
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 |
{- "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": null,
- "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
}
]
}
}
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "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": null,
- "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
}
], - "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",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
], - "revision": 0,
- "_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.
id required | string <= 50 characters ^[@~\-\.\w]+$ The resource identifier string. |
targetCustomerId required | string The customer identifier to get the data of the deleted duplicate customer. |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
curl -i -X DELETE \ 'https://api-sandbox.rebilly.com/customers/:id?targetCustomerId=string' \ -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{- "status": 400,
- "title": "string",
- "detail": "string",
- "error": "string"
}
Create Customer Timeline custom event type.
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
Customer Timeline Custom Event Type resource.
name required | string [ 1 .. 255 ] characters Customer Timeline Custom Event type name. It must not be similar to any Rebilly system event. |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
id | string <= 50 characters Customer Timeline Custom Event identifier string. |
name required | string [ 1 .. 255 ] characters Customer Timeline Custom Event type name. It must not be similar to any Rebilly system event. |
createdTime | string <date-time> Customer Timeline Custom event created time. |
updatedTime | string <date-time> Customer Timeline Custom event updated time. |
Array of objects (SelfLink) non-empty The links related to resource. |
{- "name": "string"
}
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Retrieve a Lead Source of given customer.
id required | string <= 50 characters ^[@~\-\.\w]+$ The resource identifier string. |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
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> Lead source created time. |
Array of SelfLink (object) or CustomerLink (object) non-empty The links related to resource. | |
original | object Recursive |
$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.
id required | string <= 50 characters ^[@~\-\.\w]+$ The resource identifier string. |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
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 |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
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> Lead source created time. |
Array of SelfLink (object) or CustomerLink (object) non-empty The links related to resource. | |
original | object Recursive |
{- "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",
- "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"
}
]
}
}
Delete a Lead Source that belongs to a certain customer.
id required | string <= 50 characters ^[@~\-\.\w]+$ The resource identifier string. |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
$customer = $client->customers()->deleteLeadSource('myCustomerId');
{- "status": 400,
- "title": "string",
- "detail": "string",
- "error": "string"
}
Customer webhook request body resource.
customerId | string The customer ID. |
eventType | string (GlobalWebhookEventType) Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "gateway-account-requested" "invoice-abandoned" "invoice-created" "invoice-issued" "invoice-modified" "invoice-paid" "invoice-past-due" "invoice-past-due-reminder" "invoice-reissued" "invoice-voided" "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "renewal-invoice-issued" "renewal-invoice-payment-canceled" "renewal-invoice-payment-declined" "risk-score-changed" "subscription-activated" "subscription-canceled" "subscription-modified" "subscription-reactivated" "subscription-renewal-reminder" "subscription-renewed" "subscription-trial-converted" "subscription-trial-end-reminder" "subscription-trial-ended" "subscription-trial-end-changed" "transaction-amount-discrepancy-found" "transaction-declined" "transaction-discrepancy-found" "transaction-process-requested" "transaction-processed" "transaction-reconciled" "transaction-timeout-resolved" "waiting-gateway-transaction-completed" Rebilly webhooks event type. |
object | |
Array of CustomerLink (object) non-empty The links related to resource. |
{- "customerId": "string",
- "eventType": "aml-list-possibly-matched",
- "_embedded": {
- "customer": {
- "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": null,
- "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
}
]
}
}
}, - "_links": [
- {
- "rel": "customer",
- "href": "string"
}
]
}
Merged customer webhook request body resource.
targetCustomerId | string The ID of the customer containing the merged data. |
eventType | string (GlobalWebhookEventType) Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "gateway-account-requested" "invoice-abandoned" "invoice-created" "invoice-issued" "invoice-modified" "invoice-paid" "invoice-past-due" "invoice-past-due-reminder" "invoice-reissued" "invoice-voided" "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "renewal-invoice-issued" "renewal-invoice-payment-canceled" "renewal-invoice-payment-declined" "risk-score-changed" "subscription-activated" "subscription-canceled" "subscription-modified" "subscription-reactivated" "subscription-renewal-reminder" "subscription-renewed" "subscription-trial-converted" "subscription-trial-end-reminder" "subscription-trial-ended" "subscription-trial-end-changed" "transaction-amount-discrepancy-found" "transaction-declined" "transaction-discrepancy-found" "transaction-process-requested" "transaction-processed" "transaction-reconciled" "transaction-timeout-resolved" "waiting-gateway-transaction-completed" Rebilly webhooks event type. |
object (Customer) | |
object Customer object. | |
Array of CustomerLink (object) non-empty The links related to resource. |
{- "targetCustomerId": "string",
- "eventType": "aml-list-possibly-matched",
- "duplicatedCustomer": {
- "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": null,
- "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
}
]
}
}, - "_embedded": {
- "targetCustomer": {
- "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": null,
- "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
}
]
}
}
}, - "_links": [
- {
- "rel": "customer",
- "href": "string"
}
]
}
Customer webhook request body resource.
customerId | string The customer ID. |
eventType | string (GlobalWebhookEventType) Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "gateway-account-requested" "invoice-abandoned" "invoice-created" "invoice-issued" "invoice-modified" "invoice-paid" "invoice-past-due" "invoice-past-due-reminder" "invoice-reissued" "invoice-voided" "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "renewal-invoice-issued" "renewal-invoice-payment-canceled" "renewal-invoice-payment-declined" "risk-score-changed" "subscription-activated" "subscription-canceled" "subscription-modified" "subscription-reactivated" "subscription-renewal-reminder" "subscription-renewed" "subscription-trial-converted" "subscription-trial-end-reminder" "subscription-trial-ended" "subscription-trial-end-changed" "transaction-amount-discrepancy-found" "transaction-declined" "transaction-discrepancy-found" "transaction-process-requested" "transaction-processed" "transaction-reconciled" "transaction-timeout-resolved" "waiting-gateway-transaction-completed" Rebilly webhooks event type. |
object | |
Array of CustomerLink (object) non-empty The links related to resource. |
{- "customerId": "string",
- "eventType": "aml-list-possibly-matched",
- "_embedded": {
- "customer": {
- "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": null,
- "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
}
]
}
}
}, - "_links": [
- {
- "rel": "customer",
- "href": "string"
}
]
}
Customer webhook request body resource.
customerId | string The customer ID. |
eventType | string (GlobalWebhookEventType) Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "gateway-account-requested" "invoice-abandoned" "invoice-created" "invoice-issued" "invoice-modified" "invoice-paid" "invoice-past-due" "invoice-past-due-reminder" "invoice-reissued" "invoice-voided" "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "renewal-invoice-issued" "renewal-invoice-payment-canceled" "renewal-invoice-payment-declined" "risk-score-changed" "subscription-activated" "subscription-canceled" "subscription-modified" "subscription-reactivated" "subscription-renewal-reminder" "subscription-renewed" "subscription-trial-converted" "subscription-trial-end-reminder" "subscription-trial-ended" "subscription-trial-end-changed" "transaction-amount-discrepancy-found" "transaction-declined" "transaction-discrepancy-found" "transaction-process-requested" "transaction-processed" "transaction-reconciled" "transaction-timeout-resolved" "waiting-gateway-transaction-completed" Rebilly webhooks event type. |
object | |
Array of CustomerLink (object) non-empty The links related to resource. |
{- "customerId": "string",
- "eventType": "aml-list-possibly-matched",
- "_embedded": {
- "customer": {
- "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": null,
- "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
}
]
}
}
}, - "_links": [
- {
- "rel": "customer",
- "href": "string"
}
]
}
Experian check performed webhook request body resource.
customerId | string The ID of the checked customer. |
outcome | integer Enum: -1 0 1 The check decision where |
reason | string The text representation of the outcome. |
errorCode | string Error code produced by the Experian system. |
errorMessage | string Error message produced by the Experian system. |
eventType | string (GlobalWebhookEventType) Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "gateway-account-requested" "invoice-abandoned" "invoice-created" "invoice-issued" "invoice-modified" "invoice-paid" "invoice-past-due" "invoice-past-due-reminder" "invoice-reissued" "invoice-voided" "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "renewal-invoice-issued" "renewal-invoice-payment-canceled" "renewal-invoice-payment-declined" "risk-score-changed" "subscription-activated" "subscription-canceled" "subscription-modified" "subscription-reactivated" "subscription-renewal-reminder" "subscription-renewed" "subscription-trial-converted" "subscription-trial-end-reminder" "subscription-trial-ended" "subscription-trial-end-changed" "transaction-amount-discrepancy-found" "transaction-declined" "transaction-discrepancy-found" "transaction-process-requested" "transaction-processed" "transaction-reconciled" "transaction-timeout-resolved" "waiting-gateway-transaction-completed" Rebilly webhooks event type. |
object Customer object. | |
Array of CustomerLink (object) non-empty The links related to resource. |
{- "customerId": "string",
- "outcome": 1,
- "reason": "Individual has a 90 percent or greater match to forename surname premise postcode with ID verified and DOB",
- "errorCode": "001",
- "errorMessage": "Authentication Error: Bad Username or Password",
- "eventType": "aml-list-possibly-matched",
- "_embedded": {
- "customer": {
- "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": null,
- "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
}
]
}
}
}, - "_links": [
- {
- "rel": "customer",
- "href": "string"
}
]
}