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 ]

{
    "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 GET

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

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

customerEntity that represents a customer.subscriptionEntity that represents a subscription of a customer.invoiceInvoice description.credit_noteCredit note description.transactionEntity that represents a transaction.orderEntity that represents an order.

status

enumerated string
Status of the migration

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.

This endpoint lists the site migration details.

Sample Request

curl  https://{site}.chargebee.com/api/v2/site_migration_details \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=3

copy

curl  https://{site}.chargebee.com/api/v2/site_migration_details \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=3

Sample Response [ JSON ]

{"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

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"

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"

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"

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"

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"

site_migration_detail

always returned
Resource object representing site_migration_detail

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 site migration detail [ JSON ]

API Index URL GET

Site migration detail attributes

List site migration details¶

Sample Response [ JSON ]

URL Format GET

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns