business_entity_transfer Resource

Owned by John M
Last updated: Mar 26, 2024
1 min read

Early Access

Multiple Business Entities is in early access.

Terms and conditions         Request access

business_entity_transfer encapsulates the details of the movement of a resource (such as customer and subscription) from one business_entity to another.

Related API Endpoints

Sample business_entity_transfer

{ "id": "__dev__263BEVU6h5FkGm", "resource_type": "customer", "reason_code": "correction", "created_at": 1710140499, "object": "business_entity_transfer", "destination_business_entity_id": "2", "source_business_entity_id": "1", "resource_id": "__dev__263BEVU6h5FlTn", "active_resource_id": "__dev__263BEVU6h5DnYj" }

Attributes

1

id string max chars = 50

Unique identifier of the business_entity_transfer. Chargebee automatically generates this.

2

destination_business_entity_id string max chars = 50

The unique identifier of the business_entity to which the resource has been transferred.

3

source_business_entity_id string max chars = 50

The unique identifier of the business_entity from which the resource has been transferred.

4

reason_code enumerated string

The reason for transferring the resource to another business entity.

Possible values are

  • correction: Correction of a wrongly assigned business entity.

5

resource_type enumerated string

The type of the resource that was transferred.

Possible values are

  • customer: Represents the transfer of a customer resource.

  • subscription: Represents the transfer of a subscription resource linked to a customer.

6

created_at unix time in seconds

Timestamp indicating the last modification date and time of this business entity change record.

7

resource_id string max chars = 50

The id of the deprecated version of the resource. This is the resource linked to the source business_entity.

8

active_resource_id string max chars = 50

The id of the current version of the resource. This is the resource linked to the destination business_entity.