ChargebeeAPI

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 variantJSON

Price variants attributes

id
required, string, max chars=100

The unique and immutable identifier of the price variant.

name
required, string, max chars=100

A unique name of the price variant.

external_name
optional, string, max chars=100

A unique display name for the price variant.

variant_group
optional, string, max chars=100

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.

status
optional, enumerated string

Status of a price variant.

Possible Enum Values
active

Active price variant. This price variant can be attached to item prices .

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.

deleted

Deleted price variant. The id and name of the deleted price variant can be reused.

created_at
required, timestamp(UTC) in seconds

Timestamp indicating when this price variant is created.

resource_version
optional, long

The version number of this resource. For every change made to the resource, resource_version is updated with a new timestamp in milliseconds.

updated_at
optional, timestamp(UTC) in seconds

Timestamp indicating when this price variant was last updated.

archived_at
optional, timestamp(UTC) in seconds

Timestamp indicating when this price variant was archived.

business_entity_id
optional, string, max chars=50

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.

deleted
required, boolean

Indicates whether the price variant has been deleted or not.

attributes
optional, list of attribute

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.