Site Migration details is used for finding the records that are moved in and moved out from one Chargebee site to another.

Sample site migration detail [ JSON ]

{ "entity_id": "4gkYnd21ouvW", "other_site_name": "cbdemo-test", "entity_id_at_other_site": "4gkYnd21ouvW", "migrated_at": 1505917619, "object": "site_migration_detail", "entity_type": "customer", "status": "moved_out" }

API Index URL GET

https://{site}.chargebee.com/api/v2/site_migration_details
entity_id
Id of the entity in this site.
string, max chars=100
other_site_name
Site name to which the record is moved in/out.
string, min chars=4, max chars=50
entity_id_at_other_site
Entity Id of the record in the other site.
string, max chars=100
migrated_at
Date in which the record is copied.
timestamp(UTC) in seconds
entity_type
Entity Type of the record.
enumerated string
Possible values are
customerEntity that represents a customer.subscriptionEntity that represents a subscription of a customer.invoiceEntity that represents an invoice.credit_noteEntity that represents a credit note.transactionEntity that represents a transaction.
status
Status of the migration.
enumerated string
Possible values are
moved_inMoved in from another cb site.moved_outMoved out from one cb site to another.moving_outMoving out from one cb site to another.
Sample Request
curl  https://{site}.chargebee.com/api/v2/site_migration_details \
     -G  \
     -u {site_api_key}: \
     --data-urlencode limit="5"
copy
curl  https://{site}.chargebee.com/api/v2/site_migration_details \
     -G  \
     -u {site_api_key}: \
     --data-urlencode limit="5"

Sample Response [ JSON ]

{"list": [ {"site_migration_detail": { "entity_id": "4gkYnd21ouvW", "other_site_name": "cbdemo-test", "entity_id_at_other_site": "4gkYnd21ouvW", "migrated_at": 1505917619, "object": "site_migration_detail", "entity_type": "customer" }}, {..} ]}

URL Format GET

https://{site}.chargebee.com/api/v2/site_migration_details
limit
Limits the number of resources to be returned.
optional, integer, default=10, min=1, max=100
offset
Allows you to fetch the next set of resources. The value used for this parameter must be the value returned for next_offset parameter in the previous API call.
optional, string, max chars=1000
Filter Params
For operator usages, see the Pagination and Filtering section.
entity_id_at_other_site[<operator>]
To filter based on SiteMigrationDetail Other Site Handle.
Supported operators : is, is_not, starts_with

Example entity_id_at_other_site[is] = "null"
optional, string filter
other_site_name[<operator>]
To filter based on SiteMigrationDetail Other Site Domain.
Supported operators : is, is_not, starts_with

Example other_site_name[is] = "acme-test"
optional, string filter
entity_id[<operator>]
To filter based on SiteMigrationDetail External Id.
Supported operators : is, is_not, starts_with

Example entity_id[is] = "8axqwer7as"
optional, string filter
entity_type[<operator>]
To filter based on Entity Type. Possible values are : customer, subscription, invoice, credit_note, transaction.
Supported operators : is, is_not, in, not_in

Example entity_type[is] = "customer"
optional, enumerated string filter
status[<operator>]
To filter based on Status. Possible values are : moved_in, moved_out, moving_out.
Supported operators : is, is_not, in, not_in

Example status[is] = "MOVED_OUT"
optional, enumerated string filter
Resource object representing site_migration_detail.
always returned
next_offset
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter “offset”.
optional, string, max chars=1000