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.
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.
Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.
Specifies the starting point within the collection of items to be returned.
curl -i -X GET \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/plans?filter=string&limit=1000&offset=1000&q=string&sort=string' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
List of plans retrieved.
Details of the one-time sale plan. Use this plan for non-recurring, one-time, sales.
Name of the plan. This name is displayed on invoices and receipts.
Plain-text description of the plan. This field accepts plain-text only.
Rich-text description of the plan. This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks.
ID of the related product.
Name-value pairs that specify the product options.
Fixed-fee pricing details. Use this formula for subscriptions that involve the same price, number of units, and reoccur over a fixed period of time.
For more information, see Fixed-fee per period.
Price formula that determines which algorithm is used to calculate the invoice price based on the following factors:
Quantity in the order. This value may be variable if you are charging based on usage. If you are not charging based on usage, this value is determined when an order is created.
Price of the quantity range. Some formulas set a price based on defined product quantity ranges.
For more information, see Price formulas.
Use this formula to charge for subscriptions that have a fixed price, number of units, and reoccur over a fixed period of time, such as every: day, week, month, year, or number of years.
For example, a streaming company charges customers $13.99 each month for subscription period that is 6 months in duration. The quantity of movies that a customer streams each month does not impact the price.
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.
Number of times the plan is modified. Compare this value with materialized subscription item revision values.
Specifies if a plan is a trial that does not have recurring instructions.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
[ { "id": "plan_0YV7DENSVGDBW9S71XZNNYYQ0X", "name": "string", "description": "string", "richDescription": "string", "productId": "prod_0YV7DES3WPC5J8JD8QTVNZBZNZ", "productOptions": { … }, "currency": "USD", "currencySign": "string", "pricing": { … }, "setup": { … }, "customFields": { … }, "isActive": true, "revision": 0, "isTrialOnly": true, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ … ] } ]
Plan resource.
Details of the one-time sale plan. Use this plan for non-recurring, one-time, sales.
Name of the plan. This name is displayed on invoices and receipts.
Plain-text description of the plan. This field accepts plain-text only.
Rich-text description of the plan. This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks.
ID of the related product.
Name-value pairs that specify the product options.
Fixed-fee pricing details. Use this formula for subscriptions that involve the same price, number of units, and reoccur over a fixed period of time.
For more information, see Fixed-fee per period.
Price formula that determines which algorithm is used to calculate the invoice price based on the following factors:
Quantity in the order. This value may be variable if you are charging based on usage. If you are not charging based on usage, this value is determined when an order is created.
Price of the quantity range. Some formulas set a price based on defined product quantity ranges.
For more information, see Price formulas.
Use this formula to charge for subscriptions that have a fixed price, number of units, and reoccur over a fixed period of time, such as every: day, week, month, year, or number of years.
For example, a streaming company charges customers $13.99 each month for subscription period that is 6 months in duration. The quantity of movies that a customer streams each month does not impact the price.
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.
curl -i -X POST \ https://www.rebilly.com/_mock/docs/dev-docs/api/plans \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "name": "string", "description": "string", "richDescription": "string", "productId": "prod_0YV7DES3WPC5J8JD8QTVNZBZNZ", "productOptions": { "color": "red", "size": "xxl" }, "currency": "USD", "pricing": { "formula": "fixed-fee", "price": 99.95 }, "setup": { "price": 0.1 }, "customFields": { "foo": "bar" }, "isActive": true }'
Plan created.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
Details of the one-time sale plan. Use this plan for non-recurring, one-time, sales.
Name of the plan. This name is displayed on invoices and receipts.
Plain-text description of the plan. This field accepts plain-text only.
Rich-text description of the plan. This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks.
ID of the related product.
Name-value pairs that specify the product options.
Fixed-fee pricing details. Use this formula for subscriptions that involve the same price, number of units, and reoccur over a fixed period of time.
For more information, see Fixed-fee per period.
Price formula that determines which algorithm is used to calculate the invoice price based on the following factors:
Quantity in the order. This value may be variable if you are charging based on usage. If you are not charging based on usage, this value is determined when an order is created.
Price of the quantity range. Some formulas set a price based on defined product quantity ranges.
For more information, see Price formulas.
Use this formula to charge for subscriptions that have a fixed price, number of units, and reoccur over a fixed period of time, such as every: day, week, month, year, or number of years.
For example, a streaming company charges customers $13.99 each month for subscription period that is 6 months in duration. The quantity of movies that a customer streams each month does not impact the price.
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.
Number of times the plan is modified. Compare this value with materialized subscription item revision values.
Specifies if a plan is a trial that does not have recurring instructions.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
{ "name": "string", "description": "string", "richDescription": "string", "productId": "prod_0YV7DES3WPC5J8JD8QTVNZBZNZ", "productOptions": { "color": "red", "size": "xxl" }, "currency": "USD", "currencySign": "string", "pricing": { "formula": "fixed-fee", "price": 99.95 }, "setup": { "price": 0.1 }, "customFields": { "foo": "bar" }, "isActive": true, "revision": 0, "isTrialOnly": true, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ], "id": "plan_0YV7DENSVGDBW9S71XZNNYYQ0X" }