API Version
Product Catalog
Library

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

Sample business entity transfer [ JSON ]

{ "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" }

API Index URL

https://{site}.chargebee.com/api/v2/business_entity_transfers

Model Class

id
string, max chars=50

Unique identifier of the business_entity_transfer. Chargebee automatically generates this.


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 subscriptions resource linked to a customer resource.

Show all values[+]
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 .


active_resource_id
string, max chars=50

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


destination_business_entity_id
string, max chars=50

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


source_business_entity_id
string, max chars=50

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


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.

Show all values[+]
created_at
timestamp(UTC) in seconds

Timestamp indicating when this business entity transfer record was created.


id id
string, max chars=50

Unique identifier of the business_entity_transfer. Chargebee automatically generates this.


resource_type 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 subscriptions resource linked to a customer resource.

Show all values[+]
resource_id 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 .


active_resource_id active_resource_id
string, max chars=50

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


destination_business_entity_id destination_business_entity_id
string, max chars=50

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


source_business_entity_id source_business_entity_id
string, max chars=50

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


reason_code 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.

Show all values[+]
created_at created_at
timestamp(UTC) in seconds

Timestamp indicating when this business entity transfer record was created.