{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"3"},"outline":{"value":"false"},"style":{"value":"default"},"type":{"value":"list"},"printable":{"value":"false"}},"macroMetadata":{"macroId":{"value":"e9298e41-aa43-4ec2-aae7-c8c0d05d562b"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"d1aeeab2-8272-41b9-a72a-8c615c584d35"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"business_entity","type":"text","marks":[{"type":"code"}]},{"text":" Resource","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Early Access","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Multiple Business Entities is in early access.","type":"text"}]},{"type":"paragraph","content":[{"text":"Terms and conditions ","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.chargebee.com/company/terms/?__hstc=181257784.ee289255622b25f89875918fa726e9b1.1705999846570.1708673197900.1708676934461.17&__hssc=181257784.1.1708676934461&__hsfp=1169139113#your_rights"}}]},{"text":" ","type":"text"},{"text":"Request access","type":"text","marks":[{"type":"link","attrs":{"href":"https://chargebee.typeform.com/to/bIsKhNt5"}}]}]}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"business_entity","type":"text","marks":[{"type":"code"}]},{"text":" resource represents a business unit or brand under your organization. Key resources in Chargebee Billing (such as ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"subscriptions","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"invoices","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"transactions","type":"text","marks":[{"type":"code"}]},{"text":") along with the associated site configurations, fall under a business entity. Each Chargebee Billing ","type":"text"},{"text":"site","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.chargebee.com/docs/2.0/sites-intro.html"}}]},{"text":" has one business entity by default. You may create multiple business entities in the following scenarios: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Multiple Business Units","type":"text","marks":[{"type":"strong"}]},{"text":": 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.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Multiple Brands","type":"text","marks":[{"type":"strong"}]},{"text":": 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.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"See also","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"More information","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.chargebee.com/docs/2.0/mbe.html"}}]},{"text":" on business entities and the configuration options available.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Specifying business entity in API operations","type":"text"}]},{"type":"paragraph","content":[{"text":"All API operations in Chargebee have site ","type":"text"},{"text":"context","type":"text","marks":[{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466190369/business+entity+Resource#Context-of-an-operation"}}]},{"text":". The \"context\" of an API operation is the subset of site data it has access to. An API operation can only read or write data within its context. By default, an API operation has \"site context\", which means it has access to the entire ","type":"text"},{"text":"site","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.chargebee.com/docs/2.0/sites-intro.html"}}]},{"text":"'s data. If your site has multiple business entities, you can specify the business entity ","type":"text"},{"text":"context","type":"text","marks":[{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466190369/business+entity+Resource#Context-of-an-operation"}}]},{"text":" for an API call by passing a ","type":"text"},{"text":"custom HTTP request header","type":"text","marks":[{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/advanced-features#mbe-header-main"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"API behavior based on business entity specified","type":"text"}]},{"type":"paragraph","content":[{"text":"The table below explains how Chargebee responds to various API calls depending on whether the business entity ID is specified as part of the API call.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Note","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Some of the terminology used here is defined in the ","type":"text"},{"text":"next section","type":"text","marks":[{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466190369/business+entity+Resource#Terminology"}}]},{"text":".","type":"text"}]}]},{"type":"table","attrs":{"layout":"default","isNumberColumnEnabled":true,"width":1619.0,"localId":"144b550d-7c9d-471c-b1d9-af80ae69d23f"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Operation/Type of operation","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[741.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Behavior","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[652.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Examples","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.0]},"content":[{"type":"paragraph","content":[{"text":"Any operation that creates a ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[741.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"business_entity_id","type":"text","marks":[{"type":"code"}]},{"text":" is provided","type":"text","marks":[{"type":"strong"}]},{"text":", the ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource is created and linked to it.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"business_entity_id","type":"text","marks":[{"type":"code"}]},{"text":" is not provided","type":"text","marks":[{"type":"strong"}]},{"text":", the ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource is created under the ","type":"text"},{"text":"default","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466190369/business+entity+Resource#Default-business-entity"}}]},{"text":" business entity","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://api-static-site-dynamic.predev18.in/docs/api#mbe-default-be"}}]},{"text":" of the site.","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[652.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a customer","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/customers?prod_cat_ver=2#create_a_customer"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When ","type":"text"},{"text":"Create a checkout for charge items and quick charge","type":"text","marks":[{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=2#checkout_charge-items_and_one-time_charges"}}]},{"text":"s or ","type":"text"},{"text":"Create checkout for a new subscription","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=2#create_checkout_for_a_new_subscription"}}]},{"text":" is called, providing a value for ","type":"text"},{"text":"customer[id]","type":"text","marks":[{"type":"code"}]},{"text":" that is not already present in the site. This creates a new ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.0]},"content":[{"type":"paragraph","content":[{"text":"Create a resource other than ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[741.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"business_entity_id","type":"text","marks":[{"type":"code"}]},{"text":" is provided","type":"text","marks":[{"type":"strong"}]},{"text":", and it is the same as that ","type":"text"},{"text":"linked","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466190369/business+entity+Resource#Linked-business-entity"}}]},{"text":" to the ","type":"text"},{"text":"target resource","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466190369/business+entity+Resource#Target-resource"}}]},{"text":": the resource is created and linked to the business entity provided.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"business_entity_id","type":"text","marks":[{"type":"code"}]},{"text":" is provided","type":"text","marks":[{"type":"strong"}]},{"text":", and it is not the same as that linked to the target resource, a ","type":"text"},{"text":"404 Not Found","type":"text","marks":[{"type":"code"}]},{"text":" response is sent because the resource cannot be found in the ","type":"text"},{"text":"context","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466190369/business+entity+Resource#Context-of-an-operation"}}]},{"text":" of the business entity specified.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"business_entity_id","type":"text","marks":[{"type":"code"}]},{"text":" is not provided","type":"text","marks":[{"type":"strong"}]},{"text":", the resource is created and linked to the business entity of the target resource.","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[652.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a subscription","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/subscriptions?prod_cat_ver=2#create_subscription_for_items"}}]},{"text":": the target resource is a ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a comment","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/comments?prod_cat_ver=2#create_a_comment"}}]},{"text":": the target resource is specified in the value provided for ","type":"text"},{"text":"entity_type","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create an invoice for items and one-time charges","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/invoices?prod_cat_ver=2#create_invoice_for_items_and_one-time_charges"}}]},{"text":": depending on the ID specified, the target resource is either a ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" or a ","type":"text"},{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.0]},"content":[{"type":"paragraph","content":[{"text":"Update/delete a resource","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[741.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"business_entity_id","type":"text","marks":[{"type":"code"}]},{"text":" is provided","type":"text","marks":[{"type":"strong"}]},{"text":", and it is the same as that ","type":"text"},{"text":"linked","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466190369/business+entity+Resource#Linked-business-entity"}}]},{"text":" to the","type":"text"},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":"resource, the operation proceeds successfully.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"business_entity_id","type":"text","marks":[{"type":"code"}]},{"text":" is provided","type":"text","marks":[{"type":"strong"}]},{"text":", and it is not the same as that ","type":"text"},{"text":"linked","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466190369/business+entity+Resource#Linked-business-entity"}}]},{"text":" to the resource, a ","type":"text"},{"text":"404 Not Found","type":"text","marks":[{"type":"code"}]},{"text":" response is sent because the resource cannot be found in the ","type":"text"},{"text":"context","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466190369/business+entity+Resource#Context-of-an-operation"}}]},{"text":" of the business entity specified.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"business_entity_id","type":"text","marks":[{"type":"code"}]},{"text":" is not provided","type":"text","marks":[{"type":"strong"}]},{"text":", the operation proceeds successfully.","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[652.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Update a customer","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/customers?prod_cat_ver=2#update_a_customer"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Update a subscription","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/subscriptions?prod_cat_ver=2#update_subscription_for_items"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Update a card payment source","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/payment_sources?prod_cat_ver=2#update_a_card_payment_source"}}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.0]},"content":[{"type":"paragraph","content":[{"text":"List resources","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[741.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"business_entity_id","type":"text","marks":[{"type":"code"}]},{"text":" is provided,","type":"text","marks":[{"type":"strong"}]},{"text":" then only those resources linked to the business entity are returned since the ","type":"text"},{"text":"context","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466190369/business+entity+Resource#Context-of-an-operation"}}]},{"text":" of the operation is now restricted to the business entity specified.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"business_entity_id","type":"text","marks":[{"type":"code"}]},{"text":" is not provided","type":"text","marks":[{"type":"strong"}]},{"text":",","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"then all resources in the site are returned.","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[652.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"List customers","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/customers?prod_cat_ver=2#list_customers"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"List payment sources","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/payment_sources?prod_cat_ver=2#list_payment_sources"}}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.0]},"content":[{"type":"paragraph","content":[{"text":"Retrieve a resource","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[741.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"business_entity_id","type":"text","marks":[{"type":"code"}]},{"text":" is provided","type":"text","marks":[{"type":"strong"}]},{"text":", and it is the same as that ","type":"text"},{"text":"linked","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466190369/business+entity+Resource#Linked-business-entity"}}]},{"text":" to the","type":"text"},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":"resource, the resource is retrieved successfully.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"business_entity_id","type":"text","marks":[{"type":"code"}]},{"text":" is provided","type":"text","marks":[{"type":"strong"}]},{"text":", and it is not the same as that ","type":"text"},{"text":"linked","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466190369/business+entity+Resource#Linked-business-entity"}}]},{"text":" to the resource, a ","type":"text"},{"text":"404 Not Found","type":"text","marks":[{"type":"code"}]},{"text":" response is sent because the resource cannot be found in the ","type":"text"},{"text":"context","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466190369/business+entity+Resource#Context-of-an-operation"}}]},{"text":" of the business entity specified.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"business_entity_id","type":"text","marks":[{"type":"code"}]},{"text":" is not provided","type":"text","marks":[{"type":"strong"}]},{"text":", the resource is retrieved successfully.","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[652.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Retrieve a customer","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/customers?prod_cat_ver=2#retrieve_a_customer"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Retrieve a comment","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/comments?prod_cat_ver=2#retrieve_a_comment"}}]}]}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Terminology","type":"text"}]},{"type":"paragraph","content":[{"text":"This section defines some useful terms for describing how business entities work.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Linked business entity","type":"text"}]},{"type":"paragraph","content":[{"text":"Any resource is always associated with precisely one and only one business entity. We call it the linked business entity of the resource, or simply, the business entity of the resource.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Default business entity","type":"text"}]},{"type":"paragraph","content":[{"text":"When ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource is created and no business entity is specified, it is linked to the business entity designated as the default business entity of the site. A site always has a default business entity. At first, it is the same as the first business entity of the site and can be changed once more business entities are created. ","type":"text"},{"text":"Contact Support","type":"text","marks":[{"type":"link","attrs":{"href":"https://support.chargebee.com/support/home"}}]},{"text":" to change the default business entity.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Context of an operation","type":"text"}]},{"type":"paragraph","content":[{"text":"Any site has data in it. This includes all the various resources such as customers, subscriptions, invoices, comments, and so on. The \"context\" of an API operation is the subset of site data it has access to. An API operation can only read or write data within its context. By default, an API operation has \"site context\", which means it has access to the entire site's data. However, when a business entity is ","type":"text"},{"text":"specified","type":"text","marks":[{"type":"link","attrs":{"href":"https://api-static-site-dynamic.predev18.in/7988334676/docs/api/advanced-features?lang=curl#mbe-header-main"}}]},{"text":" in an API operation, it has \"business entity context\", which means that the operation only has access to the data linked to the business entity.","type":"text"}]},{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"paragraph","content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Consider the ","type":"text"},{"text":"List customers API","type":"text","marks":[{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/customers?prod_cat_ver=2#list_customers"}}]},{"text":". When you call the API without specifying a business entity, its context is that of the site and therefore returns customer resources for the entire site. However, when you specify a business entity, the context is only that of the business entity, and therefore the customer resources of only the selected business entity are returned.","type":"text"}]},{"type":"paragraph","content":[{"text":"Let's look at the ","type":"text"},{"text":"Create checkout for a new subscription API","type":"text","marks":[{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=2#create_checkout_for_a_new_subscription"}}]},{"text":". Say you're calling this API and providing the ","type":"text"},{"text":"customer[id]","type":"text","marks":[{"type":"code"}]},{"text":" parameter. When no business entity is specified, the operation has ","type":"text"},{"text":"site context","type":"text","marks":[{"type":"em"}]},{"text":" and therefore looks up the ID among all the customer resources in the site. However, when a business entity is provided, the operation has ","type":"text"},{"text":"business entity context","type":"text","marks":[{"type":"em"}]},{"text":" and looks up the ID only among the customers linked to that business entity.","type":"text"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Target resource","type":"text"}]},{"type":"paragraph","content":[{"text":"While creating an API resource other than a ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":", you specify a target resource under which it should be created. For example:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"While ","type":"text"},{"text":"creating an ","type":"text","marks":[{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/invoices?prod_cat_ver=2#create_invoice_for_items_and_one-time_charges"}}]},{"text":"invoice","type":"text","marks":[{"type":"code"}]},{"text":" resource for a one-time charge, you must specify either the ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" or the ","type":"text"},{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":" resource to which it belongs. The ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":" resource, in this case, is the target resource of the ","type":"text"},{"text":"invoice","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"While ","type":"text"},{"text":"creating a ","type":"text","marks":[{"type":"link","attrs":{"href":"https://api-static-site-dynamic.predev18.in/docs/api/subscriptions?prod_cat_ver=2#create_subscription_for_items"}}]},{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":", the target resource of a ","type":"text"},{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":" resource is always a ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"While ","type":"text"},{"text":"creating a ","type":"text","marks":[{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/quotes?prod_cat_ver=2#create_a_quote_for_update_subscription_items"}}]},{"text":"quote","type":"text","marks":[{"type":"code"}]},{"text":" resource of ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"change_subscription","type":"text","marks":[{"type":"code"}]},{"text":", the target resource is a ","type":"text"},{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":" resource.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Sample ","type":"text"},{"text":"business_entity","type":"text","marks":[{"type":"code"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"id\": \"1\",\n \"name\": \"1\",\n \"status\": \"active\",\n \"deleted\": false,\n \"created_at\": 1709892529,\n \"updated_at\": 1709892626,\n \"resource_version\": 1709892626000,\n \"object\": \"business_entity\"\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Attributes","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","isNumberColumnEnabled":true,"width":1450.0,"localId":"76097ba2-fa9a-44a6-8f63-7e6ede5731c7"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"VAR(--DS-BACKGROUND-ACCENT-GRAY-SUBTLEST, #F4F5F7)","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"VAR(--DS-BACKGROUND-ACCENT-GRAY-SUBTLEST, #F4F5F7)","rowspan":1,"colwidth":[1223.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1223.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"purple","style":"bold","text":"STRING","localId":"e9cfb517-3d25-481b-b1f5-bbcea5c4245c"}},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"neutral","style":"bold","text":"MAX CHARS = 50","localId":"813dd2da-43d8-45e5-b4c5-660fae91c006"}}]},{"type":"paragraph","content":[{"text":"A unique and immutable identifier for the business entity. It is always autogenerated.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1223.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"purple","style":"bold","text":"STRING","localId":"ca05e472-8c00-473a-9abe-c3ac4ea991f9"}},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"neutral","style":"bold","text":"MAX CHARS = 50","localId":"2a35c450-e098-49d4-b1f5-5ecc3dbe2af3"}}]},{"type":"paragraph","content":[{"text":"A human-friendly name for the business entity.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"status","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1223.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"purple","style":"bold","text":"ENUM","localId":"2d917a9e-42e8-412a-b567-acdec6fd9922"}}]},{"type":"paragraph","content":[{"text":"The status of business entity. Possible values:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"active","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"The business entity is active and can be used.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"inactive","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"he business entity is inactive and cannot be used.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"resource_version","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1223.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"purple","style":"bold","text":"LONG","localId":"d9b86ddd-aa16-4431-8e0d-edaac121d15a"}}]},{"type":"paragraph","content":[{"text":"Version number of this resource. The ","type":"text"},{"text":"resource_version","type":"text","marks":[{"type":"code"}]},{"text":" 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.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"deleted","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1223.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"purple","style":"bold","text":"BOOLEAN","localId":"381f179c-98d5-4345-95b0-8abac364f381"}},{"text":" ","type":"text"},{"text":"default=false","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Indicates that the business entity has been deleted.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"created_at","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1223.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"purple","style":"bold","text":"UNIX TIME","localId":"46bb0f21-b55f-4bfe-ad32-c6534a034600"}}]},{"type":"paragraph","content":[{"text":"Timestamp for when this business entity was created.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"updated_at","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1223.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"purple","style":"bold","text":"UNIX TIME","localId":"5fe3ca1f-3370-491a-9b31-dac8554de996"}}]},{"type":"paragraph","content":[{"text":"The time period when the business entity was updated.","type":"text"}]}]}]}]},{"type":"rule"},{"type":"rule"},{"type":"heading","attrs":{"level":1},"content":[{"text":"Endpoints","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Transfer a customer to another business entity","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /business_entity/transfers","type":"text"}]},{"type":"paragraph","content":[{"text":"Transfers one or more ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resources from one business entity to another.","type":"text"}]},{"type":"paragraph","content":[{"text":"The transfer is executed by creating a copy of the ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource. The original resource is called the ","type":"text"},{"text":"deprecated","type":"text","marks":[{"type":"strong"}]},{"text":" resource, while the new copy is called the ","type":"text"},{"text":"current","type":"text","marks":[{"type":"strong"}]},{"text":" resource.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Prerequisites","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Transfers must always be initiated for a current ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resources and never for a deprecated resources.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource cannot be transferred more than three times in a single calendar year. For example, if already moved thrice in the year 2023, a ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource can only be moved again in 2024.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource must ","type":"text"},{"text":"not","type":"text","marks":[{"type":"strong"}]},{"text":" have any of the following:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"an account hierarchy ","type":"text"},{"text":"relationship","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":" resource with","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"status","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"in_trial","type":"text","marks":[{"type":"code"}]},{"text":" or","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"advance invoice schedules. (","type":"text"},{"text":"subscription.has_scheduled_advance_invoices","type":"text","marks":[{"type":"code"}]},{"text":" as ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":".)","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"invoice","type":"text","marks":[{"type":"code"}]},{"text":" resource with ","type":"text"},{"text":"status","type":"text","marks":[{"type":"code"}]},{"text":" as ","type":"text"},{"text":"pending","type":"text","marks":[{"type":"code"}]},{"text":". (","type":"text"},{"text":"Close pending invoices","type":"text","marks":[{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/invoices?lang=curl#close_a_pending_invoice"}}]},{"text":" before invoking this API.)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"invoice","type":"text","marks":[{"type":"code"}]},{"text":" resources that are advance invoices. (","type":"text"},{"text":"invoice.has_advance_charges","type":"text","marks":[{"type":"code"}]},{"text":" as ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":".) ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"quote","type":"text","marks":[{"type":"code"}]},{"text":" resources with ","type":"text"},{"text":"status","type":"text","marks":[{"type":"code"}]},{"text":" as ","type":"text"},{"text":"open","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"accepted","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"transaction","type":"text","marks":[{"type":"code"}]},{"text":" resource with:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"status","type":"text","marks":[{"type":"code"}]},{"text":" as ","type":"text"},{"text":"in_progress","type":"text","marks":[{"type":"code"}]},{"text":" or","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"status","type":"text","marks":[{"type":"code"}]},{"text":" as ","type":"text"},{"text":"success","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" as ","type":"text"},{"text":"authorization","type":"text","marks":[{"type":"code"}]},{"text":", and a non-zero ","type":"text"},{"text":"amount_capturable","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Non-zero ","type":"text"},{"text":"unbilled_charges","type":"text","marks":[{"type":"code"}]},{"text":". (","type":"text"},{"text":"Invoice unbilled charges","type":"text","marks":[{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/unbilled_charges?lang=curl#create_an_invoice_for_unbilled_charges"}}]},{"text":" before invoking this API.)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Non-zero ","type":"text"},{"text":"refundable_credits","type":"text","marks":[{"type":"code"}]},{"text":". (","type":"text"},{"text":"Apply credits","type":"text","marks":[{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/invoicesl#apply_credits_for_an_invoice"}}]},{"text":" to unpaid invoices before invoking this API.)","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource must not be a ","type":"text"},{"text":"gifter","type":"text","marks":[{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/gifts#gift_gifter"}}]},{"text":" of a gift subscription with ","type":"text"},{"text":"status","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"scheduled","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"unclaimed","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Mechanics of business entity transfer","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"paragraph","content":[{"text":"When calling this endpoint, the current and deprecated resources are processed as follows:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For the current resource:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"active_id","type":"text","marks":[{"type":"code"}]},{"text":" are set to match the deprecated resource's ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"business_entity_id","type":"text","marks":[{"type":"code"}]},{"text":" is set to ","type":"text"},{"text":"destination_business_entity_id","type":"text","marks":[{"type":"code"}]},{"text":" parameter.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For the deprecated resource:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":" resources, the value of ","type":"text"},{"text":"active_id","type":"text","marks":[{"type":"code"}]},{"text":" is set to match the resource ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The value of ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" is changed to a new random value.","type":"text"}]}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Considerations for business entity transfer","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When this API is endpoint is called, Chargebee blocks concurrent calls to incompatible ","type":"text"},{"text":"POST","type":"text","marks":[{"type":"code"}]},{"text":" operations.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When a resource is transferred more than once, each transfer deprecates the previous current resource and creates a new current resource.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"payment_source","type":"text","marks":[{"type":"code"}]},{"text":" resources linked to the ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" are immediately transferred to the destination business entity.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":" resources linked to the ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" are transferred automatically to the destination business entity as follows:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"active","type":"text","marks":[{"type":"code"}]},{"text":" subscription resources are transferred on their next renewal. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"paused","type":"text","marks":[{"type":"code"}]},{"text":" subscription resources are transferred when resumed.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"future","type":"text","marks":[{"type":"code"}]},{"text":" subscription resources are transferred on their ","type":"text"},{"text":"start_date","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"non_renewing","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"cancelled","type":"text","marks":[{"type":"code"}]},{"text":" subscription resources are not transferred and remain linked to the deprecated customer resource.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Other resources linked to the customer, such as ","type":"text"},{"text":"invoice","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"quote","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"credit_note","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"transaction","type":"text","marks":[{"type":"code"}]},{"text":", remain linked to the deprecated customer resource.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Deprecated ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":" resources are not returned in list APIs such as ","type":"text"},{"text":"List customers","type":"text","marks":[{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/customers?lang=curl#list_customers"}}]},{"text":" or ","type":"text"},{"text":"List subscriptions","type":"text","marks":[{"type":"link","attrs":{"href":"https://apidocs.chargebee.com/docs/api/subscriptions?lang=curl#list_subscriptions"}}]},{"text":".","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"See also","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Permitted operations","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.chargebee.com/docs/2.0/mbe-data-management-actions.html"}}]},{"text":" on deprecated and current resources.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Additional considerations for business entity transfer","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.chargebee.com/docs/2.0/mbe-about-resources-and-managing-associated-workflow-processes.html"}}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"paragraph","content":[{"text":"The following example illustrates the transfer of a ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource from a business entity (source) to another (destination). The example also shows how ","type":"text"},{"text":"payment_source","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"invoice","type":"text","marks":[{"type":"code"}]},{"text":" resources attached to the ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource are affected.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"1. Initial state before the transfer","type":"text"}]},{"type":"paragraph","content":[{"text":"Imagine a ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource with the ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"Ab6dRFt","type":"text","marks":[{"type":"code"}]},{"text":" belonging to the business entity ","type":"text"},{"text":"acme-us","type":"text","marks":[{"type":"code"}]},{"text":". This customer has a linked ","type":"text"},{"text":"payment_source","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":", and an ","type":"text"},{"text":"invoice","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":768,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":2958,"alt":"image-20240325-111819.png","id":"a5715b58-cae6-404c-ba47-51b17b7af72f","collection":"contentId-466190369","type":"file","height":1351}}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"2. Invoking the API endpoint","type":"text"}]},{"type":"paragraph","content":[{"text":"To transfer the ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource to a new business entity ","type":"text"},{"text":"acme-eu","type":"text","marks":[{"type":"code"}]},{"text":", you would call the endpoint as follows:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"curl https://{site}.chargebee.com/api/v2/business_entities/transfers \\\n -u {api_key}:\\\n -d active_resource_ids[0]=\"Ab6dRFt\" \\\n -d destination_business_entity_ids[0]=\"acme-us\" \\\n -d reason_code[0]=\"correction\"","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource is deprecated in favor of a new ","type":"text"},{"text":"current","type":"text","marks":[{"type":"em"}]},{"text":" ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource. The ","type":"text"},{"text":"payment_source","type":"text","marks":[{"type":"code"}]},{"text":" resource is also deprecated and a new ","type":"text"},{"text":"current","type":"text","marks":[{"type":"em"}]},{"text":" ","type":"text"},{"text":"payment_source","type":"text","marks":[{"type":"code"}]},{"text":" resource is created and linked to the new ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource. The ","type":"text"},{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"invoice","type":"text","marks":[{"type":"code"}]},{"text":" resources remain linked to the deprecated ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":604,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":2120,"alt":"image-20240325-111839.png","id":"e2c163df-7649-40f7-beba-adde65c2066c","collection":"contentId-466190369","type":"file","height":1886}}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"3. Transfer of linked ","type":"text"},{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":" resources","type":"text"}]},{"type":"paragraph","content":[{"text":"When the ","type":"text"},{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":" renews, it automatically transfers to the business entity of the current ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource. This process mirrors the transfer of the ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource, resulting in a new current ","type":"text"},{"text":"subscription","type":"text","marks":[{"type":"code"}]},{"text":" resource linked to the current ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource and the business entity ","type":"text"},{"text":"acme-eu","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":716,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":2116,"alt":"image-20240325-111904.png","id":"29ee6bb1-a41a-44a2-a46a-0ffb42a2971a","collection":"contentId-466190369","type":"file","height":1889}}]},{"type":"paragraph"},{"type":"paragraph"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Sample request","type":"text"}]},{"type":"expand","attrs":{"title":"curl"},"content":[{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"curl https://{site}.chargebee.com/api/v2/business_entities/transfers \\\n -u {site_api_key}:\\\n -d active_resource_ids=\"Customer-1,Customer-2\" \\\n -d destination_business_entity_ids=\"Entity-2,Entity-2\" \\\n -d reason_codes=\"Correction,Correction\"","type":"text"}]}]},{"type":"expand","attrs":{"title":"PHP"},"content":[{"type":"codeBlock","attrs":{"language":"php"},"content":[{"text":"require_once('vendor/autoload.php');\n\nuse ChargeBee\\ChargeBee\\Environment;\nuse ChargeBee\\ChargeBee\\Models\\BusinessEntity;\n\nEnvironment::configure(\"{site}\",\"{site_api_key}\");\n$result = BusinessEntity::createTransfers(array(\n \"activeResourceIds\" => array(\"Customer-1,Customer-2\"),\n \"destinationBusinessEntityIds\" => array(\"Entity-2,Entity-2\"),\n \"reasonCodes\" => array(\"Correction,Correction\")\n ));\n$businessEntityTransfer = $result->businessEntityTransfer();\n","type":"text"}]}]},{"type":"expand","attrs":{"title":"Ruby"},"content":[{"type":"codeBlock","attrs":{"language":"ruby"},"content":[{"text":"require 'chargebee'\nChargeBee.configure(:site => \"{site}\",\n :api_key => \"{site_api_key}\")\nresult = ChargeBee::BusinessEntity.create_transfers({\n :active_resource_ids => [\"Customer-1,Customer-2\"],\n :destination_business_entity_ids => [\"Entity-2,Entity-2\"],\n :reason_codes => [\"Correction,Correction\"]\n })\nbusiness_entity_transfer = result.business_entity_transfer\n","type":"text"}]}]},{"type":"expand","attrs":{"title":"Python"},"content":[{"type":"codeBlock","attrs":{"language":"python"},"content":[{"text":"import chargebee\nimport json\nchargebee.configure(\"{site_api_key}\",\"{site}\")\nresult = chargebee.BusinessEntity.create_transfers({\n \"active_resource_ids\" : [\"Customer-1,Customer-2\"],\n \"destination_business_entity_ids\" : [\"Entity-2,Entity-2\"],\n \"reason_codes\" : [\"Correction,Correction\"]\n })\nbusiness_entity_transfer = result.business_entity_transfer\n","type":"text"}]}]},{"type":"expand","attrs":{"title":"Java"},"content":[{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"import java.io.IOException;\nimport com.chargebee.*;\nimport com.chargebee.models.*;\nimport com.chargebee.models.enums.*;\n\npublic class Sample{\n\n public static void main(String args[]) throws IOException{\n \nEnvironment.configure(\"{site}\",\"{site_api_key}\");\nResult result = BusinessEntity.createTransfers()\n\t.activeResourceIds(\"Customer-1,Customer-2\")\n\t.destinationBusinessEntityIds(\"Entity-2,Entity-2\")\n\t.reasonCodes(\"Correction,Correction\")\n\t.request();\nBusinessEntityTransfer businessEntityTransfer = result.businessEntityTransfer();\n\n System.out.println(result);\n }\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":".NET"},"content":[{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"using ChargeBee.Api;\nusing ChargeBee.Models;\nApiConfig.Configure(\"{site}\",\"{site_api_key}\");\nEntityResult result = BusinessEntity.CreateTransfers()\n\t\t.ActiveResourceIds(new List(new String[] {\"Customer-1,Customer-2\"}))\n\t\t.DestinationBusinessEntityIds(new List(new String[] {\"Entity-2,Entity-2\"}))\n\t\t.ReasonCodes(new List(new String[] {\"Correction,Correction\"}))\n\t\t.Request();\n\nBusinessEntityTransfer businessEntityTransfer = result.BusinessEntityTransfer;\n","type":"text"}]}]},{"type":"expand","attrs":{"title":"Node"},"content":[{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"var chargebee = require(\"chargebee\");\nchargebee.configure({site : \"{site}\",\n api_key : \"{site_api_key}\"})\nchargebee.business_entity.create_transfers({\n active_resource_ids : \"Customer-1,Customer-2\",\n destination_business_entity_ids : \"Entity-2,Entity-2\",\n reason_codes : \"Correction,Correction\"\n}).request(function(error,result) {\n if(error){\n //handle error\n console.log(error);\n }else{\n console.log(result);\n var business_entity_transfer = result.business_entity_transfer;\n }\n});\n","type":"text"}]}]},{"type":"expand","attrs":{"title":"Go"},"content":[{"type":"codeBlock","attrs":{"language":"go"},"content":[{"text":"package main\nimport (\n \"fmt\"\n \"github.com/chargebee/chargebee-go/v3\"\n businessEntityAction \"github.com/chargebee/chargebee-go/v3/actions/businessEntity\"\n \"github.com/chargebee/chargebee-go/v3/models/businessEntity\"\n)\nfunc main() {\n chargebee.Configure(\"{site_api_key}\",\"{site}\");\n res,err := businessEntityAction.CreateTransfers(&businessEntity.CreateTransfersRequestParams {\n ActiveResourceIds : []string{\"Customer-1,Customer-2\"},\n DestinationBusinessEntityIds : []string{\"Entity-2,Entity-2\"},\n ReasonCodes : []string{\"Correction,Correction\"},\n }).Request()\n if err != nil {\n fmt.Println(err)\n }else{\n BusinessEntityTransfer := res.BusinessEntityTransfer\n }\n }\n","type":"text"}]}]},{"type":"expand","attrs":{"title":"TypeScript"},"content":[{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"import {\n ChargeBee,\n _business_entity\n} from 'chargebee-typescript';\n\nvar chargebee = new ChargeBee();\n\nchargebee.configure({site : \"{site}\",\n api_key : \"{site_api_key}\"});\nchargebee.business_entity.create_transfers({\n active_resource_ids : [\"Customer-1,Customer-2\"],\n destination_business_entity_ids : [\"Entity-2,Entity-2\"],\n reason_codes : [\"Correction,Correction\"]\n}).request(function(error,result) {\n if(error){\n //handle error\n console.log(error);\n }else{\n console.log(`${result}`);\n var business_entity_transfer: typeof chargebee.business_entity_transfer = result.business_entity_transfer;\n }\n});\n","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Sample response","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"list\": [\n {\n \"business_entity_transfer\": {\n \"id\": \"__dev__263BEVU6h5FoKt\",\n \"resource_type\": \"customer\",\n \"reason_code\": \"Correction\",\n \"created_at\": 1608209339,\n \"object\": \"business_entity_transfer\",\n \"destination_business_entity_id\": \"Entity-2\",\n \"source_business_entity_id\": \"Entity-1\",\n \"resource_id\": \"__dev__263BEVU6h5FlTn\",\n \"active_resource_id\": \"__dev__263BEVU6h5DnYj\"\n }\n },\n {\n \"business_entity_transfer\": {\n \"id\": \"__dev__263BEVU6h5GoKt\",\n \"resource_type\": \"customer\",\n \"reason_code\": \"Correction\",\n \"created_at\": 1608209339,\n \"object\": \"business_entity_transfer\",\n \"destination_business_entity_id\": \"Entity-2\",\n \"source_business_entity_id\": \"Entity-1\",\n \"resource_id\": \"__dev__263BEVU6h5FlPn\",\n \"active_resource_id\": \"__dev__263BEVU6h5DnZj\"\n }\n }\n ]\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Input Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","isNumberColumnEnabled":true,"width":1450.0,"localId":"53e1a833-0319-4359-b2e8-3485268c3d2f"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"VAR(--DS-BACKGROUND-ACCENT-GRAY-SUBTLEST, #F4F5F7)","rowspan":1,"colwidth":[341.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"VAR(--DS-BACKGROUND-ACCENT-GRAY-SUBTLEST, #F4F5F7)","rowspan":1,"colwidth":[1107.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[341.0]},"content":[{"type":"paragraph","content":[{"text":"active_resource_ids[0..n]","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1107.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"required","localId":"5582cac6-1c53-4352-9e09-092e7dc31130"}},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"purple","style":"bold","text":"list of string","localId":"83aabf88-0637-4b48-96e7-039b42ce734c"}},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"The list of unique identifiers of the ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resources to be transferred. Each ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" must belong to a current ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource. ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Note","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"If a ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource was deprecated because it was moved previously, you cannot move it again. Instead, move the current version of the resource. Do this by passing the ","type":"text"},{"text":"active_id","type":"text","marks":[{"type":"code"}]},{"text":" of the deprecated resource.","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[341.0]},"content":[{"type":"paragraph","content":[{"text":"destination_business_entity_ids[0..n]","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1107.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"required","localId":"f6e423a2-0b58-42ee-935b-22848290d638"}},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"purple","style":"bold","text":"list of string","localId":"02b3e188-ff31-44ff-b43b-1c9e5805cbe0"}},{"type":"hardBreak"},{"text":"The list of unique identifiers of the ","type":"text"},{"text":"business_entity","type":"text","marks":[{"type":"code"}]},{"text":" resources to which the corresponding ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resource must be transferred.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[341.0]},"content":[{"type":"paragraph","content":[{"text":"reason_codes[0..n]","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1107.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"required","localId":"f9feb9d3-49ff-4852-b925-cf24eb364e02"}},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"purple","style":"bold","text":"list of string","localId":"5a000957-a95c-4bb2-adfa-bcf15e743386"}},{"type":"hardBreak"},{"text":"The list of reasons for changing the business entity of the corresponding ","type":"text"},{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":" resources.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Returns","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1450.0,"localId":"8595f77a-45a1-48b1-9688-186c4ffaf35a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"VAR(--DS-BACKGROUND-ACCENT-GRAY-SUBTLEST, #F4F5F7)","rowspan":1,"colwidth":[252.0]},"content":[{"type":"paragraph","content":[{"text":"Attribute","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"VAR(--DS-BACKGROUND-ACCENT-GRAY-SUBTLEST, #F4F5F7)","rowspan":1,"colwidth":[1196.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[252.0]},"content":[{"type":"paragraph","content":[{"text":"business_entity_transfer","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1196.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"blue","style":"bold","text":"always returned","localId":"89007335-b905-4f7d-a9fe-0d61eaee8558"}},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"Resource object representing ","type":"text"},{"text":"business_entity_transfer","type":"text","marks":[{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466223232/business+entity+transfer+Resource"}}]},{"text":".","type":"text"}]}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"List business entity transfers","type":"text"}]},{"type":"codeBlock","content":[{"text":"GET /business_entities/transfers","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a list of ","type":"text"},{"text":"business_entity_transfer","type":"text","marks":[{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466223232/business+entity+transfer+Resource"}}]},{"text":" resources meeting ","type":"text"},{"text":"all","type":"text","marks":[{"type":"strong"}]},{"text":" the conditions specified in the filter parameters below. By default, this list is sorted by ","type":"text"},{"text":"created_at","type":"text","marks":[{"type":"code"}]},{"text":" in descending order (latest first).","type":"text"}]},{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"paragraph","content":[{"text":"Tip","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"To retrieve a history of all the business entity transfers for a resource, pass the filter parameters ","type":"text"},{"text":"active_resource_id[is]","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"resource_type[]","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Sample request","type":"text"}]},{"type":"expand","attrs":{"title":"curl"},"content":[{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"curl https://{site}.chargebee.com/api/v2/business_entities/transfers \\\n -G \\\n -u {site_api_key}:\\\n --data-urlencode resource_type=\"customer\" \\\n --data-urlencode active_resource_id=\"Customer-1\"","type":"text"}]}]},{"type":"expand","attrs":{"title":"PHP"},"content":[{"type":"codeBlock","attrs":{"language":"php"},"content":[{"text":"require_once('vendor/autoload.php');\n\nuse ChargeBee\\ChargeBee\\Environment;\nuse ChargeBee\\ChargeBee\\Models\\BusinessEntity;\n\nEnvironment::configure(\"{site}\",\"{site_api_key}\");\n$all = BusinessEntity::all(array(\n \"resourceType\" => \"customer\",\n \"activeResourceId\" => \"Customer-1\"\n ));\nforeach($all as $entry){\n $businessEntityTransfer = $entry->businessEntityTransfer();\n}\n","type":"text"}]}]},{"type":"expand","attrs":{"title":"Ruby"},"content":[{"type":"codeBlock","attrs":{"language":"ruby"},"content":[{"text":"require 'chargebee'\nChargeBee.configure(:site => \"{site}\",\n :api_key => \"{site_api_key}\")\nlist = ChargeBee::BusinessEntity.get_transfers({\n :resource_type => \"customer\",\n :active_resource_id => \"Customer-1\"\n })\nlist.each do |entry|\n business_entity_transfer = entry.business_entity_transfer\nend\n","type":"text"}]}]},{"type":"expand","attrs":{"title":"Python"},"content":[{"type":"codeBlock","attrs":{"language":"python"},"content":[{"text":"import chargebee\nimport json\nchargebee.configure(\"{site_api_key}\",\"{site}\")\nentries = chargebee.BusinessEntity.get_transfers({\n \"resource_type\" : \"customer\",\n \"active_resource_id\" : \"Customer-1\"\n })\nfor entry in entries:\n business_entity_transfer = entry.business_entity_transfer\n","type":"text"}]}]},{"type":"expand","attrs":{"title":"Java"},"content":[{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"import java.io.IOException;\nimport com.chargebee.*;\nimport com.chargebee.models.*;\nimport com.chargebee.models.enums.*;\n\npublic class Sample{\n\n public static void main(String args[]) throws IOException{\n\n \nEnvironment.configure(\"{site}\",\"{site_api_key}\");\nListResult result = BusinessEntity.getTransfers()\n\t.resourceType(\"customer\")\n\t.activeResourceId(\"Customer-1\")\n\t.request();\nfor(ListResult.Entry entry:result) {\n\tBusinessEntityTransfer businessEntityTransfer = entry.businessEntityTransfer();\n}\n\n\n System.out.println(result);\n }\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":".NET"},"content":[{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"using ChargeBee.Api;\nusing ChargeBee.Models;\nApiConfig.Configure(\"{site}\",\"{site_api_key}\");\nListResult result = BusinessEntity.GetTransfers()\n\t\t.ResourceType(\"customer\")\n\t\t.ActiveResourceId(\"Customer-1\")\n\t\t.Request();\n\nforeach (var item in result.List){\n BusinessEntityTransfer businessEntityTransfer = item.BusinessEntityTransfer;\n}\n","type":"text"}]}]},{"type":"expand","attrs":{"title":"Node"},"content":[{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"var chargebee = require(\"chargebee\");\nchargebee.configure({site : \"{site}\",\n api_key : \"{site_api_key}\"})\nchargebee.business_entity.get_transfers({\n resource_type : \"customer\",\n active_resource_id : \"Customer-1\"\n}).request(function(error,result) {\n if(error){\n //handle error\n console.log(error);\n }else{\n for(var i = 0; i < result.list.length;i++){\n var entry=result.list[i]\n console.log(entry);\n var business_entity_transfer = entry.business_entity_transfer;\n }\n }\n });\n","type":"text"}]}]},{"type":"expand","attrs":{"title":"Go"},"content":[{"type":"codeBlock","attrs":{"language":"go"},"content":[{"text":"package main\nimport (\n \"fmt\"\n \"github.com/chargebee/chargebee-go/v3\"\n \"github.com/chargebee/chargebee-go/v3/filter\"\n businessEntityAction \"github.com/chargebee/chargebee-go/v3/actions/businessEntity\"\n \"github.com/chargebee/chargebee-go/v3/models/businessEntity\"\n)\nfunc main() {\n chargebee.Configure(\"{site_api_key}\",\"{site}\");\n res,err := businessEntityAction.GetTransfers(&businessEntity.GetTransfersRequestParams {\n ResourceType : \"customer\",\n ActiveResourceId : \"Customer-1\",\n }).ListRequest()\n if err != nil {\n fmt.Println(err)\n }else{\n for idx := 0; idx < len(res.List); idx++ {\n BusinessEntityTransfer := res.List[idx].BusinessEntityTransfer\n }\n }\n }\n","type":"text"}]}]},{"type":"expand","attrs":{"title":"TypeScript"},"content":[{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"import {\n ChargeBee,\n _business_entity\n} from 'chargebee-typescript';\n\nvar chargebee = new ChargeBee();\n\nchargebee.configure({site : \"{site}\",\n api_key : \"{site_api_key}\"});\nchargebee.business_entity.get_transfers({\n resource_type : \"customer\",\n active_resource_id : \"Customer-1\"\n}).request(function(error,result) {\n if(error){\n //handle error\n console.log(error);\n }else{\n for(var i = 0; i < result.list.length;i++){\n var entry=result.list[i]\n console.log(`${entry}`);\n var business_entity_transfer: typeof chargebee.business_entity_transfer = entry.business_entity_transfer;\n }\n }\n });\n","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Sample response","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"list\": [\n {\n \"business_entity_transfer\": {\n \"id\": \"__dev__263BEVU6h5FoKu\",\n \"resource_type\": \"customer\",\n \"reason_code\": \"Correction\",\n \"created_at\": 1608209939,\n \"object\": \"business_entity_transfer\",\n \"destination_business_entity_id\": \"Entity-4\",\n \"source_business_entity_id\": \"Entity-3\",\n \"resource_id\": \"__dev__263BEVU6h5FlTp\",\n \"active_resource_id\": \"__dev__263BEVU6h5DnYj\"\n }\n },\n {\n \"business_entity_transfer\": {\n \"id\": \"__dev__263BEVU6h5FoKu\",\n \"resource_type\": \"customer\",\n \"reason_code\": \"Correction\",\n \"created_at\": 1608209639,\n \"object\": \"business_entity_transfer\",\n \"destination_business_entity_id\": \"Entity-3\",\n \"source_business_entity_id\": \"Entity-2\",\n \"resource_id\": \"__dev__263BEVU6h5FlTo\",\n \"active_resource_id\": \"__dev__263BEVU6h5DnYj\"\n }\n },\n {\n \"business_entity_transfer\": {\n \"id\": \"__dev__263BEVU6h5FoKt\",\n \"resource_type\": \"customer\",\n \"reason_code\": \"Correction\",\n \"created_at\": 1608209339,\n \"object\": \"business_entity_transfer\",\n \"destination_business_entity_id\": \"Entity-2\",\n \"source_business_entity_id\": \"Entity-1\",\n \"resource_id\": \"__dev__263BEVU6h5FlTn\",\n \"active_resource_id\": \"__dev__263BEVU6h5DnYj\"\n }\n }\n ]\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Input parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","isNumberColumnEnabled":true,"width":1450.0,"localId":"cc680eae-7d8a-411d-9f2e-23fcb8d3d4b0"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"sort_by[]","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"purple","style":"bold","text":"string filter","localId":"b6fc5228-3a35-4143-95fc-a4e832dd2da0"}},{"type":"hardBreak"},{"text":"Sorts based on the specified attribute. ","type":"text"},{"type":"hardBreak"},{"text":"Supported attributes :","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"created_at","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"Supported sort-orders :","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"asc","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"desc","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Example →","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"sort_by[asc] = \"created_at\"","type":"text","marks":[{"type":"code"}]},{"text":" (This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"limit","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"purple","style":"bold","text":"integer","localId":"21ac145c-629e-4b2b-bc49-2941f3801943"}},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"blue","style":"bold","text":"default = 10","localId":"e5c6b62f-7f86-4d93-afcb-45ca4ea15e9e"}},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"neutral","style":"bold","text":"min =1","localId":"64c72c7d-3bfa-49c5-84ed-b36eeb2e9e56"}},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"neutral","style":"bold","text":"max=100","localId":"172b25d0-a151-4c59-b25b-12da083714d1"}},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"The number of resources to be returned.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"offset","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"purple","style":"bold","text":"string","localId":"5db3d8a4-5da3-4ed6-be80-9913b7692b27"}},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"neutral","style":"bold","text":"maxchars=1000","localId":"894ddcb8-f895-43e9-9af2-f4f5360362db"}},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set ","type":"text"},{"text":"offset","type":"text","marks":[{"type":"code"}]},{"text":" to the value of ","type":"text"},{"text":"next_offset","type":"text","marks":[{"type":"code"}]},{"text":" obtained in the previous iteration of the API call.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Filter parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","isNumberColumnEnabled":true,"width":1658.0,"localId":"be131ba2-46d7-4be7-836c-4d855c470f28"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"resource_type[]","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"purple","style":"bold","text":"string filter","localId":"ed6eb13b-0843-41c5-bc11-e6f2945d6c51"}},{"type":"hardBreak"},{"text":"Filter ","type":"text"},{"text":"business_entity_transfer","type":"text","marks":[{"type":"code"}]},{"text":" resources based on ","type":"text"},{"text":"resource_type","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"paragraph","content":[{"text":"Tip","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Use this filter along with ","type":"text"},{"text":"active_resource_id[]","type":"text","marks":[{"type":"code"}]},{"text":" to retrieve the history of all the business entity transfers for a resource.","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Supported operators :","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"is","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"resource_type[is] = \"customer\"","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"resource_id[]","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"purple","style":"bold","text":"string filter","localId":"baca716c-a30f-418a-8d60-47fdfc7f9944"}},{"type":"hardBreak"},{"text":"Filter ","type":"text"},{"text":"business_entity_transfer","type":"text","marks":[{"type":"code"}]},{"text":" resources based on ","type":"text"},{"text":"resource_id","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Supported operators :","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"is","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"resource_id[is] = \"9bsvnHgsvmsI\"","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"active_resource_id[]","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"purple","style":"bold","text":"string filter","localId":"f3f391d1-6cac-4d12-a306-6eff2b1a5aa6"}}]},{"type":"paragraph","content":[{"text":"Filter ","type":"text"},{"text":"business_entity_transfer","type":"text","marks":[{"type":"code"}]},{"text":" resources based on ","type":"text"},{"text":"active_resource_id","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"paragraph","content":[{"text":"Tip","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Use this filter along with ","type":"text"},{"text":"resource_type[]","type":"text","marks":[{"type":"code"}]},{"text":" to retrieve the history of all the business entity transfers for a resource.","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Supported operators :","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"is","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"active_resource_id[is] = \"8gsnbYfsMLds\"","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"created_at[]","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"purple","style":"bold","text":"unix time in seconds filter","localId":"f97985c4-f520-439c-a38c-7527cb72c57f"}},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"Filter ","type":"text"},{"text":"business_entity_transfer","type":"text","marks":[{"type":"code"}]},{"text":" resources based on ","type":"text"},{"text":"created_at","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"},{"type":"hardBreak"},{"text":"Supported operators :","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"after","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"before","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"on","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"between","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Example →","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"created_at[after] = \"1702022464\"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Returns","type":"text"}]},{"type":"table","attrs":{"layout":"default","isNumberColumnEnabled":true,"width":1450.0,"localId":"af276272-cc64-4284-9554-8e18ad8aa44e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"VAR(--DS-BACKGROUND-ACCENT-GRAY-SUBTLEST, #F4F5F7)","rowspan":1,"colwidth":[266.0]},"content":[{"type":"paragraph","content":[{"text":"Attribute","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"VAR(--DS-BACKGROUND-ACCENT-GRAY-SUBTLEST, #F4F5F7)","rowspan":1,"colwidth":[1142.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[266.0]},"content":[{"type":"paragraph","content":[{"text":"business_entity_transfer","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1142.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"blue","style":"bold","text":"always returned","localId":"3522af78-e0ef-440f-845d-94357323e959"}},{"type":"hardBreak"},{"text":"Resource object representing ","type":"text"},{"text":"business_entity_transfer","type":"text","marks":[{"type":"link","attrs":{"href":"https://chargebee.atlassian.net/wiki/spaces/PCV/pages/466223232/business+entity+transfer+Resource"}}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[266.0]},"content":[{"type":"paragraph","content":[{"text":"next_offset","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1142.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"purple","style":"bold","text":"string","localId":"74f8526b-f902-45e2-8f01-f301d020aa93"}},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"neutral","style":"bold","text":"max chars=1000","localId":"d6c4256a-913b-401b-90ea-c5dfc988ed61"}},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"This attribute is returned only if more resources are present. To fetch the next set of resources use this value","type":"text"},{"type":"hardBreak"},{"text":"for the input parameter ","type":"text"},{"text":"offset","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}],"version":1}

Browser not supported