Docs

Log in to read the version of docs relevant to your site, or use the dropdown versions

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

ActionsSource Entity Customer resource ~ TransferredDestination Entity Customer resource ~ Cloned
Create New SubscriptionNot AllowedAllowed
Create QuoteNot AllowedAllowed
Edit CustomerNot AllowedAllowed
Request PaymentNot AllowedAllowed
Request Payment MethodNot AllowedAllowed
Add Billing InfoNot AllowedAllowed
Update Billing InfoNot AllowedAllowed
Add One-Time Charges and Quick ChargesNot AllowedAllowed
Add ChargeNot AllowedAllowed
Create Quick ChargeNot AllowedAllowed
Update Promotional CreditsNot AllowedAllowed
Record an offline paymentNot AllowedAllowed
Clear Personal DataAllowedAllowed
Delete CustomerAllowedAllowed
Update (Customer Details)Not AllowedAllowed
Add parent accountNot AllowedAllowed
Add additional contactsNot AllowedAllowed
Add CardAllowedAllowed
Add customer invoice noteNot AllowedAllowed
Add AttachmentAllowedAllowed
CommentsAllowedAllowed
Change Auto CollectionNot AllowedAllowed
JSON Metadata - AddNot AllowedAllowed
Change SubscriptionNot AllowedAllowed
Merge Customer - API Action Merge Deprecated Customer with Other CustomerNot AllowedNot 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 / StatusActiveFuturePauseMeteredNon RenewalCancelled
Edit SubscriptionNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Create and Send a QuoteNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Add One-Time Charges and Quick ChargesNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Add ChargeNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Create Quick ChargeNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Add CouponNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Request Payment MethodNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Bill Future RenewalsNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Edit Next Billing DateNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Pause SubscriptionNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Cancel SubscriptionNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Delete SubscriptionNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Auto Collection - EditNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
JSON Meta Configured -AddNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Add Shipping AddressNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Add CardAllowedAllowedAllowedAllowedAllowedAllowed
Add Subscription Invoice NoteNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
CommentsAllowedAllowedAllowedAllowedAllowedAllowed
Add AttachmentsAllowedAllowedAllowedAllowedAllowedAllowed
Reactivate SubscriptionNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Regenerate InvoiceNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Remove Scheduled CancellationNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Edit Scheduled CancellationNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Edit PauseNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Remove Scheduled PauseNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Remove Scheduled ResumptionNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Resume SubscriptionAllowedAllowedAllowedAllowedAllowedAllowed
Cancel Changes ( Scheduled Sub Change)Not AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Edit Start DateNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Add Manual DiscountNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Add UsageNot AllowedNot AllowedNot AllowedAllowedNot AllowedNot Allowed
Delete usageNot AllowedNot AllowedNot AllowedAllowedNot AllowedNot Allowed
View Usage DetailsNot AllowedNot AllowedNot AllowedAllowedNot AllowedNot Allowed
Edit Invoicing ScheduleNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
Delete Invoicing ScheduleNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
View Schedule ( Advance Invoice)Not AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
View schedule - Edit ( Advance Invoice)Not AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed

Invoice Actions on Source Entity

Actions / Invoice StatusPaidPostedPayment DueNot PaidVoidedPending
send_emailNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
update_addressNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
manage_dunningNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
set_expected_payment_dateNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
add_charge (add_charge, add_addon_charge)Not AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
close_pending_invoiceNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedAllowed
collect_nowNot AllowedNot AllowedAllowedAllowedNot AllowedNot Allowed
update_po_numberNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
record_paymentNot AllowedAllowedAllowedNot AllowedNot AllowedNot Allowed
apply_paymentNot AllowedAllowedAllowedNot AllowedNot AllowedNot Allowed
apply_creditNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
refundNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
record_refundNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
create_credit_noteNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
write_offNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
void_invoiceNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
deleteNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
usage_pdfNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedAllowed
view_pdfAllowedAllowedAllowedAllowedAllowedAllowed
remove_tax_withheldNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
record_tax_withheldNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
remove_offline paymentNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
remove_Promo_CreditsNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
remove_adjustment Credit noteNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed
remove_applied creditsNot AllowedNot AllowedNot AllowedNot AllowedNot AllowedNot Allowed

Credit Note Actions on Source Entity

Actions / StatusAdjustmentRefund DueRefundedVoided
Send EmailNot AllowedNot AllowedNot AllowedNot Allowed
Record an offline refundNot AllowedAllowedNot AllowedNot Allowed
Issue a refundNot AllowedAllowedNot AllowedNot Allowed
Void this credit noteNot AllowedNot AllowedNot AllowedNot Allowed
Delete this credit noteNot AllowedNot AllowedNot AllowedNot Allowed
Allocate creditsNot AllowedNot AllowedNot AllowedNot Allowed
Remove - Tax WithheldNot AllowedNot AllowedNot AllowedNot Allowed
Remove - Allocated CreditsNot AllowedNot AllowedNot AllowedNot Allowed
View_PDFAllowedAllowedAllowedAllowed

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

EndpointsSource Entity
Create a gift subscription for itemsNot Allowed
Retrieve a giftNot Allowed
List giftsAllowed
Claim a giftNot Allowed
Cancel a giftNot Allowed
Update a giftNot Allowed

Orders Endpoints

Create an orderNot Allowed
Update an orderNot Allowed
Import an orderNot Allowed
Assign order numberNot Allowed
Cancel an orderNot Allowed
Create a refundable credit noteNot Allowed
Reopen a cancelled orderNot Allowed
Retrieve an orderAllowed
Delete an imported orderNot Allowed
List ordersAllowed
Resend an orderNot Allowed

Hosted Pages Endpoints

Checkout charge-items and one-time chargesNot Allowed
Create checkout for a new subscriptionNot Allowed
Create checkout to update a subscriptionNot Allowed
Update payment methodAllowed
Manage Payment SourcesAllowed
Collect NowAllowed
Accept a quoteNot Allowed
Notify an eventNot Allowed
Extend SubscriptionNot Allowed
Checkout Gift subscription for ItemsNot Allowed
Claim a Gift subscriptionNot Allowed
Retrieve Direct Debit Agreement PDFAllowed
Acknowledge a hosted pageNot Yet Decided
Retrieve a hosted pageNot Yet Decided
List hosted pagesNot Yet Decided
Create a pre-cancel hosted pageNot Allowed
Create a hosted page to view Boleto vouchersAllowed

Portal Sessions Endpoints

Create a portal sessionAllowed
Retrieve a portal sessionAllowed
Logout a portal sessionAllowed
Activate a portal sessionAllowed

Transactions Endpoints

EndpointSource Entity
Create an authorization paymentAllowed
Void an authorization transactionAllowed
Retrieve a transactionAllowed
Delete an offline transactionNot Allowed
Refund a paymentNot Allowed
List transactionsAllowed
List payments for an invoiceAllowed
Record an offline refundNot Allowed

Comments Endpoints

Create a commentAllowed
Retrieve a commentAllowed
List commentsAllowed
Delete a commentAllowed

Purchases Endpoints

Create a purchaseNot Allowed
Estimates for purchaseNot Allowed

Events Endpoints

Retrieve an eventNot Allowed
List eventsNot Allowed

Exports Endpoints

Export CustomersAllowed
Export SubscriptionsAllowed
Export InvoicesAllowed
Export Credit NotesAllowed
Export TransactionsAllowed
Export OrdersAllowed

Payments Endpoints

Create customer using gateway temporary tokenAllowed
Create using permanent tokenAllowed
Create using chargebee tokeAllowed
Create using payment intentAllowed
Create card payment sourceAllowed
Create bank payment sourceAllowed
Delete a payment sourceAllowed
Local delete a payment sourceAllowed
Update bank payment sourceAllowed
Verify bank payment sourceAllowed
Retrieve payment sourceAllowed
List payment sourceAllowed
Switch gateway accountNot Allowed
Export payment sourcesAllowed
Create voucher payment methodAllowed
Update card payment sourceAllowed
Create a payment intentAllowed
Update payment intentAllowed
Retrieve payment intentAllowed
Retrieve card for customerDeprecated 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 GatewayDeprecated This request is obsoleted by the Switch gateway account API for Payment Sources.
Copy cardDeprecated 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 customerDeprecated 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 tokenAllowed
Create virtual bank accountAllowed
Retrieve virtual bank accountAllowed
List virtual bank accountsAllowed
Delete virtual bank accountAllowed
Local delete virtual bank accountAllowed
List vouchers for customerAllowed
Retrieve voucher dataAllowed
Create voucher for customer to initiate paymentAllowed
List vouchers for invoiceAllowed

API Changes Allowed or Restricted in Different APIs

Customer API

customer_createAllowed
customer_updateNot Allowed
customer_update_payment_methodNot Allowed
customer_update_billingNot Allowed
assign_payment_roleAllowed
add_contactNot Allowed
update_contactNot Allowed
delete_contactNot Allowed
add_promotional_creditsNot Allowed
deduct_promotional_creditsNot Allowed
set_promotional_creditsNot Allowed
record_excess_paymentNot Allowed
customer_collect_paymentNot Allowed
deleteNot Allowed
moveAllowed
change_billing_dateNot Allowed
merge_customersAllowed (partially)
customer_clear_personal_dataAllowed
link_a_customerNot Allowed
delete_relationshipNot Allowed
update_hierarchy_settingsNot Allowed

Subscription API

sub_create_itemNot Allowed
remove_scheduled_changesNot Allowed
remove_scheduled_cancellation_epNot Allowed
remove_couponsNot Allowed
sub_update_for_itemsNot Allowed
change_term_endNot Allowed
reactivate_subscriptionNot Allowed
add_charge_at_term_endNot Allowed
charge_future_renewalsNot Allowed
edit_advance_invoice_scheduleNot Allowed
remove_advance_invoice_scheduleNot Allowed
regenerate_invoiceNot Allowed
import_contract_termNot Allowed
import_unbilled_chargesNot Allowed
delete_subscriptionNot Allowed
pauseNot Allowed
cancel_for_itemsNot Allowed
resume_subscription (Intermediate)Allowed
resume_subscription (Transferred)Not Allowed
remove_scheduled_pauseNot Allowed
remove_scheduled_resumptionNot Allowed

Invoice API

update_invoiceNot Allowed
record_paymentAllowed
record_refundNot Allowed
create_for_charge_items_and_chargesNot Allowed
stop_dunningNot Allowed
import_invoiceNot Allowed
invoice_apply_paymentsAllowed
sync_usagesNot Allowed
delete_line_itemsNot Allowed
invoice_apply_creditsNot Allowed
add_charge_pendingNot Allowed
add_charge_itemNot Allowed
close_nowAllowed
collect_paymentAllowed
record_tax_withheldNot Allowed
remove_tax_withheldNot Allowed
refund_invoiceNot Allowed
remove_paymentNot Allowed
remove_credit_noteNot Allowed
void_invoiceNot Allowed
write_offNot Allowed
delete_invoiceNot Allowed
resend_einvoiceNot Allowed
send_einvoiceNot Allowed

Credit Note API

create_credit_noteNot Allowed
refundAllowed
import_credit_noteNot Allowed
record_refundAllowed
voidNot Allowed
deleteNot Allowed
remove_tax_withheld_refundNot Allowed
resend_einvoiceNot Allowed
send_einvoiceNot Allowed

Quote API

update_sub_items_quoteNot Allowed
one_time_charge_items_quoteNot Allowed
create_sub_items_quoteNot Allowed

Promotional Credit API

addNot Allowed
deductNot Allowed
setNot Allowed

Address API

address_updateNot Allowed

Usage API

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

Unbilled Charge API

unbilled_charges_create_for_itemsNot Allowed
invoice_unbilled_chargesNot Allowed
deleteNot Allowed
invoice_now_estimateNot Allowed

Estimate API

estimate_createsub_for_item_with_customerAllowed
estimate_createsub_for_customerNot Allowed
estimate_createsub_for_itemAllowed
estimate_updatesub_for_itemsNot Allowed
advance_invoice_estimateNot Allowed
regenerate_invoice_estimateNot Allowed
upcoming_invoice_for_cmrrNot Allowed
change_term_end_estimateNot Allowed
cancel_subscription_for_items_estimateNot Allowed
pause_subscription_estimateNot Allowed
resume_subscription_estimateAllowed
gift_subscription_for_itemsNot Allowed
create_invoice_for_itemsNot Allowed

Transaction API

create_an_authorization_paymentAllowed
cancel_an_authorization_paymentAllowed
sync_transaction (Bulk Operation)Allowed
record_refundNot Allowed
refund_transactionNot Allowed
delete_offline_transactionNot Allowed

Hosted Page API

checkout_one_timeNot Allowed
checkout_one_time_for_itemsNot Allowed
checkout_new_for_itemsNot Allowed
checkout_existing_for_itemsNot Allowed
manage_paymentsAllowed
update_payment_method_hpAllowed
collect_unpaid_invoicesAllowed
accept_quoteNot Allowed
extend_subscriptionNot Allowed
checkout_gift_for_itemsNot Allowed
claim_giftAllowed
acknowledge_hosted_pageAllowed
precancelNot Allowed
eventsAllowed
view_voucherAllowed

Gift API

gift_create_for_itemsNot Allowed
claim_giftAllowed

Order API

OperationPermission
createOrderConfigNot Allowed
updateOrderConfigNot Allowed
importOrderNot Allowed
assignOrderNumberConfigNot Allowed
cancelOrderConfigNot Allowed
refundOrderConfigNot Allowed
reopenOrderConfigNot Allowed
deleteOrderNot Allowed
resendOrderConfigNot Allowed

Portal API

OperationPermission
portal_session_createAllowed
logoutAllowed
activateAllowed

Payment Source API

switch_gateway_accountNot Allowed

Credit Card API

switchGatewayForCustomerNot Allowed
copyCardForCustomerNot Allowed
deleteCardForCustomerAllowed

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?