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.
The following table describes the entity relationships between each resource in Rebilly.
| Resource | Relationship | Resource |
|---|---|---|
| Customer | 1 to many | Payment instruments |
| Customer | 0 to many | Transactions |
| Payment instrument | 0 to many | Transactions |
| Customer | 0 to many | Order |
| Order | 1 to many | Invoice |
| Invoice | many to many | Transactions |
| Customer | 0 to many | Quotes |
| Order | 0 to many | Quotes |
| Credit memo | many to many | Invoice |
| Credit memo | many to many | Transaction |
| Invoices & orders | 1 to many | Products & plans (as "items") |
| Product | 1 to many | Plans |
| Customer | 1 to many | Plans |
| Organization | 1 to many | Website |
Use custom fields to extend a resource schema. 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:
- Use the API to create or manage custom fields — see Custom fields.
- Use the UI to create custom fields — see Add a custom field.