younifyd
Menu

Move A Customer

Move a customer

POST/customers/move

Use it in a workflow

  1. Add a step and choose the Chargebee connector.
  2. Pick the Move A Customer action (under Chargebee API).
  3. Fill in the fields below, then reference the result from later steps as {{moveACustomer.response.data}}.

Request

Headers

chargebee-request-origin-devicestring

The device from which the customer has made the request

chargebee-request-origin-userstring (email)

The email address of your customer/user. Use this when the email address has only ASCII characters.

chargebee-request-origin-user-encodedstring (email)

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

chargebee-request-origin-ipstring

The IP address of the customer where the request originated

chargebee-event-actionsstring

skip all actions to be done on the events

One ofall-disabled

chargebee-event-emailstring

skip only emails

One ofall-disabled

chargebee-event-webhookstring

skip only webhooks

One ofall-disabled

chargebee-business-entity-idstring

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

Request body

Enter the body as JSON in the step's Body field.

id_at_from_sitestringrequired

Id of the customer to be copied.

from_sitestringrequired

Name of the site from which this customer need to be copied.

json
{
  "id_at_from_site": null,
  "from_site": null
}

Response

Returns 200 with an object. Read it in later steps with {{moveACustomer.response.data.<field>}}.

resource_migrationobject

Resource Migration is used for finding the status of customer migration between Chargebee sites.

from_sitestringrequired

Domain name to which the item is moved.

entity_typestringrequired

Type of the entity this record is stored for \* customer - Entity that represents a customer

One ofcustomer

entity_idstringrequired

Handle of the customer in the current site.

statusstringrequired

Status of the copy customer process. \* failed - Failed \* succeeded - Succeeded \* scheduled - Scheduled

One ofscheduledfailedsucceededDefault "failed"

errorsstring

Filled only if the copy operation gets failed

created_atinteger (unix-time)required

Time the log is created

updated_atinteger (unix-time)required

Time the log is updated

json
{
  "resource_migration": null
}

Need more? See the Chargebee guide for connection setup and behaviour shared by every action.