Skip to main content
GET
Retrieve Variant

Autorisations

Authorization
string
header
requis

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.

Scopes

plan:basic:read

En-têtes

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

Variant ID, prefixed plan_.

Paramètres de requête

presentment_currency
string | null

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.

Exemple:

"auto"

ip_address
string | null

The buyer's IP address, when your server reads on their behalf. Needs an API key; any other caller is placed by its own request. Where presentment_currency auto finds the buyer's local currency, and where a payment method must be able to collect it.

Exemple:

"203.0.113.7"

presentment_country
string | null

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.

Exemple:

"JP"

Réponse

variant retrieved

account
object | null
requis

Account that sells this variant; null for standalone invoice variants.

adaptive_pricing_enabled
boolean
requis

Whether adaptive pricing is enabled for this variant. Raw setting — does not check processor compatibility or feature flags.

Exemple:

true

allow_multiple_quantity
boolean
requis

Whether more than one unit can be purchased in an order. Renewal variants cannot enable it. When false, checkouts, carts, and invoices reject a quantity above 1.

Exemple:

false

attributes
object | null
requis

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.

Exemple:
billing_period
number | null
requis

Number of days between recurring charges, such as 30 for monthly or 365 for annual. null for one-time variants.

Exemple:

30

billing_type
enum<string>
requis

Billing model for this variant.

Options disponibles:
renewal,
one_time
Exemple:

"renewal"

cancel_discount_intervals
number | null
requis

How long the cancellation discount lasts: 0 forever, 1 the next payment only, or a number of calendar months from when the customer accepts it. null when none is offered or the actor lacks the plan:basic:read scope.

Exemple:

3

cancel_discount_percentage
number | null
requis

Cancellation discount as a whole-number percentage. null when none is offered or the actor lacks the plan:basic:read scope.

Exemple:

20

checkout_styling
object | null
requis

Variant-level checkout styling (background_color, button_color, font_family, border_style); null inherits the account default.

Exemple:
collect_tax
boolean
requis

Whether tax is collected on purchases of this variant, based on the account's tax configuration.

Exemple:

false

created_at
string
requis

When the variant was created, as an ISO 8601 timestamp.

Exemple:

"2026-01-01T12:00:00.000Z"

currency
string
requis

Three-letter ISO 4217 code of the currency every price on this variant is stated in, lowercase: the variant's own currency, or the presentment_currency the read asked for when the variant can be converted into it.

Exemple:

"usd"

custom_fields
object[]
requis
deletable
boolean | null
requis

Whether the variant can be deleted (it has no memberships or waitlist entries). null unless the actor has the plan:basic:read scope on the variant's account.

Exemple:

true

description
string | null
requis

Customer-visible variant description. Maximum 1000 characters. null if no description is set.

Exemple:

"Two hand washes a month, interior vacuum, and a quarterly sealant top-up."

effective_payment_method_configuration
object | null
requis

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.

expiration_days
number | null
requis

Access duration in days for expiration-based variants, such as 365 for a one-year pass. null for variants without an expiration.

Exemple:

365

formatted_price
string
requis

Human-readable price for display (currency + interval) in currency, e.g. "$10 / month".

Exemple:

"$59.00 / month"

id
string
requis

Variant ID, prefixed plan_.

Exemple:

"plan_xxxxxxxxxxxxxx"

image
object | null
requis

Pricing-tier image (url, blurhash) shown on the product page; null when no image is set.

Exemple:
initial_price
number
requis

Initial purchase price, in currency.

Exemple:

0

initial_price_due
object
requis

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.

internal_notes
string | null
requis

Private notes not shown to customers. null unless the actor has the plan:basic:read scope on the variant's account.

Exemple:

"Maintenance tier. Upsell the interior shampoo add-on at renewal."

invoice
object | null
requis

Invoice this variant was generated for; null unless created for an invoice.

Exemple:

null

member_count
number | null
requis

Active memberships through this variant. null unless the actor has the plan:basic:read scope on the variant's account.

Exemple:

0

metadata
object | null
requis

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.

Exemple:
offer_cancel_discount
boolean | null
requis

Whether a cancellation discount is offered. null unless the actor has the plan:basic:read scope on the variant's account.

Exemple:

true

payment_method_configuration
object | null
requis

Payment method configuration (enabled, disabled, include_platform_defaults); null when variant uses default settings.

Exemple:
product
object | null
requis

Product this variant belongs to; null for standalone variants.

Exemple:
purchase_url
string
requis

URL where customers can purchase this variant directly.

Exemple:

"https://whop.com/checkout/plan_xxxxxxxxxxxxxx"

redirect_url
string | null
requis

Where the customer is sent after paying for this variant. null when none is set, or unless the actor has the plan:basic:read scope on the variant's account.

Exemple:

null

release_method
enum<string>
requis

Sales method for this variant.

Options disponibles:
buy_now,
waitlist
Exemple:

"buy_now"

renewal_price
number
requis

Recurring price charged every billing period, in currency.

Exemple:

59

sku
string | null
requis

Stock keeping unit, free text set by the seller (e.g. TSHIRT-LARGE-BLUE). Not enforced unique. null when unset.

Exemple:

"WASH-CLUB-TEE-LARGE-BLUE"

split_pay_required_payments
number | null
requis

Installment payments required before the subscription pauses. Must be greater than 1. null if split pay is not configured.

Exemple:

4

stock
number | null
requis

Units available for purchase. null unless the actor has the plan:basic:read scope on the variant's account.

Exemple:

0

strike_through_initial_price
number | null
requis

Original initial price shown with a strikethrough, in currency. null when no strikethrough is set.

Exemple:

99

strike_through_renewal_price
number | null
requis

Original renewal price shown with a strikethrough, in currency. null when no strikethrough is set.

Exemple:

79

tax_type
enum<string>
requis

How tax is handled for this variant, including whether tax is included in the price, added at checkout, or not configured.

Options disponibles:
inclusive,
exclusive,
unspecified
Exemple:

"unspecified"

three_ds_level
enum<string> | null
requis

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.

Options disponibles:
mandate_challenge,
mandate_if_required,
frictionless_if_required,
null
Exemple:

"frictionless_if_required"

title
string | null
requis

Variant display name shown to customers. Maximum 30 characters. A variant created without one defaults to its attribute values joined with /. null if no title has been set.

Exemple:

"Unlimited Wash Club"

trial_period_days
number | null
requis

Free trial days before the first renewal charge. null if no trial is configured or the user has already used a trial for this variant.

Exemple:

7

unlimited_stock
boolean
requis

Whether the variant has unlimited stock. When true, the stock field is ignored; waitlist variants always report true.

Exemple:

false

unpaid_invoice_count
integer | null
requis

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.

Exemple:

0

updated_at
string
requis

When the variant was last updated, as an ISO 8601 timestamp.

Exemple:

"2026-01-01T12:00:00.000Z"

visibility
enum<string>
requis

Controls where this variant can be seen. When hidden, the variant is reachable only by its direct link.

Options disponibles:
visible,
hidden,
archived,
quick_link
Exemple:

"visible"