v2

latestOpenAPI 3.0.3Proprietary2026-07-263483431.1 MB

Business Products

Update one product variant

Requires the product:update scope. Updates a single variant. Product update does not accept bulk variant changes.

patch/v3/variants/{id}

Request body

cogsnumber

Cost of Goods Sold

currency'IDR'

The currency code for the item price.

descriptionstring

Variant Description

imagesstring[]

List of image URLs

image_configsobject

Per-image variant configuration

interval'day' | 'week' | 'month' | 'year'

Unit of the recurring billing period

interval_countinteger

Interval count for recurring variants

is_checkedboolean

Mark variant as sellable

is_discussion_activeboolean

Variant discussion capability flag

is_email_notification_activeboolean

Variant email notification capability flag

is_file_enabledboolean

Variant file delivery capability flag

is_license_enabledboolean

Variant license capability flag

is_lms_enabledboolean

Variant LMS capability flag

item_type'physical' | 'digital' | 'course' | 'license' | 'subscription'

Type of the product item

metadataobject

Additional metadata

option1_valuestring

Option 1 value for this variant. May be set only when the product has option1_name configured.

option2_valuestring

Option 2 value for this variant. May be set only when the product has option2_name configured.

option3_valuestring

Option 3 value for this variant. May be set only when the product has option3_name configured.

pricenumber

Price

pricing_type'one_time' | 'recurring'

Type of the product pricing

reseller_pricenumber

Reseller Price

rich_descriptionstring

Variant Rich Description

self_file_urlsstring[]

List of self file URLs

skustring

SKU

validity_periodinteger

Validity period for one-time variants

validity_period_unit'day' | 'week' | 'month' | 'year'

Unit of the one-time validity period

weightinteger

Weight in grams

Response

Product variant

cogsnumber

Cost of Goods Sold

price_btnumber

Price before tax

validity_period_unit'day' | 'week' | 'month' | 'year'

Unit of the period

displaystring

Display name for the variant

option1_valuestring

Value of the first product option

image_configsobject

Objects of config for each image in the same variant

reseller_price_btnumber

Reseller price before tax

option2_valuestring

Value of the second product option

reseller_pricenumber

Reseller price of the variant

fullnamestring

Full name of the variant

validity_periodinteger

Validity period for one time variants

uuidstring

Variant UUID

skustring

Stock Keeping Unit

product_namestring

Name of the associated product

item_type'physical' | 'digital' | 'course' | 'license' | 'subscription'

Type of the product item

pricing_type'one_time' | 'recurring'

Type of the product pricing

self_file_urlsstring[]

List of self file URLs associated with the variant

namestring

Full name of the variant

idinteger

Variant primary key

unique_idstring

Variant unique identifier

cogs_btnumber

Cost of Goods Sold before tax

currency'IDR'

The currency code for the subscription item price.

pricenumber

Price of the variant

imagesstring[]

List of image URLs associated with the variant

weightinteger

Weight of the variant in grams

is_checkedboolean

Mark variant as sellable

is_discussion_activeboolean

Variant discussion capability flag

is_email_notification_activeboolean

Variant email notification capability flag

is_file_enabledboolean

Variant file delivery capability flag

is_license_enabledboolean

Variant license capability flag

is_lms_enabledboolean

Variant LMS capability flag

interval_countinteger

Interval count for recurring variants

last_updated_atstring date-time

Timestamp when the variant was last updated

option3_valuestring

Value of the third product option

interval'day' | 'week' | 'month' | 'year'

Unit of the period

metadataobject

Additional metadata associated with the variant

created_atstring date-time

Timestamp when the variant was created

is_editableboolean

Indicates if the variant is editable