Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.

All APIs (latest)

Introduction

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.

Authentication

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.

  • Secret API key: Use to make requests from the server side. Never share these keys. Keep them guarded and secure.
  • Publishable API key: Use in your client-side code to tokenize payment information.
  • JWT: Use to make short-life tokens that expire after a set period of time.

Manage API keys

To create or manage API keys, select one of the following:

For more information on API keys, see API keys.

Errors

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.

SDKs

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.

JavaScript SDK

For installation and usage instructions, see SDKs. All JavaScript SDK code examples are included in the API reference documentation.

PHP SDK

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',
]);

Get started

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.

Rate limits

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.

Download OpenAPI description
Languages
Servers
Mock server
https://www.rebilly.com/_mock/catalog/all/
Sandbox server
https://api-sandbox.rebilly.com/organizations/{organizationId}/
Live server
https://api.rebilly.com/organizations/{organizationId}/

Allowlists

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.

Operations

AML

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.

OperationsWebhooks

API keys

Use API keys to identify and authenticate applications and users. Always keep your API keys private. When creating API keys, you can restrict them to a given set of permissions. For information on how to create and manage API keys, see API keys.

Operations

Application owners

Use these operations to register applications to the Rebilly Apps Store and manage application instances. An application owner is a person or organization that has submitted an app to the Rebilly App Store. For more information, see Submit an app.

OperationsWebhooks

Application users

Use these operations to install or uninstall apps from the Rebilly App Store to your Rebilly account, and to manage application instances. An application user is a person or organization that uses an app that is installed from the Rebilly App Store. For more information, see Install or uninstall an app.

Operations

Retrieve an application instance

Request

Retrieves a list of application instances. You may sort applications by: id, name, status, createdTime, and updatedTime.

Path
applicationIdstring<= 50 characters^[@~\-\.\w]+$required

ID of the application.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/application-instances/{applicationId}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Experience it firsthand in the API Explorer!

Responses

Application instance retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:

332

Pagination-Limitinteger

Maximum number of items per page.

Example:

100

Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:

2

Bodyapplication/json
statusstringread-only

Status of the application instance.

Enum"enabling""enabled""disabling""disabled"
isConfiguredbooleanread-only
settingsobjectDeprecatedread-only

Configuration settings that are available during installation.

Example:

{"color":"red","limit":"5"}

createdTimestring(date-time)(CreatedTime)read-only

Date and time which is set automatically when the resource is created.

updatedTimestring(date-time)(UpdatedTime)read-only

Date and time which updates automatically when the resource is updated.

_linksArray of objects(SelfLink)read-only

Related links.

Response
application/json
{ "status": "enabling", "isConfigured": true, "settings": { "color": "red", "limit": "5" }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ {} ] }

Upsert an application instance

Request

Creates or updates (upserts) an application instance.

Path
applicationIdstring<= 50 characters^[@~\-\.\w]+$required

ID of the application.

Bodyapplication/json
curl -i -X PUT \
  'https://www.rebilly.com/_mock/catalog/all/application-instances/{applicationId}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{}'
Experience it firsthand in the API Explorer!

Responses

Application instance updated.

Headers
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:

3600

X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:

3600

Bodyapplication/json
statusstringread-only

Status of the application instance.

Enum"enabling""enabled""disabling""disabled"
isConfiguredbooleanread-only
settingsobjectDeprecatedread-only

Configuration settings that are available during installation.

Example:

{"color":"red","limit":"5"}

createdTimestring(date-time)(CreatedTime)read-only

Date and time which is set automatically when the resource is created.

updatedTimestring(date-time)(UpdatedTime)read-only

Date and time which updates automatically when the resource is updated.

_linksArray of objects(SelfLink)read-only

Related links.

Response
application/json
{ "status": "enabling", "isConfigured": true, "settings": { "color": "red", "limit": "5" }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ {} ] }

Delete application instance

Request

Deletes an application instance with a specific ID.

Path
applicationIdstring<= 50 characters^[@~\-\.\w]+$required

ID of the application.

curl -i -X DELETE \
  'https://www.rebilly.com/_mock/catalog/all/application-instances/{applicationId}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Experience it firsthand in the API Explorer!

Responses

Application instance deleted.

Response
application/json
{ "status": 401, "type": "http://example.com", "title": "string", "detail": "string", "instance": "string" }

Retrieve an application instance configuration

Request

Retrieves the configuration of an installed application with a specified ID.

Path
applicationIdstring<= 50 characters^[@~\-\.\w]+$required

ID of the application.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/application-instances/{applicationId}/configuration' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Experience it firsthand in the API Explorer!

Responses

Application instance configuration retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:

332

Pagination-Limitinteger

Maximum number of items per page.

Example:

100

Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:

2

Bodyapplication/json
settingsobjectrequired

Configuration settings that are available during installation.

Example:

{"color":"red","level":"gold"}

settings.property name*stringadditional property

Additional properties that the user may want to add when installing an application.

_linksArray of objectsread-only

Related links.

Response
application/json
{ "settings": { "color": "red", "level": "gold" }, "_links": [ {} ] }

Upsert an application instance configuration

Request

Creates or updates (upserts) an application instance configuration.

Path
applicationIdstring<= 50 characters^[@~\-\.\w]+$required

ID of the application.

Bodyapplication/json
settingsobjectrequired

Configuration settings that are available during installation.

Example:

{"color":"red","level":"gold"}

settings.property name*stringadditional property

Additional properties that the user may want to add when installing an application.

curl -i -X PUT \
  'https://www.rebilly.com/_mock/catalog/all/application-instances/{applicationId}/configuration' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "settings": {
      "color": "red",
      "level": "gold"
    }
  }'
Experience it firsthand in the API Explorer!

Responses

Application instance configuration updated.

Headers
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:

3600

X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:

3600

Bodyapplication/json
settingsobjectrequired

Configuration settings that are available during installation.

Example:

{"color":"red","level":"gold"}

settings.property name*stringadditional property

Additional properties that the user may want to add when installing an application.

_linksArray of objectsread-only

Related links.

Response
application/json
{ "settings": { "color": "red", "level": "gold" }, "_links": [ {} ] }

Retrieve applications

Request

Retrieves a list of all applications. You may sort applications by: id, name, status, createdTime, and updatedTime.

Query
limitinteger[ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger[ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filterstring

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.

qstring

Use this field to perform a partial search of text fields.

expandstring

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.

fieldsstring

Limits the returned fields to the specified list, each field separated by a comma. The ID value is always returned.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/applications?expand=string&fields=string&filter=string&limit=1000&offset=1000&q=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Experience it firsthand in the API Explorer!

Responses

List of applications retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:

332

Pagination-Limitinteger

Maximum number of items per page.

Example:

100

Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:

2

Bodyapplication/jsonArray [
idstring<= 50 charactersread-only

ID of the application.

Example:

"app_01H0HT25X7XXCJGS4H8VJSYF2Y"

namestringrequired

Name of the application.

logoIdstring<= 50 charactersrequired

File ID of the application logo.

Example:

"4f6cf35x-2c4y-483z-a0a9-158621f77a21"

authorNamestringrequired

Name of the application author.

authorLogoIdstring or null<= 50 characters

File ID of the author's logo.

Example:

"4f6cf35x-2c4y-483z-a0a9-158621f77a21"

taglinestringrequired

Tagline of the application.

descriptionstringrequired

Detailed application description. This field accepts markdown and simple text.

statusstringread-only

Status of the application.

Enum"pending-approval""available""disabled"
permissionsArray of strings(operationId)required

List of permissions that are available to the application. If you would like to add permissions, contact Rebilly Support.

Items Enum"DeleteApplicationInstance""GetApplicationInstanceConfiguration""GetCustomer""GetCustomerCollection""GetInvoice""GetInvoiceCollection""GetPlan""GetPlanCollection""GetProduct""GetProductCollection"
Example:

["GetInvoice","GetInvoiceCollection","GetCustomer","GetCustomerCollection"]

configurationUrlstring or null(url)

External URL where the application is configured during installation.

configuredBystringread-only

Specifies who can configure the application.

Enum"user""application"
propertiesobject

Defines settings that users can complete when they install the application. This field accepts JSON-schema drafts 4, 6, and 7.

Example:

{"type":"object","properties":{"email":{"type":"string"},"max":{"type":"integer","minimum":0,"exclusiveMaximum":100}},"required":["email"]}

createdTimestring(date-time)(CreatedTime)read-only

Date and time which is set automatically when the resource is created.

updatedTimestring(date-time)(UpdatedTime)read-only

Date and time which updates automatically when the resource is updated.

_linksArray of objectsread-only

Related links.

_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

]
Response
application/json
[ { "id": "app_01H0HT25X7XXCJGS4H8VJSYF2Y", "name": "string", "logoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21", "authorName": "string", "authorLogoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21", "tagline": "string", "description": "string", "status": "pending-approval", "permissions": [], "configurationUrl": "string", "configuredBy": "user", "properties": {}, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [], "_embedded": {} } ]

Retrieve application

Request

Retrieves an application with a specified ID.

Path
idstring<= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/applications/{id}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Experience it firsthand in the API Explorer!

Responses

Applications retrieved.

Headers
Pagination-Totalinteger