customerEntity that represents a customersubscriptionEntity that represents a subscription of a customerinvoiceInvoice descriptioncredit_noteCredit note description
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.
optional, string filter Entity Id of the record in the other site.Possible values are : Supported operators : is, is_not, starts_with
Example →entity_id_at_other_site[is] = "null"
+
entity_id_at_other_site
Entity Id of the record in the other site. pass parameters as entity_id_at_other_site[<param name>][<operator>]
entity_id_at_other_site[is][operator]
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]
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]
entity_id_at_other_site[starts_with][operator]
optional, string, min chars=1 filter Possible values are : Supported operators :
Example →
other_site_name[<operator>]
other_site_name[<operator>]
optional, string filter Site name to which the record is moved in/out.Possible values are : Supported operators : is, is_not, starts_with
Example →other_site_name[is] = "acme-test"
+
other_site_name
Site name to which the record is moved in/out. pass parameters as other_site_name[<param name>][<operator>]
other_site_name[is][operator]
other_site_name[is][operator]
optional, string, min chars=1 filter Possible values are : Supported operators :
Example →
other_site_name[is_not][operator]
other_site_name[is_not][operator]
optional, string, min chars=1 filter Possible values are : Supported operators :
Example →
other_site_name[starts_with][operator]
other_site_name[starts_with][operator]
optional, string, min chars=1 filter Possible values are : Supported operators :
Example →
entity_id[<operator>]
entity_id[<operator>]
optional, string filter Id of the entity in this site.Possible values are : Supported operators : is, is_not, starts_with
Example →entity_id[is] = "8axqwer7as"
+
entity_id
Id of the entity in this site. pass parameters as entity_id[<param name>][<operator>]
entity_id[is][operator]
entity_id[is][operator]
optional, string, min chars=1 filter Possible values are : Supported operators :
Example →
entity_id[is_not][operator]
entity_id[is_not][operator]
optional, string, min chars=1 filter Possible values are : Supported operators :
Example →
entity_id[starts_with][operator]
entity_id[starts_with][operator]
optional, string, min chars=1 filter Possible values are : Supported operators :
Example →
entity_type[<operator>]
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
Entity Type of the record. pass parameters as entity_type[<param name>][<operator>]
entity_type[is][operator]
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]
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]
entity_type[in][operator]
optional, string filter Possible values are : Supported operators :
Example →
entity_type[not_in][operator]
entity_type[not_in][operator]
optional, string filter Possible values are : Supported operators :
Example →
status[<operator>]
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
Status of the migration. pass parameters as status[<param name>][<operator>]
status[is][operator]
status[is][operator]
optional, enumerated string filter Possible values are : moved_in, moved_out, moving_out Supported operators :
Example →
status[is_not][operator]
status[is_not][operator]
optional, enumerated string filter Possible values are : moved_in, moved_out, moving_out Supported operators :
Example →
status[in][operator]
status[in][operator]
optional, string filter Possible values are : Supported operators :
Example →
status[not_in][operator]
status[not_in][operator]
optional, string filter Possible values are : Supported operators :
always returned 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`.