Resource migrations

API Version

Product Catalog

Library

Resource Migration is used for finding the status of customer migration between Chargebee sites.

Sample resource migration [ JSON ]

{
    "from_site": "yourapp",
    "entity_type": "customer",
    "entity_id": "test123",
    "status": "failed",
    "created_at": 1528093653,
    "updated_at": 1528093653,
    "object": "resource_migration"
}

API Index URL GET

https://{site}.chargebee.com/api/v2/resource_migrations

from_site

string, min chars=4, max chars=50
Domain name to which the item is moved.

entity_type

enumerated string
Type of the entity this record is stored for

Possible values are

entity_id

string, max chars=100
Handle of the customer in the current site.

status

enumerated string, default=failed
Status of the copy customer process.

Possible values are

errors

optional, string, max chars=65k
Filled only if the copy operation gets failed

created_at

timestamp(UTC) in seconds
Time the log is created

updated_at

timestamp(UTC) in seconds
Time the log is updated

Gets the last migration details.

Sample Request

Try in API Explorer

Only for Java

copy full code

Click to Copy

curl  https://{site}.chargebee.com/api/v2/resource_migrations/retrieve_latest \
     -u {site_api_key}:\
     -d from_site="merchant-test" \
     -d entity_type="CUSTOMER" \
     -d entity_handle="test123"

copy

Click to Copy

Sample Response [ JSON ]

{
    "resource_migration": {
        "from_site": "yourapp",
        "entity_type": "customer",
        "entity_id": "test123",
        "status": "failed",
        "created_at": 1539327043,
        "updated_at": 1539327043,
        "object": "resource_migration"
    }
}

URL Format GET

https://{site}.chargebee.com/api/v2/resource_migrations/retrieve_latest

from_site[]

required, string, min chars=4, max chars=50
Domain name to which the item is moved.

entity_type[]

required, enumerated string
Type of the entity this record is stored for.

Possible values are

entity_id[]

required, string, max chars=100
Handle of the customer in the current site.

resource_migration

always returned
Resource object representing resource_migration

Sample resource migration [ JSON ]

API Index URL GET

Model Class

Resource migration attributes

Consent Fields for Resource migration

Custom Fields for Resource migration

Retrieve latest migration details ¶

Notes

Sample Response [ JSON ]

URL Format GET

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL