Retrieve Variant
Retrieves a variant. Requires no authentication; fields that need a permission are null for callers without it.
Autorisaties
An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Queryparameters
The currency to state each variant's prices in. Omit it, or send null, for each variant's own currency. auto states them in the currency of the country Whop places the buyer in: by ip_address when your server sends one, and by the request's own IP address otherwise. To choose that country instead, send presentment_country in place of this. A three-letter ISO 4217 code, such as eur, states them in that currency. A variant converts only where a payment quote for it would be priced in that currency, and stays in its own currency otherwise: a renewing variant, one with adaptive pricing off, a currency no payment method can collect, or auto for a buyer Whop cannot place in a country. Converted prices are an estimate at the current exchange rate. Nothing is held: the payment quote the buyer pays from fixes the rate.
"auto"
The country to state each variant's prices for, as an ISO 3166-1 alpha-2 code such as JP, when the buyer chose one: a store's country picker. States them in the currency auto would for a buyer in that country, so send it instead of presentment_currency, never with it. Whether a payment method can collect that currency is still judged where the buyer is: by ip_address, else by the request's own IP address. A country Whop has no currency for is ignored, and the prices are stated as auto would state them.
"JP"
Respons
variant retrieved
Attribute values that distinguish this variant within its product, as a map of attribute name to value, e.g. {"color": "Blue", "size": "Large"}. Names are snake_case identifiers and come back in alphabetical order. Every attributed variant on a product carries the same attribute names and a distinct set of values; the product lists the full option set as variant_attributes. null when the variant has no attributes.
The configuration governing a checkout for this variant, resolved through every layer (the variant's own and the account's) — the shape a session's payment_method_configuration carries. Apply it over the payment method types catalogue for the offerable set. null means platform defaults; payment_method_configuration stays the variant's own editable override.
Total charged at checkout for one unit, before promo codes and tax: initial_price plus the first renewal_price for recurring variants, or initial_price alone while a free trial applies. The trial does not apply when the viewing user has already used one for this variant. Stated in currency.
Custom key-value pairs stored on the variant. Included in webhook payloads for payment and membership events. Maximum 50 keys, 100 characters per key, 500 characters per value. The reserved keys custom_cta and custom_cta_url, when set, override the product's checkout call to action for this variant.
3D Secure behavior for supported on-session card payments. mandate_challenge requires a 3DS challenge before payment processing; mandate_if_required mandates a challenge only when the payment processor requires it; frictionless_if_required uses the regular frictionless 3DS flow. Payments of $1,000 or more use mandate_if_required unless mandate_challenge is selected. Risk and authentication recovery requirements can override the preference. null inherits the account default.
mandate_challenge, mandate_if_required, frictionless_if_required, null "frictionless_if_required"
Number of issued invoices for this variant that are not paid or void. While it is above 0, you can't change the variant's prices, billing period, trial, number of payments, currency or billing type. null unless the actor has the plan:basic:read scope on the variant's account.
0

