Import
Preview a Chargebee Import
Dry-run a Chargebee export — see what a commit would do, with no side effects.
POST
/
v1
/
import
/
chargebee
/
preview
Dry-run preview of a Chargebee export
curl --request POST \
--url https://billing.example.com/v1/import/chargebee/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customers": [
{}
],
"plans": [
{}
],
"subscriptions": [
{}
]
}
'import requests
url = "https://billing.example.com/v1/import/chargebee/preview"
payload = {
"customers": [{}],
"plans": [{}],
"subscriptions": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({customers: [{}], plans: [{}], subscriptions: [{}]})
};
fetch('https://billing.example.com/v1/import/chargebee/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://billing.example.com/v1/import/chargebee/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'customers' => [
[
]
],
'plans' => [
[
]
],
'subscriptions' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://billing.example.com/v1/import/chargebee/preview"
payload := strings.NewReader("{\n \"customers\": [\n {}\n ],\n \"plans\": [\n {}\n ],\n \"subscriptions\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://billing.example.com/v1/import/chargebee/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customers\": [\n {}\n ],\n \"plans\": [\n {}\n ],\n \"subscriptions\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://billing.example.com/v1/import/chargebee/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customers\": [\n {}\n ],\n \"plans\": [\n {}\n ],\n \"subscriptions\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"kind": "customer",
"chargebee_id": "<string>",
"label": "<string>",
"action": "create",
"detail": "<string>"
}
],
"summary": {},
"warnings": [
"<string>"
]
}{
"error": {
"code": "validation_failed",
"message": "<string>"
}
}{
"error": {
"code": "validation_failed",
"message": "<string>"
}
}Parses an uploaded Chargebee export (customers, plans, subscriptions) and
returns a plan of what a commit
would
create, link_existing, skip_already_imported, mark as a
conflict, or refuse as unsupported — nothing is written. Existing
customers are matched by email. Plan price is minor units.
Example request
curl -X POST https://api.recurso.dev/v1/import/chargebee/preview \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"customers": [
{ "id": "cbcust_16CHqzTxUm4p2N", "email": "arjun@example.com", "first_name": "Arjun", "last_name": "Mehta", "company": "Mehta Labs" }
],
"plans": [
{ "id": "pro-monthly", "name": "Pro Monthly", "price": 149900, "period": 1, "period_unit": "month", "currency_code": "INR", "status": "active" }
],
"subscriptions": [
{ "id": "cbsub_19DKrwVyWn6q3P", "customer_id": "cbcust_16CHqzTxUm4p2N", "plan_id": "pro-monthly", "status": "active", "current_term_start": 1754006400, "current_term_end": 1756684800 }
]
}'
Example response
{
"items": [
{ "kind": "customer", "chargebee_id": "cbcust_16CHqzTxUm4p2N", "label": "Arjun Mehta <arjun@example.com>", "action": "create", "detail": "" },
{ "kind": "plan", "chargebee_id": "pro-monthly", "label": "Pro Monthly — 149900 INR / month", "action": "create", "detail": "" },
{ "kind": "subscription", "chargebee_id": "cbsub_19DKrwVyWn6q3P", "label": "active", "action": "create", "detail": "" }
],
"summary": { "create": 3 },
"warnings": []
}
Authorizations
Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.
Body
application/json
The Chargebee export JSON.
⌘I
Dry-run preview of a Chargebee export
curl --request POST \
--url https://billing.example.com/v1/import/chargebee/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customers": [
{}
],
"plans": [
{}
],
"subscriptions": [
{}
]
}
'import requests
url = "https://billing.example.com/v1/import/chargebee/preview"
payload = {
"customers": [{}],
"plans": [{}],
"subscriptions": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({customers: [{}], plans: [{}], subscriptions: [{}]})
};
fetch('https://billing.example.com/v1/import/chargebee/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://billing.example.com/v1/import/chargebee/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'customers' => [
[
]
],
'plans' => [
[
]
],
'subscriptions' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://billing.example.com/v1/import/chargebee/preview"
payload := strings.NewReader("{\n \"customers\": [\n {}\n ],\n \"plans\": [\n {}\n ],\n \"subscriptions\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://billing.example.com/v1/import/chargebee/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customers\": [\n {}\n ],\n \"plans\": [\n {}\n ],\n \"subscriptions\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://billing.example.com/v1/import/chargebee/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customers\": [\n {}\n ],\n \"plans\": [\n {}\n ],\n \"subscriptions\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"kind": "customer",
"chargebee_id": "<string>",
"label": "<string>",
"action": "create",
"detail": "<string>"
}
],
"summary": {},
"warnings": [
"<string>"
]
}{
"error": {
"code": "validation_failed",
"message": "<string>"
}
}{
"error": {
"code": "validation_failed",
"message": "<string>"
}
}