Variants

A product variant is a specific product version with a unique combination of product option values.

Sample VariantJSON

API Index URL

https://[site].chargebee.com/api/v2/variants

Variants attributes

optional, string, max chars=100

The immutable unique identifier of a product variant.

name

required, string, max chars=100

This is a unique name that appears for each product variant to the end user.

external_name

optional, string, max chars=100

This is a unique name appears for each product variant to the end user.

description

optional, string, max chars=500

Description of the product variant.

sku

optional, string, max chars=100

A unique identifier code a seller assigns to each product or item. Retailers and merchants use SKUs to keep track of inventory and sales data and help organize products within a store or warehouse. SKUs can include a combination of letters, numbers, and symbols and can vary in length depending on the seller's needs.

deleted

required, boolean, default=false

Product variant is deleted or not. If the value is true then the product variant has been deleted else it exists. Once the product variant is deleted, you can reuse the product variant id and name .

product_id

required, string, max chars=100

The unique identifier of the product that is associated with this variant.

status

optional, enumerated string

Status of the product variant.

Enum Values

active

The active product variants are visible on the storefront, subscription, or checkout.

inactive

The inactive product variants are not visible on the storefront, subscription, or checkout.

created_at

required, timestamp(UTC) in seconds

Timestamp when the product variant was created.

resource_version

optional, long

Version number of this resource. The resource_version is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.

updated_at

optional, timestamp(UTC) in seconds

Timestamp indicating when this product variant was last updated.

metadata

optional, jsonobject

A collection of key-value pairs that provides extra information about the product.

Note: There's a character limit of 65,535.

Learn more .

option_values

List of product variants option values.