Settings
API Version
Product Catalog
Library

Site migration details

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 ]

{ "site_migration_detail": { "entity_id": "__test__KyVnHhSBWT9AW8j", "entity_id_at_other_site": "__test__KyVnHhSBWT9AW8j", "entity_type": "customer", "migrated_at": 1600704658, "object": "site_migration_detail", "other_site_name": "mannar", "status": "moved_in" } }

API Index URL

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

Model Class

 
 Site migration detail attributes 
 
entity_id
 
 string, max chars=100
 
Id of the entity in this site.
 
 
 
other_site_name
 
 string, min chars=4, max chars=50
 
Site name to which the record is moved in/out.
 
 
 
entity_id_at_other_site
 
 string, max chars=100
 
Entity Id of the record in the other site.
 
 
 
migrated_at
 
 timestamp(UTC) in seconds
 
Date in which the record is copied
 
 
 
entity_type
 
 enumerated string
 
Entity Type of the record
 
 
Possible values are
 
 
customer
Entity that represents a customer
subscription
Entity that represents a subscription of a customer
invoice
Invoice description
credit_note
Credit note description
 
 Show all values[+]
 
status
 
 enumerated string
 
Status of the migration
 
 
Possible values are
 
 
moved_in
Moved in from another cb site
moved_out
Moved out from one cb site to another
moving_out
Moving out from one cb site to another
 
 Show all values[+]
 
 
entity_id entity_id
 
 string, max chars=100
 
Id of the entity in this site.
 
 
other_site_name other_site_name
 
 string, min chars=4, max chars=50
 
Site name to which the record is moved in/out.
 
 
entity_id_at_other_site entity_id_at_other_site
 
 string, max chars=100
 
Entity Id of the record in the other site.
 
 
migrated_at migrated_at
 
 timestamp(UTC) in seconds
 
Date in which the record is copied
 
 
entity_type entity_type
 
 enumerated string
 
Entity Type of the record
 
 
Possible values are
 
 
customer
Entity that represents a customer
subscription
Entity that represents a subscription of a customer
invoice
Invoice description
credit_note
Credit note description
 
 Show all values[+]
status status
 
 enumerated string
 
Status of the migration
 
 
Possible values are
 
 
moved_in
Moved in from another cb site
moved_out
Moved out from one cb site to another
moving_out
Moving out from one cb site to another
 
 Show all values[+]
 
 
Consent Fields for Site migration detail
 
 
Custom Fields for Site migration detail
 
 
 List site migration details 
 
  Try in API Explorer  
This endpoint lists the site migration details.
  
 Sample Request 
 
 Try in API Explorer 
 
 
curl https://{site}.chargebee.com/api/v2/site_migration_details \ -G \ -u {site_api_key}:\ --data-urlencode limit=3
 
 copy 
Click to Copy
 
 
200:
 
OK
 
STATUS
 
 Sample Response [ JSON ]
 
Show more...
 
{ "list": [ { "site_migration_detail": { "entity_id": "__test__KyVnHhSBWT9AW8j", "entity_id_at_other_site": "__test__KyVnHhSBWT9AW8j", "entity_type": "customer", "migrated_at": 1600704658, "object": "site_migration_detail", "other_site_name": "mannar", "status": "moved_in" } }, {..} ] }
 
 URL Format GET
 
 https://{site}.chargebee.com/api/v2/site_migration_details 
 
Method
 
 
Input Parameters
 
limit[]
 
 optional, integer, default=10, min=1, max=100 
 The number of resources to be returned. 
offset[]
 
 optional, string, max chars=1000 
 Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call. 
 
 
 
Filter Params 
 
 For operator usages, see the Pagination and Filtering section. 
 
entity_id_at_other_site[<operator>]
  
 optional, string filter
  
Entity Id of the record in the other site. Supported operators : is, is_not, starts_with
 
Example → entity_id_at_other_site[is] = "null"
 Possible values are :  
Supported operators : is, is_not, starts_with 

Example → entity_id_at_other_site[is] = "null"
 
 
 
entity_id_at_other_site[is][operator]
 
 optional, string, min chars=1 filter
  Possible values are :  
Supported operators : 

Example → 
 
entity_id_at_other_site[is_not][operator]
 
 optional, string, min chars=1 filter
  Possible values are :  
Supported operators : 

Example → 
 
entity_id_at_other_site[starts_with][operator]
 
 optional, string, min chars=1 filter
  Possible values are :  
Supported operators : 

Example → 
other_site_name[<operator>]
  
 optional, string filter
  
Site name to which the record is moved in/out. Supported operators : is, is_not, starts_with
 
Example → other_site_name[is] = "acme-test"
 Possible values are :  
Supported operators : is, is_not, starts_with 

Example → other_site_name[is] = "acme-test"
 
 
 
other_site_name[is][operator]
 
 optional, string, min chars=1 filter
  Possible values are :  
Supported operators : 

Example → 
 
other_site_name[is_not][operator]
 
 optional, string, min chars=1 filter
  Possible values are :  
Supported operators : 

Example → 
 
other_site_name[starts_with][operator]
 
 optional, string, min chars=1 filter
  Possible values are :  
Supported operators : 

Example → 
entity_id[<operator>]
  
 optional, string filter
  
Id of the entity in this site. Supported operators : is, is_not, starts_with
 
Example → entity_id[is] = "8axqwer7as"
 Possible values are :  
Supported operators : is, is_not, starts_with 

Example → entity_id[is] = "8axqwer7as"
 
 
 
entity_id[is][operator]
 
 optional, string, min chars=1 filter
  Possible values are :  
Supported operators : 

Example → 
 
entity_id[is_not][operator]
 
 optional, string, min chars=1 filter
  Possible values are :  
Supported operators : 

Example → 
 
entity_id[starts_with][operator]
 
 optional, string, min chars=1 filter
  Possible values are :  
Supported operators : 

Example → 
entity_type[<operator>]
  
 optional, enumerated string filter
  
Entity Type of the record.  Possible values are : customer, subscription, invoice, credit_note, transaction, order 
Supported operators : is, is_not, in, not_in 

Example → entity_type[is] = "customer"
 
 
 
entity_type[is][operator]
 
 optional, enumerated string filter
  Possible values are : customer, subscription, invoice, credit_note, transaction, order 
Supported operators : 

Example → 
 
entity_type[is_not][operator]
 
 optional, enumerated string filter
  Possible values are : customer, subscription, invoice, credit_note, transaction, order 
Supported operators : 

Example → 
 
entity_type[in][operator]
 
 optional, string filter
  Possible values are :  
Supported operators : 

Example → 
 
entity_type[not_in][operator]
 
 optional, string filter
  Possible values are :  
Supported operators : 

Example → 
status[<operator>]
  
 optional, enumerated string filter
  
Status of the migration.  Possible values are : moved_in, moved_out, moving_out 
Supported operators : is, is_not, in, not_in 

Example → status[is] = "MOVED_OUT"
 
 
 
status[is][operator]
 
 optional, enumerated string filter
  Possible values are : moved_in, moved_out, moving_out 
Supported operators : 

Example → 
 
status[is_not][operator]
 
 optional, enumerated string filter
  Possible values are : moved_in, moved_out, moving_out 
Supported operators : 

Example → 
 
status[in][operator]
 
 optional, string filter
  Possible values are :  
Supported operators : 

Example → 
 
status[not_in][operator]
 
 optional, string filter
  Possible values are :  
Supported operators : 

Example → 
 
Returns
 
site_migration_detail  site_migration_detail
 
 always returned 
 Resource object representing site_migration_detail
next_offset  next_offset
 
 optional, string, max chars=1000
 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`.
 
Sample admin console URL
 
 https://{site}.chargebee.com/admin-console/site_migration_details/123x