Settings
API Version
Product Catalog
Library

Business entity transfers

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

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 GET

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

Model Class

 

      Business entity transfer attributes
      
 
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
 
 
customerRepresents the transfer of a customerresource.subscriptionRepresents the transfer of a subscriptionsresource linked to a customerresource.
 
 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
 
 
correctionCorrection 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. 
 
 
 
Event types
 

      This is a list of the event types we currently support. We will continue
      to add more events moving forward. All events follow a uniform pattern -
      <resource>_<event_name>. The resources that will be
      present in the event content are provided beneath each event type's
      description.
    
 
Note: If consolidated invoicing is enabled, the
      attributes invoice.subscription_id and
      credit_note.subscription_id should not be used
      (as it will not be present if the invoice / credit note has lines from
      multiple subscriptions). Instead to know the related subscriptions,
      their line_items' subscription_id attribute should be referred.
    
 
 
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
 
 
customerRepresents the transfer of a customerresource.subscriptionRepresents the transfer of a subscriptionsresource linked to a customerresource.
 
 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
 
 
correctionCorrection 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. 
 
 
 
Consent Fields for Business entity transfer
 
 
Custom Fields for Business entity transfer