# Merge customers

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


[Idempotency Supported](/docs/api/idempotency)

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](/docs/api/getting-started) is not permitted.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/customers/merge \
     -u {site_api_key}:\
     -d from_customer_id="__test__KyVnHhSBWlCbP2cp" \
     -d to_customer_id="__test__KyVnHhSBWlCdz2cv"
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = Customer.Merge()
		.FromCustomerId("__test__KyVnHhSBWlCbP2cp")
		.ToCustomerId("__test__KyVnHhSBWlCdz2cv")
		.Request();

Customer customer = result.Customer;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    customerAction "github.com/chargebee/chargebee-go/v3/actions/customer"
    "github.com/chargebee/chargebee-go/v3/models/customer"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := customerAction.Merge(&customer.MergeRequestParams{
        FromCustomerId : "__test__KyVnHhSBWlCbP2cp",
        ToCustomerId : "__test__KyVnHhSBWlCdz2cv",
    }).Request()
    if err != nil {
        fmt.Println(err)
    } else {
        Customer := res.Customer
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.CustomerMergeRequest{
    FromCustomerId : "__test__KyVnHhSBWlCbP2cp",
    ToCustomerId : "__test__KyVnHhSBWlCdz2cv",
}
  res, err := client.Customer.Merge(req)
      if err != nil {
        fmt.Println(err)
    } else {
        Customer := res.Customer
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = Customer.merge()
            .fromCustomerId("__test__KyVnHhSBWlCbP2cp")
            .toCustomerId("__test__KyVnHhSBWlCdz2cv")
            .request();

        Customer customer = result.customer();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.customer.Customer;
import com.chargebee.v4.models.customer.params.CustomerMergeParams;
import com.chargebee.v4.models.customer.responses.CustomerMergeResponse;

public class CustomerMerge {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        CustomerMergeParams params = CustomerMergeParams.builder()
            .fromCustomerId("__test__KyVnHhSBWlCbP2cp")
            .toCustomerId("__test__KyVnHhSBWlCdz2cv")
            .build();

        CustomerMergeResponse response = client.customers().merge(params);

        Customer customer = response.getCustomer();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.customer.merge({
        from_customer_id: "__test__KyVnHhSBWlCbP2cp",
        to_customer_id: "__test__KyVnHhSBWlCdz2cv"
    });

    console.log(result);
    const customer = result.customer;
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->customer()->merge([
    "from_customer_id" => "__test__KyVnHhSBWlCbP2cp",
    "to_customer_id" => "__test__KyVnHhSBWlCdz2cv"
]);
$customer = $result->customer;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.Customer.merge(
    cb_client.Customer.MergeParams(
        from_customer_id="__test__KyVnHhSBWlCbP2cp",
        to_customer_id="__test__KyVnHhSBWlCdz2cv"
    )
)
customer = response.customer
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

result = ChargeBee::Customer.merge({
  :from_customer_id => "__test__KyVnHhSBWlCbP2cp",
  :to_customer_id => "__test__KyVnHhSBWlCdz2cv"
})

customer = result.customer
```

## Sample Response

```json
{
  "customer": {
    "allow_direct_debit": false,
    "auto_collection": "on",
    "card_status": "no_card",
    "created_at": 1517505750,
    "deleted": false,
    "excess_payments": 0,
    "first_name": "John",
    "id": "__test__KyVnHhSBWlCdz2cv",
    "last_name": "Doe",
    "net_term_days": 0,
    "object": "customer",
    "pii_cleared": "active",
    "preferred_currency_code": "USD",
    "promotional_credits": 0,
    "refundable_credits": 0,
    "resource_version": 1517505750000,
    "taxability": "taxable",
    "unbilled_charges": 0,
    "updated_at": 1517505750
  }
}
```

## 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

- `customer` (Customer object)
  Resource object representing customer