POST /price_variants/{price-variant-id}

This endpoint modifies the details of an existing price variant.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Path parameters

Name	Type	Required	Description
`price-variant-id`	String	Yes

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
`variant_group`	String	No	The `variant_group` organizes similar price_variants to optimize strategies such as bundling, geo-based pricing experiments, and campaign-specific pricing like `cb-atomic-pricing-` for effective grouping. The `variant_group` provides greater flexibility and precision in your pricing models.
`attributes`	Object	No	The list of price variant attribute values. Attributes can be used to store additional information about the price variant. For example, for a price variant called 'Germany', the attributes can be 'Country':'Germany', 'City':'Berlin' and so on.
`attributes.name[]`	Array	Yes	Attribute name
`attributes.value[]`	Array	Yes	Attribute value
`name`	String	No	A unique name of the price variant.
`description`	String	No	Description of the price variant.
`external_name`	String	No	A unique display name for the price variant.
`status`	String	No	Status of a price variant. * active - Active price variant. This price variant can be attached to item prices. * deleted - Deleted price variant. The `id` and `name` of the deleted price variant can be reused. * archived - Archived price variant. This price variant is no longer `active` and cannot be attached to new item prices. Existing item prices that already have this price variant attached will continue to remain as is. Possible values: `"active"` `"archived"`

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.