ChargebeeAPI
Join the Chargebee Developers Discord — Connect, ask questions, and build faster.Join

Merge customers

Idempotency Supported
Try in API Explorer

This API moves a customer's payment methods, subscriptions, invoices, credit notes, transactions, unbilled charges, and orders to another customer. Events and email logs will not be moved. The API execution is asynchronous.

Note

  • Moving virtual bank accounts from one customer to another is not supported in this API.
  • Merging customers from different business entities is not permitted.

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/customers/merge

Input Parameters

from_customer_id
required, string, max chars=50

From customer id.

to_customer_id
required, string, max chars=50

To customer id.

Returns

customerCustomer object
Resource object representing customer