Retrieve
Retrieves details of a specific variant.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Success
The UUID of the specific object.
A string describing the object type returned.
The amount in cents to be charged, represented as a whole integer for this specific integer. If empty, the regular Price amount will be used. If the Product has multiple prices, then this amount will be ignored and the selected Price amount will be used.
Whether or not to allow purchases of this variant when stock runs out. If true, the stock levels for this variant can go below zero. If null, inherits from the product.
Whether or not this variant should be auto fulfilled when it is purchased. This can only be true when shipping_enabled is false. If null, inherits from the product.
The max number of activations allowed per license. If null, inherits from the product or price.
The value for the first variant option.
The value for the second variant option.
The value for the third variant option.
The ordering position of this variant when displayed to customers.
The max number of times this variant can be purchased by a customer. If null, inherits from the product.
If set to true checkouts with this variant will require a full shipping address. If null, inherits from the product.
The stock keeping unit for this variant.
Whether or not stock will be tracked for this variant. If null, inherits from the product.
The tax category/code that matches this variant. If null, inherits from the product.
If set to true, this variant is considered taxable. If null, inherits from the product.
The variant weight, meant to be displayable to the customer. If null, inherits from the product.
The weight unit for this variant. If null, inherits from the product.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
The total amount of stock available for purchase. This is the total stock on hand minus held_stock.
Three-letter ISO currency code, in lowercase. This is inherited from the price.
Whether or not this object represents the current version of this variant. (This will be false if the association was created to this variant before it was altered. In this case, we will lookup the version of the variant at the time it was associated.)
The weight of this variant in grams. If null, inherits from the product.
The total amount of stock being held by unfulfilled line items.
Expandable – The associated media ID.
An array of the associated product's variant option names.
Expandable – The associated product ID.
The total amount of stock on hand for this product.
Time at which the object was created. Measured in seconds since the Unix epoch.
Time at which the object was last updated. Measured in seconds since the Unix epoch.