ChargebeeAPI

Business entities

The business_entity resource represents a business unit or brand under your organization. Key resources in Chargebee Billing (such as customer, subscriptions, invoices, and transactions) along with the associated site configurations, fall under a business entity. Each Chargebee Billing site has one business entity by default. You may create multiple business entities in the following scenarios:

  • Multiple Business Units: You may be running your business under different regional units with different "invoice-from" addresses. This is usually done to manage taxation and bookkeeping. In such a case, you may create a business entity for each business unit.
  • Multiple Brands: You may have multiple brands within your business, such as those acquired via mergers and acquisitions. You may create a business entity for each brand.

Creating multiple business entities lets you separate configuration and data for your business units or brands so that you can manage their billing and revenue operations independently.

See also

More information on business entities and the configuration options available.

Sample Business entityJSON

Business entities attributes

id
required, string, max chars=50

A unique and immutable identifier for the business entity. It is always autogenerated.

name
required, string, max chars=100

A human-friendly name for the business entity.

status
required, enumerated string

Current status of the business entity.

Possible Enum Values
active

The business entity is active and can be used.

inactive

The business entity is inactive and cannot be used.

deleted
required, boolean, default=false

Indicates that the business entity has been deleted.

created_at
required, timestamp(UTC) in seconds

Timestamp when this business entity was created.

resource_version
optional, long

Version number of this resource. The resource_version is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.

updated_at
optional, timestamp(UTC) in seconds

The time period when the business entity was updated.