Multiple Business Entities - API Change Summary
Overview
This document summarizes the changes made to the Chargebee Billing APIs as part of the Business Entities feature.
business_entity
resource
business_entity
endpoints
Transfer a customer to another business entity
List business entity transfers
business_entity_transfer
resource
business_entity_transfer Resource
customer
resource
Attributes
Name | Description |
---|---|
| string max chars = 50 The unique identifier of the Note: When the |
| string max chars = 50 Note: Present only when the Represents the |
| string max chars = 50 always returned The unique ID of the business entity of this customer. |
customer
endpoints
create_a_customer
Parameter added
Name | Description |
---|---|
| string max chars = 50 optional The unique ID of the business entity this customer should be linked to. Applicable only when multiple business entities have been created for the site. When not provided, the customer is linked to the default business entity defined for the site. |
merge_customers
Description updated
This API moves a customer's payment methods, subscriptions, invoices, credit notes, transactions, unbilled charges, and orders to another customer. Events and email logs will not be moved. The API execution is asynchronous.
link_a_customer
Description updated
Sets a customer into a hierarchical relationship with another. The path parameter customer_id
is the id of the child in the relationship.
Note:
For the
use_default_hierarchy_settings
,parent_account_access
andchild_account_access
parameters, the 'parent' is the customer whose id is payment_owner_id. However, if thepayment_owner_id
is the child itself, then the parent is parent_id.The parent and the child customers must belong to the same business entity.
subscription
resource
Attributes
Name | Description |
---|---|
| The unique identifier of the |
| Represents the |
| string max chars = 50 always returned The unique ID of the business entity of this subscription. This is always the same as the business entity of the customer. |
subscription
endpoints
create_subscription_for_items
Parameter added
Name | Description |
---|---|
| string max chars = 50 optional The unique ID of the business entity this subscription should be linked to. Applicable only when multiple business entities have been created for the site. This must be the same as the business entity of the |
invoice
resource
Attribute added
Name | Description |
---|---|
| string max chars = 50 always returned The unique ID of the business entity of this invoice. Depending on whether the invoice was created directly for a customer or for a subscription, this is the business entity of the customer or the subscription respectively. |
invoice
endpoints
create_invoice_for_items_and_one-time_charges
Parameter descriptions updated
Name | Description |
---|---|
| string max chars = 50 optional Unique ID of the customer this invoice should be created for. Either this or |
| string max chars = 50 optional Unique ID of the subscription this invoice should be created for. Either this or |
credit_note
resource
Attribute added
Name | Description |
---|---|
| string max chars = 50 always returned The unique ID of the business entity of this |
payment_intent
resource
Attribute added
Name | Description |
---|---|
| string max chars = 50 always returned The unique ID of the business entity of this |
payment_intent
endpoints
create_a_payment_intent
Description updated
Creates a PaymentIntent object. This is to be used with Chargebee.js API to complete the 3DS flow for new or stored cards.
While creating, specify the appropriate gateway account and amount. The exact amount can be estimated using our Estimate API.
Customer resource lookup and creation
When customer[id]
is provided for this operation, it is looked up by Chargebee, and if found, the payment_intent
is created for it. If not found, a new customer resource is created with the ID provided, and the payment_intent
is created.
Multiple business entities
If multiple business entities are created for the site, the customer resource lookup and creation happen within the context of the business entity specified in this API call. If no business entity is specified, the customer resource lookup is performed within the site context, and if not found, the resource is created for the default business entity of the site.
New parameter added
Name | Description |
---|---|
| string max chars = 50 optional Sets the context for this operation to the business entity specified. Applicable only when multiple business entities have been created for the site. When this parameter is provided, the operation is able to read/write data associated only to the business entity specified. When not provided, the operation can read/write data for the entire site. |