Last updated

These docs are intended for a developer audience.


This section of the docs describes the components of the Rebilly product. In Rebilly, components are called resources. Use this section to understand how Rebilly works and to aid with your integration. This section is for a developer audience.


The following table describes the entity relationships between each resource in Rebilly.

Customer1 to manyPayment instruments
Customer0 to manyTransactions
Payment instrument0 to manyTransactions
Customer0 to manyOrder
Order1 to manyInvoice
Invoicemany to manyTransactions
Customer0 to manyQuotes
Order0 to manyQuotes
Credit memomany to manyInvoice
Credit memomany to manyTransaction
Invoices & orders1 to manyProducts & plans (as "items")
Product1 to manyPlans
Customer1 to manyPlans
Organization1 to manyWebsite

Extend resources

Use custom fields to extend a resource scheme to include a custom field. Include the data within your API requests. Rebilly validates, stores, and returns the data when you retrieve the resource.

Example: To record a customer's preferred communication channel.

  "customFields": {
    "preferredCommunicationChannel": "email"

For more information, select from the following: