POST /pc2_migration_items

Servers

Request headers

Name Type Required Description
chargebee-request-origin-device String No

The device from which the customer has made the request

Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

chargebee-event-webhook String No

skip only webhooks

Possible values:

  • "all-disabled"
chargebee-business-entity-id String No

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.

chargebee-event-actions String No

skip all actions to be done on the events

Possible values:

  • "all-disabled"
chargebee-request-origin-user String No

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

chargebee-request-origin-ip String No

The IP address of the customer where the request originated

chargebee-request-origin-user-encoded String No

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-event-email String No

skip only emails

Possible values:

  • "all-disabled"

Request body fields

Name Type Required Description
included_in_mrr Boolean No
is_giftable Boolean No

Default value: false

description String No
pc2_migration_item_family_id String No
metadata String No
pc1_type String Yes

Possible values:

  • "plan"
  • "addon"
is_recurring Boolean No

Default value: true

enabled_for_checkout Boolean No

Default value: false

unit String No
id String Yes
pc2_migration_id String Yes
name String Yes
redirect_url String No
is_shippable Boolean No

Default value: false

gift_claim_redirect_url String No
enabled_in_portal Boolean No

Default value: false

pc2_migration_item_prices Object No
pc2_migration_item_prices.id[] Array No
pc2_migration_item_prices.name[] Array Yes
pc2_migration_item_prices.description[] Array No
pc2_migration_item_prices.metadata[] Array No
pc2_migration_item_prices.ref_entity_id[] Array Yes

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.