Replaces the Legacy Products resource.
Existing Legacy integrations keep working; see API
versions for the stability contract.
Endpoints
Attributes
Average star rating across published reviews for this product, from
1.0 to
5.0. Returns 0.0 when no published-review rating is available.Call-to-action button label shown on the product purchase page.Available options:
get_access, join, order_now, shop_now, call_now, donate_now, contact_us, sign_up, subscribe, purchase, get_offer, apply_now, complete_orderBuyable variant to show and check out with. The configured default when that variant is buyable, otherwise the first buyable variant in product-page order.
null when none is buyable.Properties
Properties
Number of days between recurring charges, such as 30 for monthly or 365 for
annual.
null for one-time variants.Billing model for this variant:
one_time or renewal.Available options: renewal, one_timeAccess duration in days for expiration-based variants.
null for variants
without an expiration.What checkout charges up front.
amount is "0.00" when the first charge is free, such as a trial.Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
The recurring charge every
billing_period days. amount is "0.00" for one-time variants.Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
Free trial days before the first renewal charge.
null if no trial is
configured or the signed-in user has already used a trial on this variant.Experiences the product includes, such as courses, chats and apps, oldest first. Holds the first 100; page the rest through
GET /experiences?product_id=.Properties
Properties
Logo image URL uploaded for this experience.
null when it has none; show the
app’s icon instead.Enrollment status in the global affiliate program.Available options:
enabled, disabledLowercased labels used to group products into collections. Filter the list
endpoint by
labels to fetch one collection.Logo image URL shown on product pages and in search results.
null when the
product has no logo.Listing state on the whop.com marketplace.
pending_review means submitted and awaiting review; live_marketplace means approved and discoverable.Available options: not_available, pending_review, live_marketplaceEnrollment status in the member affiliate program.Available options:
enabled, disabledThe option set the product’s variants span, as a map of attribute name to the values in use, e.g.
\{"color": ["Blue", "Red"], "size": ["S", "M", "L"]}. Derived from the visible, non-invoice variants that carry attributes: keys alphabetical, values in the order the variants were created. Read-only. null when the product has no variants.The product’s variants whose
visibility is visible and that were not generated for an invoice, in creation order. Plain pricing options are included with attributes: null. Hidden, archived, quick-link, and invoice variants stay reachable through GET /variants. null when the product has more than 1000 variants (page them through GET /variants?product_ids=) and in webhook payloads.Properties
Properties
Whether adaptive pricing is enabled for this variant. Raw setting — does not
check processor compatibility or feature flags.
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.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.Number of days between recurring charges, such as 30 for monthly or 365 for
annual.
null for one-time variants.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.Cancellation discount as a whole-number percentage.
null when none is
offered or the actor lacks the plan:basic:read scope.Variant-level checkout styling (
background_color, button_color,
font_family, border_style); null inherits the account default.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.Custom input fields collected on the checkout form.
Properties
Properties
Customer-visible variant description. Maximum 1000 characters.
null if no
description is set.Access duration in days for expiration-based variants, such as 365 for a
one-year pass.
null for variants without an expiration.Human-readable price for display (currency + interval) in
currency, e.g.
“$10 / month”.Pricing-tier image (
url, blurhash) shown on the product page; null when
no image is set.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.Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
Private notes not shown to customers.
null unless the actor has the
plan:basic:read scope on the variant’s account.Active memberships through this variant.
null unless the actor has the
plan:basic:read scope on the variant’s account.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.Whether a cancellation discount is offered.
null unless the actor has the
plan:basic:read scope on the variant’s account.Payment method configuration (
enabled, disabled,
include_platform_defaults); null when variant uses default settings.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.Stock keeping unit, free text set by the seller (e.g.
TSHIRT-LARGE-BLUE).
Not enforced unique. null when unset.Installment payments required before the subscription pauses. Must be greater
than 1.
null if split pay is not configured.Units available for purchase.
null unless the actor has the
plan:basic:read scope on the variant’s account.Original initial price shown with a strikethrough, in
currency. null when
no strikethrough is set.Original renewal price shown with a strikethrough, in
currency. null when
no strikethrough is set.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.Available options: mandate_challenge, mandate_if_required, frictionless_if_requiredVariant 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.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.Whether the variant has unlimited stock. When
true, the stock field is
ignored; waitlist variants always report true.Product

