Settings
Configure SDK
Price variants
Price variant resource offers businesses the flexibility to manage pricing for multiple variations of an item (plan, addon, or charge) in the Product Catalog. It enables the creation of diverse pricing structures based on variables such as geography, partners, versions, and more.
See also: For a more detailed understanding of Price Variants, including how to enable, configure, and manage them, as well as their impact on other features, follow these resources:
Sample price variant [ JSON ]
{
"updated_at": 1709200385,
"name": "Germany Berlin",
"created_at": 1709200385,
"attributes": [
{
"name": "country",
"value": "germany"
},
{
"name": "city",
"value": "berlin"
}
],
"id": "germany-berlin",
"external_name": "Germany",
"resource_version": 1709200385728,
"status": "active",
"object": "price_variant"
}API Index URL
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.
The unique ID of the
business entity
of this price_variant.
This is applicable only when multiple business entities have been created for the site. The value of this attribute indicates that the resource is specific to the given business entity.
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.
Create a price variant ¶
This endpoint allows the creation of a new price variant that can be attached to item prices.
Sample Response [ JSON ]
URL Format POST
Input Parameters
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.
The unique ID of the business entity
for this price_variant.
This is applicable only when multiple business entities have been created for the site. When provided, the operation will read or write data associated with the specified business entity. If not provided, the resource will be created at the site level, and the business_entity_id
will not be included in the API response.
Note An alternative way of passing this parameter is by means of a custom HTTP header.
.
Returns
Resource object representing price_variant
Retrieve a price variant ¶
This endpoint retrieves the details of a specific price variant using its unique identifier.
Sample Response [ JSON ]
URL Format GET
Returns
Resource object representing price_variant
Update a price variant ¶
This endpoint modifies the details of an existing price variant.
Sample Response [ JSON ]
URL Format POST
Input Parameters
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.
Returns
Resource object representing price_variant
Delete a price variant ¶
Deletes the price variant. This is not allowed if price variant is attached to any item price. Once deleted, the id and name of the price variant can be reused.
Sample Response [ JSON ]
URL Format POST
Returns
Resource object representing price_variant
List price variants ¶
This endpoint is used to retrieve a list of price variants.
Sample Response [ JSON ]
URL Format GET
Input Parameters
Sorts based on the specified attribute.
Supported attributes : name, id, status, created_at, updated_at
Supported sort-orders : asc, desc
Example → sort_by[asc] = "name"
This will sort the result based on the 'name' attribute in ascending(earliest first) order.
Filter Params
For operator usages, see the Pagination and Filtering section.
Filter variant based on their id . Supported operators : is, is_not, starts_with, in, not_in
Example → id[is] = "basic"
Supported operators : is, is_not, starts_with, in, not_in
Example → id[is] = "basic"
The unique ID of the
business entity
of this price_variant.
Learn more
about all the scenarios before using this filter.
Supported operators : is, is_present
Example → business_entity_id[is_present] = "true"
Supported operators : is, is_present
Example → business_entity_id[is] = "business_entity_id"
Default value is true . To exclude site-level resources in specific cases, set this parameter to false.
Supported operators : is
Example → include_site_level_resources[is] = "null"
Returns
Resource object representing price_variant
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`.