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.
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.
The following coupon description types are available:
restrict-to-countries: Restricts a coupon for use in specific countries.discounts-per-redemption: Restricts the number of times that the coupon can be applied by one redemption. For example, use this restriction to configure a coupon that can only be applied to the first subscription renewal of a particular product.minimum-order-amount: Sets a minimum order amount for a coupon application. For example, if the restriction amount is $20, the coupon is only applied to invoices with a total amount of $20 or more.restrict-to-invoices: Restricts a coupon to specific invoices.restrict-to-plans: Restricts a coupon to specific pricing plans.restrict-to-subscriptions: Restricts a coupon to specific order subscriptions.restrict-to-customer-tags: Restricts a coupon to customers with specific tags.restrict-to-customers: Restricts a coupon to specific customers.restrict-to-exclusive-application: Restricts a coupon so that it cannot be used in combination with other coupons. If more than one coupon is active, a coupon with this restriction is only applied if it provides a larger discount than the other coupons combined. If a coupon with this restriction is applied, all other coupons are removed.restrict-to-products: Restricts a coupon to specific products.paid-by-time: Specifies a date and time at which a coupon redemption expires if not paid.redemptions-per-customer: Restricts the number of times that a coupon can be redeemed by one customer. For example, use this restriction to limit the number of redemptions to one per customer.total-redemptions: Restricts the number of times a coupon can be redeemed by different customers.restrict-to-bxgy: Provides "buy X get Y" promotions. These promotions incentivize new customers to buy and also reward existing customers. This restriction type enables you to add discounted plans to an invoice when a certain quantity of other plans are purchased. For example, if a customer buys two or more books, they get one free bookmark.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.
curl -i -X GET \
'https://www.rebilly.com/_mock/docs/dev-docs/api/coupons-redemptions?filter=string&limit=1000&offset=1000&q=string&sort=string' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'[ { "id": "cpn_rdm_01HXC82EEPW6YD3MPWJY7151VR", "couponId": "cpn_0YVCNKF81GD778N4YNVGDJK558", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "additionalRestrictions": [ … ], "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "canceledTime": "2019-08-24T14:15:22Z", "_links": [ … ] } ]
curl -i -X POST \
https://www.rebilly.com/_mock/docs/dev-docs/api/coupons-redemptions \
-H 'Content-Type: application/json' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE' \
-d '{
"couponId": "cpn_0YVCNKF81GD778N4YNVGDJK558",
"customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
"additionalRestrictions": [
{
"type": "discounts-per-redemption",
"quantity": 0
}
]
}'Coupon redeemed.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
Additional coupon redemption restrictions.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
{ "id": "cpn_rdm_01HXC82EEPW6YD3MPWJY7151VR", "couponId": "cpn_0YVCNKF81GD778N4YNVGDJK558", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "additionalRestrictions": [ { … } ], "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "canceledTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }
curl -i -X GET \
'https://www.rebilly.com/_mock/docs/dev-docs/api/coupons-redemptions/{id}' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'{ "id": "cpn_rdm_01HXC82EEPW6YD3MPWJY7151VR", "couponId": "cpn_0YVCNKF81GD778N4YNVGDJK558", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "additionalRestrictions": [ { … } ], "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "canceledTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }
curl -i -X POST \
'https://www.rebilly.com/_mock/docs/dev-docs/api/coupons-redemptions/{id}/cancel' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'Coupon redemption cancelled.
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" }
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.
curl -i -X GET \
'https://www.rebilly.com/_mock/docs/dev-docs/api/coupons?filter=string&limit=1000&offset=1000&q=string&sort=string' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'List of coupons retrieved.
ID of the coupon. This value is also known as the coupon redemption code.
Coupon fixed amount discount.
Description of the coupon. Use this field to provide an invoice discount item description.
If this field is empty, the invoice discount item description uses the related coupon ID, in the following format: Coupon "COUPON-ID".
Date and time when the coupon is issued. This value may also be described as start time of the coupon.
Number of times the coupon data has been modified.
Use the revision number when analyzing webhook data to determine if a change should take precedence over the current representation.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
[ { "id": "cpn_0YVCNKF81GD778N4YNVGDJK558", "discount": { … }, "restrictions": [ … ], "redemptionsCount": 0, "status": "draft", "description": "string", "issuedTime": "2019-08-24T14:15:22Z", "expiredTime": "2019-08-24T14:15:22Z", "revision": 0, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ … ] } ]
Coupon resource.
Coupon fixed amount discount.
Description of the coupon. Use this field to provide an invoice discount item description.
If this field is empty, the invoice discount item description uses the related coupon ID, in the following format: Coupon "COUPON-ID".
Date and time when the coupon is issued. This value may also be described as start time of the coupon.
curl -i -X POST \
https://www.rebilly.com/_mock/docs/dev-docs/api/coupons \
-H 'Content-Type: application/json' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE' \
-d '{
"discount": {
"amount": 0.01,
"currency": "USD",
"type": "fixed",
"context": "items"
},
"restrictions": [
{
"type": "discounts-per-redemption",
"quantity": 0
}
],
"description": "string",
"issuedTime": "2019-08-24T14:15:22Z",
"expiredTime": "2019-08-24T14:15:22Z"
}'Coupon created.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
ID of the coupon. This value is also known as the coupon redemption code.
Coupon fixed amount discount.
Description of the coupon. Use this field to provide an invoice discount item description.
If this field is empty, the invoice discount item description uses the related coupon ID, in the following format: Coupon "COUPON-ID".
Date and time when the coupon is issued. This value may also be described as start time of the coupon.
Number of times the coupon data has been modified.
Use the revision number when analyzing webhook data to determine if a change should take precedence over the current representation.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
{ "id": "cpn_0YVCNKF81GD778N4YNVGDJK558", "discount": { "amount": 0.01, "currency": "USD", "type": "fixed", "context": "items" }, "restrictions": [ { … } ], "redemptionsCount": 0, "status": "draft", "description": "string", "issuedTime": "2019-08-24T14:15:22Z", "expiredTime": "2019-08-24T14:15:22Z", "revision": 0, "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/coupons/{id}' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'Coupon retrieved.
ID of the coupon. This value is also known as the coupon redemption code.
Coupon fixed amount discount.
Description of the coupon. Use this field to provide an invoice discount item description.
If this field is empty, the invoice discount item description uses the related coupon ID, in the following format: Coupon "COUPON-ID".
Date and time when the coupon is issued. This value may also be described as start time of the coupon.
Number of times the coupon data has been modified.
Use the revision number when analyzing webhook data to determine if a change should take precedence over the current representation.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
{ "id": "cpn_0YVCNKF81GD778N4YNVGDJK558", "discount": { "amount": 0.01, "currency": "USD", "type": "fixed", "context": "items" }, "restrictions": [ { … } ], "redemptionsCount": 0, "status": "draft", "description": "string", "issuedTime": "2019-08-24T14:15:22Z", "expiredTime": "2019-08-24T14:15:22Z", "revision": 0, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }
Coupon resource.
Coupon fixed amount discount.
Description of the coupon. Use this field to provide an invoice discount item description.
If this field is empty, the invoice discount item description uses the related coupon ID, in the following format: Coupon "COUPON-ID".
Date and time when the coupon is issued. This value may also be described as start time of the coupon.
curl -i -X PUT \
'https://www.rebilly.com/_mock/docs/dev-docs/api/coupons/{id}' \
-H 'Content-Type: application/json' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE' \
-d '{
"discount": {
"amount": 0.01,
"currency": "USD",
"type": "fixed",
"context": "items"
},
"restrictions": [
{
"type": "discounts-per-redemption",
"quantity": 0
}
],
"description": "string",
"issuedTime": "2019-08-24T14:15:22Z",
"expiredTime": "2019-08-24T14:15:22Z"
}'Coupon updated.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
ID of the coupon. This value is also known as the coupon redemption code.
Coupon fixed amount discount.
Description of the coupon. Use this field to provide an invoice discount item description.
If this field is empty, the invoice discount item description uses the related coupon ID, in the following format: Coupon "COUPON-ID".
Date and time when the coupon is issued. This value may also be described as start time of the coupon.
Number of times the coupon data has been modified.
Use the revision number when analyzing webhook data to determine if a change should take precedence over the current representation.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
{ "id": "cpn_0YVCNKF81GD778N4YNVGDJK558", "discount": { "amount": 0.01, "currency": "USD", "type": "fixed", "context": "items" }, "restrictions": [ { … } ], "redemptionsCount": 0, "status": "draft", "description": "string", "issuedTime": "2019-08-24T14:15:22Z", "expiredTime": "2019-08-24T14:15:22Z", "revision": 0, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }
curl -i -X POST \
'https://www.rebilly.com/_mock/docs/dev-docs/api/coupons/{id}/expiration' \
-H 'Content-Type: application/json' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE' \
-d '{
"expiredTime": "2019-08-24T14:15:22Z"
}'Coupon expiration set.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
ID of the coupon. This value is also known as the coupon redemption code.
Coupon fixed amount discount.
Description of the coupon. Use this field to provide an invoice discount item description.
If this field is empty, the invoice discount item description uses the related coupon ID, in the following format: Coupon "COUPON-ID".
Date and time when the coupon is issued. This value may also be described as start time of the coupon.
Number of times the coupon data has been modified.
Use the revision number when analyzing webhook data to determine if a change should take precedence over the current representation.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
{ "id": "cpn_0YVCNKF81GD778N4YNVGDJK558", "discount": { "amount": 0.01, "currency": "USD", "type": "fixed", "context": "items" }, "restrictions": [ { … } ], "redemptionsCount": 0, "status": "draft", "description": "string", "issuedTime": "2019-08-24T14:15:22Z", "expiredTime": "2019-08-24T14:15:22Z", "revision": 0, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }
Coupon redemption webhook request body resource.
Type of webhook event.
{ "couponId": "string", "redemptionId": "string", "customerId": "string", "eventType": "coupon-application-removed", "_embedded": { "coupon": { … }, "redemption": { … }, "customer": { … } }, "_links": [ { … } ] }
Coupon redemption webhook request body resource.
Type of webhook event.
{ "couponId": "string", "redemptionId": "string", "customerId": "string", "eventType": "coupon-application-removed", "_embedded": { "coupon": { … }, "redemption": { … }, "customer": { … } }, "_links": [ { … } ] }
Coupon webhook request body resource.
Type of webhook event.
{ "couponId": "string", "eventType": "coupon-expiration-modified", "_embedded": { "coupon": { … } }, "_links": [ { … } ] }
Coupon webhook request body resource.
Type of webhook event.
{ "couponId": "string", "eventType": "coupon-expiration-modified", "_embedded": { "coupon": { … } }, "_links": [ { … } ] }
Coupon webhook request body resource.
Type of webhook event.
{ "couponId": "string", "eventType": "coupon-expiration-modified", "_embedded": { "coupon": { … } }, "_links": [ { … } ] }
Coupon webhook request body resource.
Type of webhook event.
{ "couponId": "string", "eventType": "coupon-expiration-modified", "_embedded": { "coupon": { … } }, "_links": [ { … } ] }
Coupon redemption webhook request body resource.
Type of webhook event.
{ "couponId": "string", "redemptionId": "string", "customerId": "string", "eventType": "coupon-application-removed", "_embedded": { "coupon": { … }, "redemption": { … }, "customer": { … } }, "_links": [ { … } ] }
Coupon redemption webhook request body resource.
Type of webhook event.
{ "couponId": "string", "redemptionId": "string", "customerId": "string", "eventType": "coupon-application-removed", "_embedded": { "coupon": { … }, "redemption": { … }, "customer": { … } }, "_links": [ { … } ] }
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.