Moves a subscription from one customer to another asynchronously. All related resources such as unbilled_charge, invoice, credit_note, and transaction are also moved to the new customer.
After moving, Chargebee adds a comment to the original customer resource to document the move, including the to_customer_id and the ids of all the resources transferred to the destination customer.
Warning
- If
auto_collectionison, it might fail after this operation. Refer to the warning incopy_payment_sourcefor details. - During the time that it takes for the operation to complete, no modifications are allowed on the source customer, the destination customer, and the subscription.
- After moving a subscription, the change does not reflect in Chargebee Billing's accounting integrations or in Chargebee RevRec.
- This API will return an error when multi-frequency billing is enabled.
Prerequisites
- The subscription should not be part of a
customerresource that is within an account hierarchy relationship. - There must be no invoices with the statuses
payment_due,pending, orpostedassociated with the subscription. - The site must have consolidated invoicing disabled.
- There should be no consolidated invoices linked to the subscription.
- No
credit_noteresources with the statusesadjustedorrefund_dueshould be associated with the subscription. - With muti business entity (MBE) enabled on your site, moving a subscription to a customer belonging to another business entity is not allowed.
Asynchronous operation
If the above prerequisites are met, the API call returns a 200 OK response containing the subscription resource as is. However, the actual move operation can take up to five minutes to complete.
To know whether the operation was successful, we recommend that you watch for the subscription_changed event and see if subscription.customer_id has changed.
Limitations
- Subscriptions cannot be moved on the same calendar day as their renewal. For instance, if a renewal is scheduled for 2 PM on April 10, 2024, the endpoint is restricted from 12 AM on April 10, 2024, until the renewal is completed.
- After moving a subscription, the change does not reflect in Chargebee Billing's accounting integrations or in Chargebee RevRec.
Note:
Resources linked to the original customer such as unbilled_charge
, invoice
, credit_note
, and transaction
but not
linked to the subscription being moved, are not
moved to the destination customer by this operation.
Sample Request
URL Format
Input Parameters
Specifies the unique ID of the customer resource to which the subscription will be moved.
Note:
If there are multiple business entities
, the customer.business_entity_id
of the destination customer must match the subscription.business_entity_id.
When true:
If the subscription has an associated payment_source:
- A new duplicate copy of the
payment_sourceresource is created. - This new copy of the payment source is linked to the subscription and the destination customer.
Note:
Deleting any copy of the payment_source
also deletes the other copies and the details stored at the payment gateway.
When false:
No new payment source is created for the subscription. Moreover, if a payment_source is already linked to the subscription, it gets removed, meaning the subscription.payment_source_id is cleared.
Warning:
When copy_payment_source
is false
and if subscription.auto_collection
is enabled, auto-collection will fail, in turn preventing subscription renewal. To prevent auto-collection failure, link a payment source
to the subscription after this operation.