The Rebilly API is built on HTTP and is RESTful. It has predictable resource URLs and returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. Use your favorite HTTP/REST library in your programming language when using this API, or use one of the Rebilly SDKs, which are available in PHP and JavaScript.
Every action in the Rebilly UI is supported by an API which is documented and available for use, so that you may automate any necessary workflows or processes. This API reference documentation contains the most commonly integrated resources.
This topic describes the different forms of authentication that are available in the Rebilly API, and how to use them.
Rebilly offers four forms of authentication: secret key, publishable key, JSON Web Tokens, and public signature key.
To create or manage API keys, select one of the following:
For more information on API keys, see API keys.
Rebilly follows the error response format proposed in RFC 9457, which is also known as Problem Details for HTTP APIs. As with any API responses, your client must be prepared to gracefully handle additional members of the response.
Rebilly provides a JavaScript SDK and a PHP SDK to help interact with the Rebilly API. However, no SDK is required to use the API.
Rebilly also provides FramePay, a client-side iFrame-based solution, to help create payment tokens while minimizing PCI DSS compliance burdens and maximizing your customization ability. FramePay interacts with the payment tokens creation operation.
For installation and usage instructions, see SDKs. All JavaScript SDK code examples are included in the API reference documentation.
For installation and usage instructions, see SDKs. All SDK code examples are included in the API reference documentation. To use them, you must configure the $client as follows:
$client = new Rebilly\Client([
'apiKey' => 'YourApiKeyHere',
'baseUrl' => 'https://api.rebilly.com',
]);The full Rebilly API has over 500 operations. This is likely more than you may need to implement your use cases. If you would like to implement a particular use case, contact Rebilly for guidance and feedback on the best API operations to use for the task.
To integrate Rebilly, and learn about related resources and concepts, see Get started.
Rebilly enforces rate limits on the API to ensure that no single organization consumes too many resources. Rate limits are applied to the organization, and not to the API key. In sandbox environment, rate limits are enforced for non-GET endpoints and are set at 3000 requests per 10 minutes. You can find the exact number of consumed requests in the X-RateLimit-Limit and X-RateLimit-Remaining headers in the response. If the rate limit is exceeded, the API returns a 429 Too Many Requests response and a X-RateLimit-Retry-After header that includes a UTC timestamp of when the rate limit resets.
Use these operations to manage customers. A customer is an entity that purchases goods or services from you (a merchant), and is the payee in any transaction that is credited to you. Customers are associated with payment instruments, subscriptions, invoices, and other related resources.
In other systems, customers may be referred to as accounts, clients, members, patrons, or players. For information on the customer resource, see Resources.
Specifies the starting point within the collection of items to be returned.
Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.
For more information, see Using filter with collections.
Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.
For more information, see Expand to include embedded objects.
Limits the returned fields to the specified list, each field separated by a comma. The ID value is always returned.
curl -i -X GET \
'https://www.rebilly.com/_mock/docs/dev-docs/api/customers?expand=string&fields=string&filter=string&limit=1000&offset=1000&q=string&sort=string' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'List of customers retrieved.
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.
To use this payment instrument for automatic subscription renewals, and for transactions when no specific payment instrument is provided by the user, set this as the default payment instrument.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
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.
Customer's primary address.
Customer's primary address.
Company information that is associated with the customer's primary email address domain.
This is a paid feature, to enable it contact Rebilly.
Time and date of the customer's last approved payment.
Total number of invoices issued to the customer. This value is auto-incrementing. If this value is 0, the record relates to a lead. A lead is a customer who has not made a payment yet. If this value is greater than or equal to 1 the record relates to a customer.
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.
Specifies if Enhanced Due Diligence (EDD) is enabled for this customer. For more information, see Enhanced Due Diligence.
Specifies if the customer has accepted and reviewed identity and address documents, or an accepted credit file document.
Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.
Embedded objects that are requested using the expand query string parameter.
[ { "id": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "email": "user@example.com", "firstName": "string", "lastName": "string", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "defaultPaymentInstrument": { … }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "customFields": { … }, "primaryAddress": { … }, "company": { … }, "averageValue": { … }, "paymentCount": 0, "lastPaymentTime": "2019-08-24T14:15:22Z", "lifetimeRevenue": { … }, "invoiceCount": 0, "tags": [ … ], "revision": 0, "isEddRequired": false, "hasFulfilledKyc": true, "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "locale": "fr-FR", "taxNumbers": [ … ], "_links": [ … ], "_embedded": { … } } ]
Creates a new customer and customer ID.
The customer's primary address is used as the default address for payment instruments, subscriptions, and invoices if none are provided.
If the customer already has an identifier within your system, and you want to create customer with a predefined ID — to prevent duplicate customers, use the Upsert a customer with predefined ID operation. For more information, see Prevent duplicate customers.
Customer resource.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
Write-only payment token. If supplied, the token is converted into a payment instrument and set as the defaultPaymentInstrument value. If both are supplied, the value of this property overrides the defaultPaymentInstrument value. The token expires after first use.
Vaulted payment instrument.
To use this payment instrument for automatic subscription renewals, and for transactions when no specific payment instrument is provided by the user, set this as the default payment instrument.
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.
Customer's primary address.
Customer's primary address.
Specifies if Enhanced Due Diligence (EDD) is enabled for this customer. For more information, see Enhanced Due Diligence.
curl -i -X POST \
https://www.rebilly.com/_mock/docs/dev-docs/api/customers \
-H 'Content-Type: application/json' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE' \
-d '{
"websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
"paymentToken": "string",
"defaultPaymentInstrument": {
"method": "payment-card",
"paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N"
},
"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"
},
"isEddRequired": false,
"locale": "fr-FR",
"taxNumbers": [
{
"type": "eu-vat",
"value": "GB980780684",
"isDefault": true
}
]
}'Customer created.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
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.
To use this payment instrument for automatic subscription renewals, and for transactions when no specific payment instrument is provided by the user, set this as the default payment instrument.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
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.
Customer's primary address.
Customer's primary address.
Company information that is associated with the customer's primary email address domain.
This is a paid feature, to enable it contact Rebilly.
Time and date of the customer's last approved payment.
Total number of invoices issued to the customer. This value is auto-incrementing. If this value is 0, the record relates to a lead. A lead is a customer who has not made a payment yet. If this value is greater than or equal to 1 the record relates to a customer.
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.
Specifies if Enhanced Due Diligence (EDD) is enabled for this customer. For more information, see Enhanced Due Diligence.
Specifies if the customer has accepted and reviewed identity and address documents, or an accepted credit file document.
Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.
{ "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": [ … ], "emails": [ … ], "dob": "1980-04-01", "jobTitle": "CEO", "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221" }, "company": { "name": "string", "domain": "string", "yearFounded": 0, "industry": "string", "employeesCount": 0, "country": "string", "locality": "string", "_links": [ … ] }, "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": [ { … } ], "revision": 0, "isEddRequired": false, "hasFulfilledKyc": true, "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "locale": "fr-FR", "taxNumbers": [ { … } ], "_links": [ { … } ], "_embedded": { "leadSource": {} } }
Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.
For more information, see Expand to include embedded objects.
curl -i -X GET \
'https://www.rebilly.com/_mock/docs/dev-docs/api/customers/{id}?expand=string&fields=string' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'Customer retrieved.
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.
To use this payment instrument for automatic subscription renewals, and for transactions when no specific payment instrument is provided by the user, set this as the default payment instrument.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
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.
Customer's primary address.
Customer's primary address.
Company information that is associated with the customer's primary email address domain.
This is a paid feature, to enable it contact Rebilly.
Time and date of the customer's last approved payment.
Total number of invoices issued to the customer. This value is auto-incrementing. If this value is 0, the record relates to a lead. A lead is a customer who has not made a payment yet. If this value is greater than or equal to 1 the record relates to a customer.
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.
Specifies if Enhanced Due Diligence (EDD) is enabled for this customer. For more information, see Enhanced Due Diligence.
Specifies if the customer has accepted and reviewed identity and address documents, or an accepted credit file document.
Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.
{ "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": [ … ], "emails": [ … ], "dob": "1980-04-01", "jobTitle": "CEO", "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221" }, "company": { "name": "string", "domain": "string", "yearFounded": 0, "industry": "string", "employeesCount": 0, "country": "string", "locality": "string", "_links": [ … ] }, "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": [ { … } ], "revision": 0, "isEddRequired": false, "hasFulfilledKyc": true, "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "locale": "fr-FR", "taxNumbers": [ { … } ], "_links": [ { … } ], "_embedded": { "leadSource": {} } }
Creates or updates (upserts) a customer with a specified ID.
If the customer already has an identifier within your system, and you want to create a customer with a specified ID — use this operation to prevent duplicate customers. For more information, see Prevent duplicate customers.
Customer resource.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
Write-only payment token. If supplied, the token is converted into a payment instrument and set as the defaultPaymentInstrument value. If both are supplied, the value of this property overrides the defaultPaymentInstrument value. The token expires after first use.
Vaulted payment instrument.
To use this payment instrument for automatic subscription renewals, and for transactions when no specific payment instrument is provided by the user, set this as the default payment instrument.
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.
Customer's primary address.
Customer's primary address.
Specifies if Enhanced Due Diligence (EDD) is enabled for this customer. For more information, see Enhanced Due Diligence.
curl -i -X PUT \
'https://www.rebilly.com/_mock/docs/dev-docs/api/customers/{id}' \
-H 'Content-Type: application/json' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE' \
-d '{
"websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
"paymentToken": "string",
"defaultPaymentInstrument": {
"method": "payment-card",
"paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N"
},
"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"
},
"isEddRequired": false,
"locale": "fr-FR",
"taxNumbers": [
{
"type": "eu-vat",
"value": "GB980780684",
"isDefault": true
}
]
}'Customer.
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.
To use this payment instrument for automatic subscription renewals, and for transactions when no specific payment instrument is provided by the user, set this as the default payment instrument.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
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.
Customer's primary address.
Customer's primary address.
Company information that is associated with the customer's primary email address domain.
This is a paid feature, to enable it contact Rebilly.
Time and date of the customer's last approved payment.
Total number of invoices issued to the customer. This value is auto-incrementing. If this value is 0, the record relates to a lead. A lead is a customer who has not made a payment yet. If this value is greater than or equal to 1 the record relates to a customer.
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.
Specifies if Enhanced Due Diligence (EDD) is enabled for this customer. For more information, see Enhanced Due Diligence.
Specifies if the customer has accepted and reviewed identity and address documents, or an accepted credit file document.
Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.
{ "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": [ … ], "emails": [ … ], "dob": "1980-04-01", "jobTitle": "CEO", "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221" }, "company": { "name": "string", "domain": "string", "yearFounded": 0, "industry": "string", "employeesCount": 0, "country": "string", "locality": "string", "_links": [ … ] }, "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": [ { … } ], "revision": 0, "isEddRequired": false, "hasFulfilledKyc": true, "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "locale": "fr-FR", "taxNumbers": [ { … } ], "_links": [ { … } ], "_embedded": { "leadSource": {} } }
curl -i -X DELETE \
'https://www.rebilly.com/_mock/docs/dev-docs/api/customers/{id}?targetCustomerId=string' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'Customer is merged and deleted.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
{ "status": 401, "type": "http://example.com", "title": "string", "detail": "string", "instance": "string" }
Retrieves lead source data for a customer with a specified ID.
A lead source is the marketing campaign that generates customer interaction, a sale, or a trial. For more information, see Lead source attribution.
curl -i -X GET \
'https://www.rebilly.com/_mock/docs/dev-docs/api/customers/{id}/lead-source' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'Lead source retrieved.
Category of the lead source traffic. For example, the medium could be organic search, Google ads, Display ads, and so on.
Domain, platform, or channel from which the lead source originates.
Content contained in the lead source content. For example, content could be graphics, video, and so on.
Individual or entity that is affiliated with the lead source.
Individual or entity that is associated with a lead source affiliate. In other products, this field may also be referred to as sub ID or click ID in some.
ID of the lead source click. This value is passed in the ad click URL for tracking and campaign attribution.
Lead source referrer URL.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
{ "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", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ], "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", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ … ] } }
Creates a lead source for a customer with a specified ID.
A lead source is the marketing campaign that generates customer interaction, a sale, or a trial. For more information, see Lead source attribution.
Lead Source resource.
Category of the lead source traffic. For example, the medium could be organic search, Google ads, Display ads, and so on.
Domain, platform, or channel from which the lead source originates.
Content contained in the lead source content. For example, content could be graphics, video, and so on.
Individual or entity that is affiliated with the lead source.
Individual or entity that is associated with a lead source affiliate. In other products, this field may also be referred to as sub ID or click ID in some.
ID of the lead source click. This value is passed in the ad click URL for tracking and campaign attribution.
Lead source referrer URL.
curl -i -X PUT \
'https://www.rebilly.com/_mock/docs/dev-docs/api/customers/{id}/lead-source' \
-H 'Content-Type: application/json' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE' \
-d '{
"medium": "string",
"source": "string",
"campaign": "string",
"term": "string",
"content": "string",
"affiliate": "string",
"subAffiliate": "string",
"salesAgent": "string",
"clickId": "string",
"path": "string",
"referrer": "string"
}'Lead source created.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
Category of the lead source traffic. For example, the medium could be organic search, Google ads, Display ads, and so on.
Domain, platform, or channel from which the lead source originates.
Content contained in the lead source content. For example, content could be graphics, video, and so on.
Individual or entity that is affiliated with the lead source.
Individual or entity that is associated with a lead source affiliate. In other products, this field may also be referred to as sub ID or click ID in some.
ID of the lead source click. This value is passed in the ad click URL for tracking and campaign attribution.
Lead source referrer URL.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
{ "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", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ], "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", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ … ] } }
curl -i -X DELETE \
'https://www.rebilly.com/_mock/docs/dev-docs/api/customers/{id}/lead-source' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'Lead source deleted.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
{ "status": 401, "type": "http://example.com", "title": "string", "detail": "string", "instance": "string" }
curl -i -X GET \
'https://www.rebilly.com/_mock/docs/dev-docs/api/customers/{id}/edd-score' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'{ "parsedScore": { "occupation": "not-found", "arrest": "not-found", "bankruptcy": "not-found", "fraud": "not-found", "occupationDetails": { … }, "arrestDetails": { … }, "bankruptcyDetails": { … }, "fraudDetails": { … } }, "score": { "occupation": "not-found", "arrest": "not-found", "bankruptcy": "not-found", "fraud": "not-found" }, "nextUpdateTime": "2019-08-24T14:15:22Z", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }
curl -i -X PATCH \
'https://www.rebilly.com/_mock/docs/dev-docs/api/customers/{id}/edd-score' \
-H 'Content-Type: application/json' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE' \
-d '{
"score": {
"occupation": "not-found",
"arrest": "not-found",
"bankruptcy": "not-found",
"fraud": "not-found"
}
}'EDD score updated.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
Date and time in ISO 8601 format when the EDD score is updated.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
{ "parsedScore": { "occupation": "not-found", "arrest": "not-found", "bankruptcy": "not-found", "fraud": "not-found", "occupationDetails": { … }, "arrestDetails": { … }, "bankruptcyDetails": { … }, "fraudDetails": { … } }, "score": { "occupation": "not-found", "arrest": "not-found", "bankruptcy": "not-found", "fraud": "not-found" }, "nextUpdateTime": "2019-08-24T14:15:22Z", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }
curl -i -X GET \
'https://www.rebilly.com/_mock/docs/dev-docs/api/customers/{id}/edd-search-results?limit=1000&offset=1000' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'[ { "id": "cus_edd_01H057XGZ62JZED3P8DWAXPAE6", "type": "occupation", "searchResultData": [ … ], "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z" } ]
curl -i -X GET \
'https://www.rebilly.com/_mock/docs/dev-docs/api/customers/{id}/edd-search-results/{searchResultId}' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'{ "id": "cus_edd_01H057XGZ62JZED3P8DWAXPAE6", "type": "occupation", "searchResultData": [ { … } ], "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z" }
Customer webhook request body resource.
Type of webhook event.
{ "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "eventType": "aml-list-possibly-matched", "_embedded": { "customer": { … } }, "_links": [ { … } ] }
Merged customer webhook request body resource.
ID of the customer that contains the merged data.
{ "targetCustomerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "eventType": "customer-merged", "duplicatedCustomer": { "id": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "email": "user@example.com", "firstName": "string", "lastName": "string", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "defaultPaymentInstrument": { … }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "customFields": { … }, "primaryAddress": { … }, "company": { … }, "averageValue": { … }, "paymentCount": 0, "lastPaymentTime": "2019-08-24T14:15:22Z", "lifetimeRevenue": { … }, "invoiceCount": 0, "tags": [ … ], "revision": 0, "isEddRequired": false, "hasFulfilledKyc": true, "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "locale": "fr-FR", "taxNumbers": [ … ], "_links": [ … ], "_embedded": { … } }, "_embedded": { "targetCustomer": { … } }, "_links": [ { … } ] }
Customer webhook request body resource.
Type of webhook event.
{ "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "eventType": "aml-list-possibly-matched", "_embedded": { "customer": { … } }, "_links": [ { … } ] }
Customer webhook request body resource.
Type of webhook event.
{ "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "eventType": "aml-list-possibly-matched", "_embedded": { "customer": { … } }, "_links": [ { … } ] }
Experian check performed webhook request body resource.
Check decision where 1 - record matches, 0 - no matches found, -1 - record mismatches.
Text representation of the outcome.
Error message produced by the Experian system.
{ "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "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": "experian-check-performed", "_embedded": { "customer": { … } }, "_links": [ { … } ] }
Use these operations to manage payment instruments. Payment instrument is a term which describes any means of making a digital payment, such as: credit cards, debit cards, direct debits, payment service providers, and digital wallets.
For more information on payment instruments, see Payment instruments.
Use payment tokens to reduce the scope of PCI DSS compliance.
A payment token can be made using a different authentication scheme (public key authentication), which enables you to create a payment token directly from the browser. This bypasses the need to send sensitive cardholder info to your servers. We recommend using this with the FramePay library, which helps you integrate a form into this API resource and create payment tokens.
Use these operations to manage disputes. A dispute occurs when a customer contests a charge to their account. The dispute and related information is made available to the merchant by the bank or credit card company. The merchant then has the option to represent the charge and win the case. This process is called dispute resolution. If the merchant is unable to represent the charge, the card issuer typically reverses the sale and adds fees on top of the charge. This process is called a chargeback.
Use these operations to manage customer orders. An order is a customer's request to purchase items. It can contain subscription and one-time sale items. When an order contains one or more subscription items, it is a subscription order.
An order generates an invoice. A subscription order generates an invoice for each service period. For more information, see Orders.
Use these operations to manage the product usage of a subscription item for metered billing purposes.
Use metered billing when product quantity is unknown to the customer at the moment of creating a subscription. Metered billing is based on reported usage records. Every reported usage updates the quantity of an upcoming invoice item for a specified subscription and a plan. To create a metered billing plan, see Plans.
Use credit memos to provide a customer with store credit. A common use case for using a credit memo is to provide a customer with store credit, rather than a refund, if the customer pays more than they owe or returns a product. For information on the credit memo resource, see Resources.
Use pricing plans to describe how the customer must pay for products.
Rebilly provides the following plan types:
For information on the plans resource, see Plans.
For information on plan pricing, see Pricing formulas.
Use coupons to reward customers, generate sales, or to test new pricing strategies. Coupons enable you to apply different types of discounts to invoices, subscriptions, and pricing plans.
Redeemed coupons are attached to a customer's account. Depending on the coupon restrictions, the redeemed coupons are then applied from the customer's account to subsequent invoices or subscriptions. Redeemed coupons can only be applied to invoices of the same currency.
Once a coupon is redeemed it cannot be modified. You may deactivate a coupon or create a new coupon, but you cannot reuse the same coupon code. If you have a use case where you must reuse the same code, contact Rebilly.
Use quote operations to create and manage quotations. Quotations describe the cost of goods or services to potential customers before they commit to a purchase. A quote contains an initial invoice preview that can be accepted to become an order.
A quote can contain subscription and one-time sale items. When a quote contains one or more subscription items, it is a subscription order quote.
Use blocklists to prevent fraud and criminal activity.
Blocklists are lists of customer attribute values that are blocked from buying from you. For example, if a customer attempts to make a purchase from you with a credit card that is in a blocklist, the transaction is blocked and is not processed.
Before a new transaction is processed in Rebilly, blocklists are examined to check for attributes related to the entity. If a match is detected, the operation is aborted. A blocklist that expires after a period of time is called a greylist.
Use allowlists to exclude specific customer attribute data from risk score checks.
Allowlists are lists of data that are excluded from risk score checks. Allowlists prevent specific data from being added to a blocklist record when a risk score threshold reached.
Use Know Your Customer (KYC) documents to verify your customers identity. The KYC document operations generate a signed link to the Rebilly KYC document gatherer.
Document types:
identity-proof: Validates a customer's identity.address-proof: Validates a customer's address.purchase-proof: Validates a customer's purchase.funds-proof: Validates that a customer has funds.credit-file-proof: Verifies that there is an existing credit file with two sources that match the customer's name, DOB, and address.Rebilly parses and analyzes the documents and accepts or rejects them according to a configurable scoring algorithm. When all document types in a KYC request are accepted, the status is fulfilled, and the KYC request fulfilled webhook is sent.
Use Anti-Money Laundering (AML) operations to screen customers and help prevent your business from becoming directly or indirectly involved in criminal activity.
Use AML operations during customer creation, and some transaction processing, to help determine if a potential customer (lead), or customer, has political or economic sanctions against them.
AML operations search the following for screening purposes: Politically Exposed Persons (PEPs) lists, sanction lists, and adverse media lists.
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. Depending on the resource on which the custom field is added, it may be available in the Rebilly UI.
Example: A custom field called preferredCommunicationChannel is added to the customer resource. It has two allowed values, which are 'email' and 'phone'.
{
"customFields": {
"preferredCommunicationChannel": "email"
}
}For detailed information on Rebilly resources, see Resources.
Use the file entity to store files and related metadata. Files can be sorted by size, MIME-type, user-defined tags, and description.
The following methods are available to upload files: multipart/form-data encoded form, RAW POST — by sending the file contents as the POST body, and fetching from URL — by providing the file URL using the 'url' parameter.
Use the attachments entity to link a file to one or multiple objects, such as: customer, dispute, transaction, order, plan, product, invoice, or timeline comment. Attachments enable you to quickly find and use files related to specific entities.