You are viewing the documentation for Chargebee API V2. If you're using the older version (V1), click here.

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
customerEntity that represents a customer.
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
scheduledScheduled.failedFailed.succeededSucceeded.
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
curl  https://{site}.chargebee.com/api/v2/resource_migrations/retrieve_latest \
     -G  \
     -u {site_api_key}:\
     -d from_site="merchant-test" \
     -d entity_type="customer" \

Sample Response [ JSON ]

Show more...
{"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
customerEntity that represents a customer.
entity_id
required, string, max chars=100
Handle of the customer in the current site.
always returned
Resource object representing resource_migration.