Site migration details

API Version

Product Catalog

Library

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

Model Class

ChargeBee::SiteMigrationDetail

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 customersubscriptionEntity that represents a subscription of a customerinvoiceInvoice descriptioncredit_noteCredit note descriptiontransactionEntity 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 sitemoved_outMoved out from one cb site to anothermoving_outMoving out from one cb site to another

This endpoint lists the site migration details.

Sample Codes

 
require 'chargebee'
ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")
list = ChargeBee::SiteMigrationDetail.list({
  :limit => 3
  })
list.each do |entry|
  site_migration_detail = entry.site_migration_detail
end

copy

Click to Copy

 
require 'chargebee'
ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")
list = ChargeBee::SiteMigrationDetail.list({
  :limit => 3
  })
list.each do |entry|
  site_migration_detail = entry.site_migration_detail
end

Sample Result [ 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"
            }
        },
        {..}
    ]
}

Method

ChargeBee::SiteMigrationDetail.list({<param name> => <value>,<param name> => <value> ...})

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

Model Class

Site migration detail attributes

Consent Fields for Site migration detail

Custom Fields for Site migration detail

List site migration details ¶

Notes

Sample Result [ JSON ]

URL Format GET

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL