You are viewing:

Getting Started

Implementing Chargebee

Product Catalog

Subscriptions

Customers

Entitlements

Invoices, Credit Notes, and Quotes

Taxes

Payments

Hosted Capabilities

Site Configuration

Multi Business Entity

Multi Business Entity Overview
- Limitations and Feature or Integration Support in Multi-Business Entity
- Multi Business Entity Invoices
- Multi Business Entity Taxes
- Multi Business Entity Notifications
- Multi Business Entity for Oracle NetSuite
- Multi Business Entity Reports and Analytics
- Multiple Business Entity Offline Payments
- Multi Business Entity Smart Routing
- Multi Business Entity Transfer Configuration
- Best Practice to Use API Keys for Multi Business Entity
- Frequently Asked Questions
Customer Transfer Overview
- About Resources and Managing Associated Workflow Processes
- Data Management Actions
- Getting Started with Customer Transfer
- Data Management Navigation
- Integration and System Impacts
- Customer Transfer FAQs

Reports and Analytics

Integrations

Data Privacy & Security

Data Operations

Data Management Actions

This article will help you to handle a range of API and User Interface actions involving different resources such as customers, subscriptions, invoices, credit notes, hosted pages, events, and more within the customer transfer workflow.

Managing Actions on Data (Left in the Source Business Entity)

Important:
Customer transfers occur based on the 'sub renewal job' timing. If the transfer happens before the scheduled job time, subscriptions due for renewal on that date will be transferred on the same day. However, if customer transfer occurs after the scheduled job time, the subscription will be transferred to the next billing date.

The following are the different actions possible:

Customer Actions on Source and Destination Entity

Actions	Source Entity Customer resource ~ Transferred	Destination Entity Customer resource ~ Cloned
Create New Subscription	Not Allowed	Allowed
Create Quote	Not Allowed	Allowed
Edit Customer	Not Allowed	Allowed
Request Payment	Not Allowed	Allowed
Request Payment Method	Not Allowed	Allowed
Add Billing Info	Not Allowed	Allowed
Update Billing Info	Not Allowed	Allowed
Add One-Time Charges and Quick Charges	Not Allowed	Allowed
Add Charge	Not Allowed	Allowed
Create Quick Charge	Not Allowed	Allowed
Update Promotional Credits	Not Allowed	Allowed
Record an offline payment	Not Allowed	Allowed
Clear Personal Data	Allowed	Allowed
Delete Customer	Allowed	Allowed
Update (Customer Details)	Not Allowed	Allowed
Add parent account	Not Allowed	Allowed
Add additional contacts	Not Allowed	Allowed
Add Card	Allowed	Allowed
Add customer invoice note	Not Allowed	Allowed
Add Attachment	Allowed	Allowed
Comments	Allowed	Allowed
Change Auto Collection	Not Allowed	Allowed
JSON Metadata - Add	Not Allowed	Allowed
Change Subscription	Not Allowed	Allowed
Merge Customer - API Action Merge Deprecated Customer with Other Customer	Not Allowed	Not Allowed

Subscription Actions on Source Entity

The actions described on this page are intended for subscriptions in the source entity that are continuing for the current term, regardless of their status (e.g., active, future, pause, metered, non-renewing, or cancelled) and which have not been transferred but are still associated with a customer who has been transferred or cloned in the destination entity.

It's important to note that none of the actions detailed on this page are relevant to subscriptions in 'transferred' status.

Transferred status indicates that the subscription & customer have been moved/cloned to another entity. For such subscriptions, no alterations or updates can be made in the source entity.

The following are the column details:

Active: Active subscription will be cloned at the time of renewal in the destination entity, resulting in a new invoice being generated for that term in the destination entity.
Future: Future subscriptions will be cloned at the start of the subscription in the destination entity, resulting in the generation of a new invoice for that term in the destination entity.
Pause: Paused subscription will be cloned in the destination entity at the scheduled resumption date, resulting in the creation of a new invoice for that term in the destination entity.
Metered: Metered subscription will be cloned at the time of renewal in the destination entity, resulting in a new invoice being generated for the previous term in the destination entity.
Non-renewal & cancelled: For non-renewing & cancelled subscriptions, no further actions will be taken. Subscriptions in these statuses will not be cloned in the destination entity, as they are either scheduled for cancellation in the source entity or have already been cancelled, as indicated by their status.

Actions / Status	Active	Future	Pause	Metered	Non Renewal	Cancelled
Edit Subscription	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Create and Send a Quote	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Add One-Time Charges and Quick Charges	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Add Charge	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Create Quick Charge	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Add Coupon	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Request Payment Method	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Bill Future Renewals	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Edit Next Billing Date	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Pause Subscription	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Cancel Subscription	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Delete Subscription	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Auto Collection - Edit	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
JSON Meta Configured -Add	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Add Shipping Address	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Add Card	Allowed	Allowed	Allowed	Allowed	Allowed	Allowed
Add Subscription Invoice Note	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Comments	Allowed	Allowed	Allowed	Allowed	Allowed	Allowed
Add Attachments	Allowed	Allowed	Allowed	Allowed	Allowed	Allowed
Reactivate Subscription	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Regenerate Invoice	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Remove Scheduled Cancellation	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Edit Scheduled Cancellation	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Edit Pause	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Remove Scheduled Pause	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Remove Scheduled Resumption	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Resume Subscription	Allowed	Allowed	Allowed	Allowed	Allowed	Allowed
Cancel Changes ( Scheduled Sub Change)	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Edit Start Date	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Add Manual Discount	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Add Usage	Not Allowed	Not Allowed	Not Allowed	Allowed	Not Allowed	Not Allowed
Delete usage	Not Allowed	Not Allowed	Not Allowed	Allowed	Not Allowed	Not Allowed
View Usage Details	Not Allowed	Not Allowed	Not Allowed	Allowed	Not Allowed	Not Allowed
Edit Invoicing Schedule	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Delete Invoicing Schedule	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
View Schedule ( Advance Invoice)	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
View schedule - Edit ( Advance Invoice)	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed

Invoice Actions on Source Entity

Actions / Invoice Status	Paid	Posted	Payment Due	Not Paid	Voided	Pending
send_email	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
update_address	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
manage_dunning	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
set_expected_payment_date	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
add_charge (add_charge, add_addon_charge)	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
close_pending_invoice	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Allowed
collect_now	Not Allowed	Not Allowed	Allowed	Allowed	Not Allowed	Not Allowed
update_po_number	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
record_payment	Not Allowed	Allowed	Allowed	Not Allowed	Not Allowed	Not Allowed
apply_payment	Not Allowed	Allowed	Allowed	Not Allowed	Not Allowed	Not Allowed
apply_credit	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
refund	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
record_refund	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
create_credit_note	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
write_off	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
void_invoice	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
delete	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
usage_pdf	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Allowed
view_pdf	Allowed	Allowed	Allowed	Allowed	Allowed	Allowed
remove_tax_withheld	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
record_tax_withheld	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
remove_offline payment	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
remove_Promo_Credits	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
remove_adjustment Credit note	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed
remove_applied credits	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed	Not Allowed

Credit Note Actions on Source Entity

Actions / Status	Adjustment	Refund Due	Refunded	Voided
Send Email	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Record an offline refund	Not Allowed	Allowed	Not Allowed	Not Allowed
Issue a refund	Not Allowed	Allowed	Not Allowed	Not Allowed
Void this credit note	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Delete this credit note	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Allocate credits	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Remove - Tax Withheld	Not Allowed	Not Allowed	Not Allowed	Not Allowed
Remove - Allocated Credits	Not Allowed	Not Allowed	Not Allowed	Not Allowed
View_PDF	Allowed	Allowed	Allowed	Allowed

Other API and User Interface Actions on Deprecated Resources

Where the customer and all subscriptions have already been transferred/cloned to the destination entity & all these are deprecated resources in the source entity.

Gift Endpoints

Endpoints	Source Entity
Create a gift subscription for items	Not Allowed
Retrieve a gift	Not Allowed
List gifts	Allowed
Claim a gift	Not Allowed
Cancel a gift	Not Allowed
Update a gift	Not Allowed

Orders Endpoints

Endpoints	Source Entity
Create an order	Not Allowed
Update an order	Not Allowed
Import an order	Not Allowed
Assign order number	Not Allowed
Cancel an order	Not Allowed
Create a refundable credit note	Not Allowed
Reopen a cancelled order	Not Allowed
Retrieve an order	Allowed
Delete an imported order	Not Allowed
List orders	Allowed
Resend an order	Not Allowed

Hosted Pages Endpoints

Endpoint	Source Entity
Checkout charge-items and one-time charges	Not Allowed
Create checkout for a new subscription	Not Allowed
Create checkout to update a subscription	Not Allowed
Update payment method	Allowed
Manage Payment Sources	Allowed
Collect Now	Allowed
Accept a quote	Not Allowed
Notify an event	Not Allowed
Extend Subscription	Not Allowed
Checkout Gift subscription for Items	Not Allowed
Claim a Gift subscription	Not Allowed
Retrieve Direct Debit Agreement PDF	Allowed
Acknowledge a hosted page	Not Yet Decided
Retrieve a hosted page	Not Yet Decided
List hosted pages	Not Yet Decided
Create a pre-cancel hosted page	Not Allowed
Create a hosted page to view Boleto vouchers	Allowed

Portal Sessions Endpoints

Endpoint	Source Entity
Create a portal session	Allowed
Retrieve a portal session	Allowed
Logout a portal session	Allowed
Activate a portal session	Allowed

Transactions Endpoints

Endpoint	Source Entity
Create an authorization payment	Allowed
Void an authorization transaction	Allowed
Retrieve a transaction	Allowed
Delete an offline transaction	Not Allowed
Refund a payment	Not Allowed
List transactions	Allowed
List payments for an invoice	Allowed
Record an offline refund	Not Allowed

Comments Endpoints

Endpoint	Source Entity
Create a comment	Allowed
Retrieve a comment	Allowed
List comments	Allowed
Delete a comment	Allowed

Purchases Endpoints

Endpoint	Source Entity
Create a purchase	Not Allowed
Estimates for purchase	Not Allowed

Events Endpoints

Endpoint	Source Entity
Retrieve an event	Not Allowed
List events	Not Allowed

Exports Endpoints

Endpoint	Source Entity
Export Customers	Allowed
Export Subscriptions	Allowed
Export Invoices	Allowed
Export Credit Notes	Allowed
Export Transactions	Allowed
Export Orders	Allowed

Payments Endpoints

Endpoint	Source Entity
Create customer using gateway temporary token	Allowed
Create using permanent token	Allowed
Create using chargebee toke	Allowed
Create using payment intent	Allowed
Create card payment source	Allowed
Create bank payment source	Allowed
Delete a payment source	Allowed
Local delete a payment source	Allowed
Update bank payment source	Allowed
Verify bank payment source	Allowed
Retrieve payment source	Allowed
List payment source	Allowed
Switch gateway account	Not Allowed
Export payment sources	Allowed
Create voucher payment method	Allowed
Update card payment source	Allowed
Create a payment intent	Allowed
Update payment intent	Allowed
Retrieve payment intent	Allowed
Retrieve card for customer	Deprecated This operation is obsoleted by the Retrieve a payment source API.
Update card for customer	Deprecated The Payment Sources API, with its additional options and improvements, obsoletes the Cards APIs. This operation is obsoleted by the following: Create using temporary token Create using permanent token Create a card payment source
Switch Gateway	Deprecated This request is obsoleted by the Switch gateway account API for Payment Sources.
Copy card	Deprecated The Payment Sources API, with its additional options and improvements, obsoletes the Cards APIs. This request is obsoleted by the Export payment source API.
Delete card for a customer	Deprecated The Payment Sources API, with its additional options and improvements, obsoletes the Cards APIs. This request is obsoleted by the Delete a payment source API.
Create Virtual bank account using permanent token	Allowed
Create virtual bank account	Allowed
Retrieve virtual bank account	Allowed
List virtual bank accounts	Allowed
Delete virtual bank account	Allowed
Local delete virtual bank account	Allowed
List vouchers for customer	Allowed
Retrieve voucher data	Allowed
Create voucher for customer to initiate payment	Allowed
List vouchers for invoice	Allowed

API Changes Allowed or Restricted in Different APIs

Customer API

Operation	Permission
customer_create	Allowed
customer_update	Not Allowed
customer_update_payment_method	Not Allowed
customer_update_billing	Not Allowed
assign_payment_role	Allowed
add_contact	Not Allowed
update_contact	Not Allowed
delete_contact	Not Allowed
add_promotional_credits	Not Allowed
deduct_promotional_credits	Not Allowed
set_promotional_credits	Not Allowed
record_excess_payment	Not Allowed
customer_collect_payment	Not Allowed
delete	Not Allowed
move	Allowed
change_billing_date	Not Allowed
merge_customers	Allowed (partially)
customer_clear_personal_data	Allowed
link_a_customer	Not Allowed
delete_relationship	Not Allowed
update_hierarchy_settings	Not Allowed

Subscription API

Operation	Permission
sub_create_item	Not Allowed
remove_scheduled_changes	Not Allowed
remove_scheduled_cancellation_ep	Not Allowed
remove_coupons	Not Allowed
sub_update_for_items	Not Allowed
change_term_end	Not Allowed
reactivate_subscription	Not Allowed
add_charge_at_term_end	Not Allowed
charge_future_renewals	Not Allowed
edit_advance_invoice_schedule	Not Allowed
remove_advance_invoice_schedule	Not Allowed
regenerate_invoice	Not Allowed
import_contract_term	Not Allowed
import_unbilled_charges	Not Allowed
delete_subscription	Not Allowed
pause	Not Allowed
cancel_for_items	Not Allowed
resume_subscription (Intermediate)	Allowed
resume_subscription (Transferred)	Not Allowed
remove_scheduled_pause	Not Allowed
remove_scheduled_resumption	Not Allowed

Invoice API

Operation	Permission
update_invoice	Not Allowed
record_payment	Allowed
record_refund	Not Allowed
create_for_charge_items_and_charges	Not Allowed
stop_dunning	Not Allowed
import_invoice	Not Allowed
invoice_apply_payments	Allowed
sync_usages	Not Allowed
delete_line_items	Not Allowed
invoice_apply_credits	Not Allowed
add_charge_pending	Not Allowed
add_charge_item	Not Allowed
close_now	Allowed
collect_payment	Allowed
record_tax_withheld	Not Allowed
remove_tax_withheld	Not Allowed
refund_invoice	Not Allowed
remove_payment	Not Allowed
remove_credit_note	Not Allowed
void_invoice	Not Allowed
write_off	Not Allowed
delete_invoice	Not Allowed
resend_einvoice	Not Allowed
send_einvoice	Not Allowed

Credit Note API

Operation	Permission
create_credit_note	Not Allowed
refund	Allowed
import_credit_note	Not Allowed
record_refund	Allowed
void	Not Allowed
delete	Not Allowed
remove_tax_withheld_refund	Not Allowed
resend_einvoice	Not Allowed
send_einvoice	Not Allowed

Quote API

Operation	Permission
update_sub_items_quote	Not Allowed
one_time_charge_items_quote	Not Allowed
create_sub_items_quote	Not Allowed

Promotional Credit API

Operation	Permission
add	Not Allowed
deduct	Not Allowed
set	Not Allowed

Address API

Operation	Permission
address_update	Not Allowed

Usage API

Operation	Permission
create_usage (Intermediate)	Allowed
delete_usage (Intermediate)	Allowed
create_usage (Transferred)	Not Allowed
delete_usage (Transferred)	Not Allowed

Unbilled Charge API

Operation	Permission
unbilled_charges_create_for_items	Not Allowed
invoice_unbilled_charges	Not Allowed
delete	Not Allowed
invoice_now_estimate	Not Allowed

Estimate API

Operation	Permission
estimate_createsub_for_item_with_customer	Allowed
estimate_createsub_for_customer	Not Allowed
estimate_createsub_for_item	Allowed
estimate_updatesub_for_items	Not Allowed
advance_invoice_estimate	Not Allowed
regenerate_invoice_estimate	Not Allowed
upcoming_invoice_for_cmrr	Not Allowed
change_term_end_estimate	Not Allowed
cancel_subscription_for_items_estimate	Not Allowed
pause_subscription_estimate	Not Allowed
resume_subscription_estimate	Allowed
gift_subscription_for_items	Not Allowed
create_invoice_for_items	Not Allowed

Transaction API

Operation	Permission
create_an_authorization_payment	Allowed
cancel_an_authorization_payment	Allowed
sync_transaction (Bulk Operation)	Allowed
record_refund	Not Allowed
refund_transaction	Not Allowed
delete_offline_transaction	Not Allowed

Hosted Page API

Operation	Permission
checkout_one_time	Not Allowed
checkout_one_time_for_items	Not Allowed
checkout_new_for_items	Not Allowed
checkout_existing_for_items	Not Allowed
manage_payments	Allowed
update_payment_method_hp	Allowed
collect_unpaid_invoices	Allowed
accept_quote	Not Allowed
extend_subscription	Not Allowed
checkout_gift_for_items	Not Allowed
claim_gift	Allowed
acknowledge_hosted_page	Allowed
precancel	Not Allowed
events	Allowed
view_voucher	Allowed

Gift API

Operation	Permission
gift_create_for_items	Not Allowed
claim_gift	Allowed

Order API

Operation	Permission
createOrderConfig	Not Allowed
updateOrderConfig	Not Allowed
importOrder	Not Allowed
assignOrderNumberConfig	Not Allowed
cancelOrderConfig	Not Allowed
refundOrderConfig	Not Allowed
reopenOrderConfig	Not Allowed
deleteOrder	Not Allowed
resendOrderConfig	Not Allowed

Portal API

Operation	Permission
portal_session_create	Allowed
logout	Allowed
activate	Allowed

Payment Source API

Operation	Permission
switch_gateway_account	Not Allowed

Credit Card API

Operation	Permission
switchGatewayForCustomer	Not Allowed
copyCardForCustomer	Not Allowed
deleteCardForCustomer	Allowed

Managing Actions on Data (After the Transfer to the Destination Business Entity)

After a customer is transferred to the destination business entity, along with all existing subscriptions based on their renewal dates, they will follow the standard process, with all activities occurring within the destination business entity.

Was this article helpful?

Getting Started

Implementing Chargebee

Product Catalog

Subscriptions

Customers

Entitlements

Invoices, Credit Notes, and Quotes

Taxes

Payments

Hosted Capabilities

Site Configuration

Multi Business Entity

Reports and Analytics

Integrations

Data Privacy & Security

Data Operations

Data Management Actions

Managing Actions on Data (Left in the Source Business Entity)

Customer Actions on Source and Destination Entity

Subscription Actions on Source Entity

Invoice Actions on Source Entity

Credit Note Actions on Source Entity

Other API and User Interface Actions on Deprecated Resources

Gift Endpoints

Orders Endpoints

Hosted Pages Endpoints

Portal Sessions Endpoints

Transactions Endpoints

Comments Endpoints

Purchases Endpoints

Events Endpoints

Exports Endpoints

Payments Endpoints

Deprecated

Deprecated

Deprecated

Deprecated

Deprecated

API Changes Allowed or Restricted in Different APIs

Customer API

Subscription API

Invoice API

Credit Note API

Quote API

Promotional Credit API

Address API

Usage API

Unbilled Charge API

Estimate API

Transaction API

Hosted Page API

Gift API

Order API

Portal API

Payment Source API

Credit Card API

Managing Actions on Data (After the Transfer to the Destination Business Entity)

In this page