Whop

App · 20 actions

Run your Whop business: create and update products and their prices, make promo codes and checkout links, and read memberships, members and payments.

Actions

ActionWhat it does
Archive promo codeArchive a promo code so no checkout can use it again.
Create checkout linkCreate a checkout page for one variant and get its address ('purchase_url') to send to a buyer.
Create productCreate a product in your business.
Create promo codeCreate a discount code buyers enter at checkout: a percentage or fixed amount off, for any product or only some.
Create variantAdd a price option to a product: a one-time price, or a subscription with a billing period and optional free trial.
Delete checkout linkDelete a checkout link so its address can no longer be used.
Delete productDelete a product.
Delete variantDelete a variant so it stops selling at once.
Get accountGet the Whop business the API key belongs to: its id, name, address on Whop, email, country and status.
Get productGet one product with its settings and variants.
Get variantGet one variant (price option) with its price, billing, stock and checkout address.
List checkout linksList the checkout links made with 'Create checkout link', optionally for one variant.
List membersList the people in your business (customers and admins) with their email, join date and total spent.
List membershipsList memberships (purchases and subscriptions) with their status, price and billing period, filtered by status, product, variant or buyer.
List paymentsList payments with their amounts, status and buyer, filtered by status, reason, product, variant, membership or buyer.
List productsList your business's products, filtered by name, visibility or billing.
List promo codesList your promo codes with their discount, uses and status, optionally for one product or variant.
List variantsList the variants (price options) of your products, optionally for one product.
Update productChange a product's name, headline, description, visibility, labels or metadata.
Update variantChange a variant's price, billing, stock, visibility or details.

Archive promo code

Archive a promo code so no checkout can use it again. It stays in your list with the status archived.

Inputs

Promo codepromo_code_idtextRequired
The promo code. Pick one, or give its id (promo_...) from an earlier step.

Outputs

archivedtrue/false
Always true once archived
promo_code_idtext
The promo code archived
Example output
{
  "archived": true,
  "promo_code_id": "promo_xxxxxxxxxxxx"
}

Create a checkout page for one variant and get its address ('purchase_url') to send to a buyer. Metadata you add is copied to the payment and membership.

Inputs

Variantvariant_idtextRequired
The variant (a product's price option). Pick one, or give its id (plan_...) from an earlier step.
After-purchase addressredirect_urltext
Where the buyer goes after paying, an https:// address.
Affiliate codeaffiliate_codetext
Credit the sale to this affiliate.
Metadatametadataobject
Your own keys and values, copied to the payment and membership (such as an order id).

Outputs

checkout_linkobject
The checkout link
Example output
{
  "checkout_link": {
    "account_id": "biz_xxxxxxxxxxxxxx",
    "affiliate_code": null,
    "created_at": "2026-10-15T09:00:00Z",
    "currency": "usd",
    "id": "ch_xxxxxxxxxxxxxxx",
    "metadata": {
      "source": "lodol"
    },
    "mode": "payment",
    "plan": {
      "billing_period": 30,
      "currency": "usd",
      "id": "plan_xxxxxxxxxxxxx",
      "initial_price": 0,
      "plan_type": "renewal",
      "renewal_price": 10.0,
      "visibility": "visible"
    },
    "purchase_url": "https://whop.com/checkout/plan_xxxxxxxxxxxxx?session=ch_xxx",
    "redirect_url": null,
    "updated_at": "2026-10-15T09:00:00Z"
  }
}

Create product

Create a product in your business. Add a price to it with 'Create variant'.

Inputs

TitletitletextRequired
The product's name, up to 80 characters.
Headlineheadlinetext
A short tagline, up to 80 characters.
Descriptiondescriptiontext
What buyers get, up to 1,500 characters.
Visibilityvisibilitytext
Whether buyers can find it. Hidden products can still be bought through a direct link.One of: visible, hidden, archived, quick_link (Quick link only).
Link nameroutetext
The product's address on Whop, such as pro-course for whop.com/pro-course. Whop picks one when left empty.
Button textcustom_ctatext
The text on the product page's buy button.One of: get_access (Get access), join, order_now (Order now), shop_now (Shop now), call_now (Call now), donate_now (Donate now), contact_us (Contact us), sign_up (Sign up), subscribe, purchase, and 3 more.
Button addresscustom_cta_urltext
Send the buy button to this https:// address instead.
After-purchase addressredirect_purchase_urltext
Where buyers go after paying, an https:// address.
Labelslabelslist
Up to 20 labels to group products by (stored in lowercase).
Metadatametadataobject
Your own keys and values to store on the record.
Collect shipping addresscollect_shipping_addresstrue/false
Ask buyers for a shipping address at checkout.
Send welcome messagesend_welcome_messagetrue/false
Whether buyers get Whop's welcome message. Whop's default is yes.

Outputs

productobject
The product
Example output
{
  "product": {
    "account": {
      "id": "biz_xxxxxxxxxxxxxx",
      "route": "jos-courses",
      "title": "Jo's Courses"
    },
    "created_at": "2026-10-15T09:00:00Z",
    "custom_cta": "get_access",
    "custom_cta_url": null,
    "default_plan": null,
    "description": "Twelve lessons and a community.",
    "external_identifier": null,
    "headline": "Learn to trade",
    "id": "prod_xxxxxxxxxxxxx",
    "labels": [
      "course"
    ],
    "marketplace_status": "not_available",
    "member_count": 0,
    "metadata": {},
    "published_reviews_count": 0,
    "route": "pro-trading-course",
    "title": "Pro Trading Course",
    "updated_at": "2026-10-15T09:00:00Z",
    "variants": [],
    "verified": false,
    "visibility": "visible"
  }
}

Create promo code

Create a discount code buyers enter at checkout: a percentage or fixed amount off, for any product or only some.

Inputs

CodecodetextRequired
What buyers type at checkout: letters, digits, - or _.
Discount typepromo_typetextRequired
A percentage off, or a fixed amount off.One of: percentage (Percentage off), flat_amount (Fixed amount off).
Amount offamount_offnumberRequired
For a percentage, the percent (25 for 25% off). For a fixed amount, the amount in the currency's main unit (5 for $5).At least 0.
Months discountedpromo_duration_monthsnumberRequired
On a subscription, how many months of payments get the discount.At least 0.
Currencybase_currencytext
The currency of a fixed-amount discount. Defaults to USD.One of: usd (US dollar (USD)), eur (Euro (EUR)), gbp (British pound (GBP)), cad (Canadian dollar (CAD)), aud (Australian dollar (AUD)), nzd (New Zealand dollar (NZD)), chf (Swiss franc (CHF)), sek (Swedish krona (SEK)), nok (Norwegian krone (NOK)), dkk (Danish krone (DKK)), and 9 more. Default: usd.
Productproduct_idtext
Only those for this product.
Variant IDsvariant_idslist
Only these variants (plan_...). Leave empty for any.
Expiresexpires_atdate and time
When the code stops working.
Number of usesstocknumber
How many times the code can be used in all.At least 1.
Unlimited usesunlimited_stocktrue/false
Let the code be used any number of times.
New customers onlynew_users_onlytrue/false
Only for buyers who have never bought from you. Defaults to no.
Returning customers onlychurned_users_onlytrue/false
Only for buyers whose earlier membership ended.
Existing members onlyexisting_memberships_onlytrue/false
Only for buyers who already have a membership.
Once per customerone_per_customertrue/false
Each buyer can use the code once.

Outputs

promo_codeobject
The promo code
Example output
{
  "promo_code": {
    "amount_off": 25,
    "churned_users_only": false,
    "code": "SUMMER25",
    "created_at": "2026-10-15T09:00:00Z",
    "currency": "usd",
    "duration": "once",
    "existing_memberships_only": false,
    "expires_at": null,
    "id": "promo_xxxxxxxxxxxx",
    "metadata": {},
    "new_users_only": false,
    "one_per_customer": true,
    "product": {
      "id": "prod_xxxxxxxxxxxxx",
      "title": "Pro Trading Course"
    },
    "promo_duration_months": 1,
    "promo_type": "percentage",
    "status": "active",
    "stock": 100,
    "unlimited_stock": false,
    "updated_at": "2026-10-15T09:00:00Z",
    "uses": 0
  }
}

Create variant

Add a price option to a product: a one-time price, or a subscription with a billing period and optional free trial.

Inputs

Productproduct_idtextRequired
The product. Pick one, or give its id (prod_...) from an earlier step.
Billingplan_typetextRequired
A one-time payment, or a recurring subscription.One of: one_time (One-time payment), renewal (Recurring (renewal)).
Titletitletext
The option's name buyers see, up to 30 characters.
Currencycurrencytext
Three-letter currency code such as usd or eur. Defaults to usd.
Descriptiondescriptiontext
A description buyers see.
Visibilityvisibilitytext
Whether buyers see this price option on the product page.One of: visible, hidden, archived, quick_link (Quick link only).
Sales methodrelease_methodtext
Sell straight away, or collect a waitlist.One of: buy_now (Buy now), waitlist.
Priceinitial_pricenumber
The first (or only) charge, in the currency's main unit: 9.99 is $9.99. 0 makes it free; a paid price is at least 1.00.At least 0.
Renewal pricerenewal_pricenumber
What each renewal charges, for a recurring variant. At least 1.00.At least 0.
Billing every (days)billing_periodnumber
Days between charges: 30 for monthly, 365 for yearly.At least 1.
Access lasts (days)expiration_daysnumber
For a one-time purchase, how many days access lasts.At least 1.
Free trial (days)trial_period_daysnumber
Days of free trial before the first charge.At least 0.
Stockstocknumber
How many can be sold. Leave empty with unlimited stock on.At least 0.
Unlimited stockunlimited_stocktrue/false
Sell without a limit.
Internal notesinternal_notestext
Notes only your team sees.
Metadatametadataobject
Your own keys and values to store on the record.
SKUskutext
Your own stock-keeping code, up to 100 characters.
Tax handlingoverride_tax_typetext
Whether the price includes tax or has tax added.One of: inclusive (Price includes tax), exclusive (Tax added on top), unspecified.

Outputs

variantobject
The variant
Example output
{
  "variant": {
    "billing_period": 30,
    "created_at": "2026-10-15T09:00:00Z",
    "currency": "usd",
    "deletable": true,
    "description": null,
    "expiration_days": null,
    "formatted_price": "$10.00 / month",
    "id": "plan_xxxxxxxxxxxxx",
    "initial_price": 0,
    "internal_notes": null,
    "member_count": 0,
    "metadata": {},
    "plan_type": "renewal",
    "product": {
      "id": "prod_xxxxxxxxxxxxx",
      "title": "Pro Trading Course"
    },
    "purchase_url": "https://whop.com/checkout/plan_xxxxxxxxxxxxx",
    "release_method": "buy_now",
    "renewal_price": 10.0,
    "sku": null,
    "stock": null,
    "tax_type": "unspecified",
    "title": "Monthly",
    "trial_period_days": null,
    "unlimited_stock": true,
    "updated_at": "2026-10-15T09:00:00Z",
    "visibility": "visible"
  }
}

Delete a checkout link so its address can no longer be used.

Inputs

Checkout link IDcheckout_link_idtextRequired
The checkout link's id (ch_...), from 'Create checkout link' or 'List checkout links'.

Outputs

checkout_link_idtext
The checkout link deleted
deletedtrue/false
Always true once deleted
Example output
{
  "checkout_link_id": "ch_xxxxxxxxxxxxxxx",
  "deleted": true
}

Delete product

Delete a product. Only products with no memberships, reviews or invoices can be deleted; hide or archive the others instead.

Inputs

Productproduct_idtextRequired
The product. Pick one, or give its id (prod_...) from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
product_idtext
The product deleted
Example output
{
  "deleted": true,
  "product_id": "prod_xxxxxxxxxxxxx"
}

Delete variant

Delete a variant so it stops selling at once. Existing memberships on it are kept.

Inputs

Variantvariant_idtextRequired
The variant (a product's price option). Pick one, or give its id (plan_...) from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
variant_idtext
The variant deleted
Example output
{
  "deleted": true,
  "variant_id": "plan_xxxxxxxxxxxxx"
}

Get account

Get the Whop business the API key belongs to: its id, name, address on Whop, email, country and status.

Inputs

None.

Outputs

accountobject
The connected account
Example output
{
  "account": {
    "business_name": "Jo's Courses LLC",
    "business_type": "llc",
    "country": "US",
    "created_at": "2026-10-01T09:00:00Z",
    "email": "jo@example.com",
    "id": "biz_xxxxxxxxxxxxxx",
    "owner": {
      "id": "user_xxxxxxxxxxxxx",
      "name": "Jo Bloggs",
      "profile_picture": null,
      "username": "jobloggs"
    },
    "route": "jos-courses",
    "status": "active",
    "title": "Jo's Courses"
  }
}

Get product

Get one product with its settings and variants.

Inputs

Productproduct_idtextRequired
The product. Pick one, or give its id (prod_...) from an earlier step.

Outputs

productobject
The product
Example output
{
  "product": {
    "account": {
      "id": "biz_xxxxxxxxxxxxxx",
      "route": "jos-courses",
      "title": "Jo's Courses"
    },
    "created_at": "2026-10-15T09:00:00Z",
    "custom_cta": "get_access",
    "custom_cta_url": null,
    "default_plan": null,
    "description": "Twelve lessons and a community.",
    "external_identifier": null,
    "headline": "Learn to trade",
    "id": "prod_xxxxxxxxxxxxx",
    "labels": [
      "course"
    ],
    "marketplace_status": "not_available",
    "member_count": 0,
    "metadata": {},
    "published_reviews_count": 0,
    "route": "pro-trading-course",
    "title": "Pro Trading Course",
    "updated_at": "2026-10-15T09:00:00Z",
    "variants": [],
    "verified": false,
    "visibility": "visible"
  }
}

Get variant

Get one variant (price option) with its price, billing, stock and checkout address.

Inputs

Variantvariant_idtextRequired
The variant (a product's price option). Pick one, or give its id (plan_...) from an earlier step.

Outputs

variantobject
The variant
Example output
{
  "variant": {
    "billing_period": 30,
    "created_at": "2026-10-15T09:00:00Z",
    "currency": "usd",
    "deletable": true,
    "description": null,
    "expiration_days": null,
    "formatted_price": "$10.00 / month",
    "id": "plan_xxxxxxxxxxxxx",
    "initial_price": 0,
    "internal_notes": null,
    "member_count": 0,
    "metadata": {},
    "plan_type": "renewal",
    "product": {
      "id": "prod_xxxxxxxxxxxxx",
      "title": "Pro Trading Course"
    },
    "purchase_url": "https://whop.com/checkout/plan_xxxxxxxxxxxxx",
    "release_method": "buy_now",
    "renewal_price": 10.0,
    "sku": null,
    "stock": null,
    "tax_type": "unspecified",
    "title": "Monthly",
    "trial_period_days": null,
    "unlimited_stock": true,
    "updated_at": "2026-10-15T09:00:00Z",
    "visibility": "visible"
  }
}

List the checkout links made with 'Create checkout link', optionally for one variant. Gets one page; to see more, run it again with the next page it gives.

Inputs

Variantvariant_idtext
Only those for this variant (price option).
Created aftercreated_afterdate and time
Only those created after this time.
Created beforecreated_beforedate and time
Only those created before this time.
Orderdirectiontext
Newest or oldest first.One of: desc (Newest first), asc (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. Whop's default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

checkout_linkslist
The checkout links
countnumber
How many on this page
has_next_pagetrue/false
Whether there are more after this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
Example output
{
  "checkout_links": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "affiliate_code": null,
      "created_at": "2026-10-15T09:00:00Z",
      "currency": "usd",
      "id": "ch_xxxxxxxxxxxxxxx",
      "metadata": {
        "source": "lodol"
      },
      "mode": "payment",
      "plan": {
        "billing_period": 30,
        "currency": "usd",
        "id": "plan_xxxxxxxxxxxxx",
        "initial_price": 0,
        "plan_type": "renewal",
        "renewal_price": 10.0,
        "visibility": "visible"
      },
      "purchase_url": "https://whop.com/checkout/plan_xxxxxxxxxxxxx?session=ch_xxx",
      "redirect_url": null,
      "updated_at": "2026-10-15T09:00:00Z"
    }
  ],
  "count": 1,
  "has_next_page": false,
  "next_cursor": ""
}

List members

List the people in your business (customers and admins) with their email, join date and total spent. Search by name, username or exact email. Gets one page; to see more, run it again with the next page it gives.

Inputs

Searchquerytext
A name, username, or an exact email address.
Accessaccess_leveltext
Only customers, only admins, or only people without access.One of: customer, admin, no_access (No access).
Joined or leftstatustext
Only people who are still in, or who have left.One of: joined, left.
Membershipmembership_statustext
Only people with, or without, an active membership.One of: active (Has an active membership), inactive (No active membership).
Productproduct_idtext
Only those for this product.
Variantvariant_idtext
Only those for this variant (price option).
Created aftercreated_afterdate and time
Only those created after this time.
Created beforecreated_beforedate and time
Only those created before this time.
Sort byordertext
What to sort by. Defaults to when they were created.One of: created_at (Created), joined_at (Joined), last_accessed_at (Last active), most_recent_action_at (Latest activity), usd_total_spent (Total spent).
Orderdirectiontext
Newest or oldest first.One of: desc (Newest first), asc (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. Whop's default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
has_next_pagetrue/false
Whether there are more after this page
memberslist
The members
next_cursortext
Pass as 'after' for the next page; empty on the last one
Example output
{
  "count": 1,
  "has_next_page": false,
  "members": [
    {
      "access_level": "customer",
      "account_id": "biz_xxxxxxxxxxxxxx",
      "created_at": "2026-10-15T09:00:00Z",
      "display_name": "Jo Bloggs",
      "email": "jo@example.com",
      "id": "mber_xxxxxxxxxxxxx",
      "joined_at": "2026-10-15T09:00:00Z",
      "last_accessed_at": "2026-10-16T09:00:00Z",
      "most_recent_action": "paid_subscriber",
      "most_recent_action_at": "2026-10-15T09:00:00Z",
      "phone_number": null,
      "status": "joined",
      "usd_total_spent": {
        "amount": "10.00",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "Jo Bloggs",
        "profile_picture": null,
        "username": "jobloggs"
      }
    }
  ],
  "next_cursor": ""
}

List memberships

List memberships (purchases and subscriptions) with their status, price and billing period, filtered by status, product, variant or buyer. Gets one page; to see more, run it again with the next page it gives.

Inputs

Statusstatuseslist
Only memberships in these states.One or more of: active, trialing, past_due (Past due), completed, canceled, expired, canceling (Canceling at period end), paused, expiring (Expiring (one-time, not yet expired)), one_time (One-time, never expires), unclaimed, banned.
Productproduct_idtext
Only those for this product.
Variantvariant_idtext
Only those for this variant (price option).
Member IDmember_idtext
Only those of this member (mber_...), from 'List members'.
Whop user IDwhop_user_idtext
Only those of this Whop user (user_...).
Created aftercreated_afterdate and time
Only those created after this time.
Created beforecreated_beforedate and time
Only those created before this time.
Orderdirectiontext
Newest or oldest first.One of: desc (Newest first), asc (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. Whop's default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
has_next_pagetrue/false
Whether there are more after this page
membershipslist
The memberships
next_cursortext
Pass as 'after' for the next page; empty on the last one
Example output
{
  "count": 1,
  "has_next_page": false,
  "memberships": [
    {
      "billing_period_days": 30,
      "cancel_at_period_end": false,
      "canceled_at": null,
      "created_at": "2026-10-15T09:00:00Z",
      "current_period_end": "2026-11-14T09:00:00Z",
      "current_period_start": "2026-10-15T09:00:00Z",
      "expires_at": null,
      "id": "mem_xxxxxxxxxxxxxx",
      "initial_price": {
        "amount": "10.00",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "license_key": null,
      "manage_url": "https://whop.com/orders/mem_xxxxxxxxxxxxxx",
      "member_id": "mber_xxxxxxxxxxxxx",
      "metadata": {},
      "plan_id": "plan_xxxxxxxxxxxxx",
      "product": {
        "id": "prod_xxxxxxxxxxxxx",
        "title": "Pro Trading Course"
      },
      "product_id": "prod_xxxxxxxxxxxxx",
      "promo_code_id": null,
      "renewal_price": {
        "amount": "10.00",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "status": "active",
      "updated_at": "2026-10-15T09:00:00Z",
      "user_id": "user_xxxxxxxxxxxxx"
    }
  ],
  "next_cursor": ""
}

List payments

List payments with their amounts, status and buyer, filtered by status, reason, product, variant, membership or buyer. Amounts are in the currency's main unit, as text ('10.00'). Gets one page; to see more, run it again with the next page it gives.

Inputs

Statusstatuseslist
Only payments in these states.One or more of: paid, open, pending, authorized, uncollectible, unresolved, void.
Reasonbilling_reasontext
Only payments made for this reason.One of: one_time (One-time purchase), subscription_create (First subscription payment), subscription_cycle (Subscription renewal), subscription_update (Subscription change), subscription, manual.
Currencycurrencytext
Only payments in this currency, such as usd.
Productproduct_idtext
Only those for this product.
Variantvariant_idtext
Only those for this variant (price option).
Membership IDmembership_idtext
Only payments for this membership (mem_...).
Member IDmember_idtext
Only those of this member (mber_...), from 'List members'.
Whop user IDwhop_user_idtext
Only those of this Whop user (user_...).
Searchquerytext
Text to search payments for, such as a buyer's email.
Created aftercreated_afterdate and time
Only those created after this time.
Created beforecreated_beforedate and time
Only those created before this time.
Sort byordertext
What to sort by. Defaults to when they were created.One of: created_at (Created), paid_at (Paid), amount.
Orderdirectiontext
Newest or oldest first.One of: desc (Newest first), asc (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. Whop's default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
has_next_pagetrue/false
Whether there are more after this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
paymentslist
The payments
Example output
{
  "count": 1,
  "has_next_page": false,
  "next_cursor": "",
  "payments": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "billing_reason": "subscription_create",
      "checkout_configuration_id": null,
      "created_at": "2026-10-15T09:00:00Z",
      "currency": "usd",
      "customer_email": "jo@example.com",
      "failure_message": null,
      "id": "pay_xxxxxxxxxxxxxx",
      "member_id": "mber_xxxxxxxxxxxxx",
      "membership_id": "mem_xxxxxxxxxxxxxx",
      "metadata": {},
      "paid_at": "2026-10-15T09:00:00Z",
      "payment_method_type": "card",
      "plan_id": "plan_xxxxxxxxxxxxx",
      "product_id": "prod_xxxxxxxxxxxxx",
      "promo_code_id": null,
      "refunded_amount": {
        "amount": "0.00",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "refunded_at": null,
      "status": "paid",
      "substatus": "succeeded",
      "subtotal": {
        "amount": "10.00",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "tax_amount": {
        "amount": "0.00",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "total": {
        "amount": "10.00",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "updated_at": "2026-10-15T09:00:00Z",
      "usd_total": {
        "amount": "10.00",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "Jo Bloggs",
        "profile_picture": null,
        "username": "jobloggs"
      }
    }
  ]
}

List products

List your business's products, filtered by name, visibility or billing. Gets one page; to see more, run it again with the next page it gives.

Inputs

Searchquerytext
Only products whose name matches this text.
Visibilityvisibilitieslist
Only products with these visibilities.One or more of: visible, hidden, archived, quick_link (Quick link only), not_archived (Not archived), not_quick_link (Not quick link), all.
Billingplan_typeslist
Only products with a variant of these billing types.One or more of: one_time (One-time payment), renewal (Recurring (renewal)).
Created aftercreated_afterdate and time
Only those created after this time.
Created beforecreated_beforedate and time
Only those created before this time.
Orderdirectiontext
Newest or oldest first.One of: desc (Newest first), asc (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. Whop's default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
has_next_pagetrue/false
Whether there are more after this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
productslist
The products
Example output
{
  "count": 1,
  "has_next_page": false,
  "next_cursor": "",
  "products": [
    {
      "account": {
        "id": "biz_xxxxxxxxxxxxxx",
        "route": "jos-courses",
        "title": "Jo's Courses"
      },
      "created_at": "2026-10-15T09:00:00Z",
      "custom_cta": "get_access",
      "custom_cta_url": null,
      "default_plan": null,
      "description": "Twelve lessons and a community.",
      "external_identifier": null,
      "headline": "Learn to trade",
      "id": "prod_xxxxxxxxxxxxx",
      "labels": [
        "course"
      ],
      "marketplace_status": "not_available",
      "member_count": 0,
      "metadata": {},
      "published_reviews_count": 0,
      "route": "pro-trading-course",
      "title": "Pro Trading Course",
      "updated_at": "2026-10-15T09:00:00Z",
      "variants": [],
      "verified": false,
      "visibility": "visible"
    }
  ]
}

List promo codes

List your promo codes with their discount, uses and status, optionally for one product or variant. Gets one page; to see more, run it again with the next page it gives.

Inputs

Statusstatustext
Only codes in this status.One of: active, inactive, archived, expired.
Productproduct_idtext
Only those for this product.
Variantvariant_idtext
Only those for this variant (price option).
Created aftercreated_afterdate and time
Only those created after this time.
Created beforecreated_beforedate and time
Only those created before this time.
Orderdirectiontext
Newest or oldest first.One of: desc (Newest first), asc (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. Whop's default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
has_next_pagetrue/false
Whether there are more after this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
promo_codeslist
The promo codes
Example output
{
  "count": 1,
  "has_next_page": false,
  "next_cursor": "",
  "promo_codes": [
    {
      "amount_off": 25,
      "churned_users_only": false,
      "code": "SUMMER25",
      "created_at": "2026-10-15T09:00:00Z",
      "currency": "usd",
      "duration": "once",
      "existing_memberships_only": false,
      "expires_at": null,
      "id": "promo_xxxxxxxxxxxx",
      "metadata": {},
      "new_users_only": false,
      "one_per_customer": true,
      "product": {
        "id": "prod_xxxxxxxxxxxxx",
        "title": "Pro Trading Course"
      },
      "promo_duration_months": 1,
      "promo_type": "percentage",
      "status": "active",
      "stock": 100,
      "unlimited_stock": false,
      "updated_at": "2026-10-15T09:00:00Z",
      "uses": 0
    }
  ]
}

List variants

List the variants (price options) of your products, optionally for one product. Gets one page; to see more, run it again with the next page it gives.

Inputs

Productproduct_idtext
Only those for this product.
Billingplan_typeslist
Only variants of these billing types.One or more of: one_time (One-time payment), renewal (Recurring (renewal)).
Visibilityvisibilitieslist
Only variants with these visibilities.One or more of: visible, hidden, archived, quick_link (Quick link only).
Created aftercreated_afterdate and time
Only those created after this time.
Created beforecreated_beforedate and time
Only those created before this time.
Sort byordertext
What to sort by. Defaults to when they were created.One of: created_at (Created), active_members_count (Active members), expiration_days (Access length).
Orderdirectiontext
Newest or oldest first.One of: desc (Newest first), asc (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. Whop's default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
has_next_pagetrue/false
Whether there are more after this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
variantslist
The variants
Example output
{
  "count": 1,
  "has_next_page": false,
  "next_cursor": "",
  "variants": [
    {
      "billing_period": 30,
      "created_at": "2026-10-15T09:00:00Z",
      "currency": "usd",
      "deletable": true,
      "description": null,
      "expiration_days": null,
      "formatted_price": "$10.00 / month",
      "id": "plan_xxxxxxxxxxxxx",
      "initial_price": 0,
      "internal_notes": null,
      "member_count": 0,
      "metadata": {},
      "plan_type": "renewal",
      "product": {
        "id": "prod_xxxxxxxxxxxxx",
        "title": "Pro Trading Course"
      },
      "purchase_url": "https://whop.com/checkout/plan_xxxxxxxxxxxxx",
      "release_method": "buy_now",
      "renewal_price": 10.0,
      "sku": null,
      "stock": null,
      "tax_type": "unspecified",
      "title": "Monthly",
      "trial_period_days": null,
      "unlimited_stock": true,
      "updated_at": "2026-10-15T09:00:00Z",
      "visibility": "visible"
    }
  ]
}

Update product

Change a product's name, headline, description, visibility, labels or metadata. Empty fields are left as they are.

Inputs

Productproduct_idtextRequired
The product. Pick one, or give its id (prod_...) from an earlier step.
Titletitletext
A new name, up to 80 characters. Leave empty to keep it.
Headlineheadlinetext
A short tagline, up to 80 characters.
Descriptiondescriptiontext
What buyers get, up to 1,500 characters.
Visibilityvisibilitytext
Whether buyers can find it. Hidden products can still be bought through a direct link.One of: visible, hidden, archived, quick_link (Quick link only).
Labelslabelslist
Replaces all of the product's labels. Leave empty to keep them.
Metadatametadataobject
Your own keys and values to store on the record.
Send welcome messagesend_welcome_messagetrue/false
Whether buyers get Whop's welcome message. Whop's default is yes.

Outputs

productobject
The product
Example output
{
  "product": {
    "account": {
      "id": "biz_xxxxxxxxxxxxxx",
      "route": "jos-courses",
      "title": "Jo's Courses"
    },
    "created_at": "2026-10-15T09:00:00Z",
    "custom_cta": "get_access",
    "custom_cta_url": null,
    "default_plan": null,
    "description": "Twelve lessons and a community.",
    "external_identifier": null,
    "headline": "Learn to trade",
    "id": "prod_xxxxxxxxxxxxx",
    "labels": [
      "course"
    ],
    "marketplace_status": "not_available",
    "member_count": 0,
    "metadata": {},
    "published_reviews_count": 0,
    "route": "pro-trading-course",
    "title": "Pro Trading Course",
    "updated_at": "2026-10-15T09:00:00Z",
    "variants": [],
    "verified": false,
    "visibility": "visible"
  }
}

Update variant

Change a variant's price, billing, stock, visibility or details. Empty fields are left as they are.

Inputs

Variantvariant_idtextRequired
The variant (a product's price option). Pick one, or give its id (plan_...) from an earlier step.
Titletitletext
A new name, up to 30 characters. Leave empty to keep it.
Descriptiondescriptiontext
A description buyers see.
Visibilityvisibilitytext
Whether buyers see this price option on the product page.One of: visible, hidden, archived, quick_link (Quick link only).
Sales methodrelease_methodtext
Sell straight away, or collect a waitlist.One of: buy_now (Buy now), waitlist.
Priceinitial_pricenumber
The first (or only) charge, in the currency's main unit: 9.99 is $9.99. 0 makes it free; a paid price is at least 1.00.At least 0.
Renewal pricerenewal_pricenumber
What each renewal charges, for a recurring variant. At least 1.00.At least 0.
Billing every (days)billing_periodnumber
Days between charges: 30 for monthly, 365 for yearly.At least 1.
Access lasts (days)expiration_daysnumber
For a one-time purchase, how many days access lasts.At least 1.
Free trial (days)trial_period_daysnumber
Days of free trial before the first charge.At least 0.
Stockstocknumber
How many can be sold. Leave empty with unlimited stock on.At least 0.
Unlimited stockunlimited_stocktrue/false
Sell without a limit.
Internal notesinternal_notestext
Notes only your team sees.
Metadatametadataobject
Your own keys and values to store on the record.
SKUskutext
Your own stock-keeping code, up to 100 characters.
Tax handlingoverride_tax_typetext
Whether the price includes tax or has tax added.One of: inclusive (Price includes tax), exclusive (Tax added on top), unspecified.

Outputs

variantobject
The variant
Example output
{
  "variant": {
    "billing_period": 30,
    "created_at": "2026-10-15T09:00:00Z",
    "currency": "usd",
    "deletable": true,
    "description": null,
    "expiration_days": null,
    "formatted_price": "$10.00 / month",
    "id": "plan_xxxxxxxxxxxxx",
    "initial_price": 0,
    "internal_notes": null,
    "member_count": 0,
    "metadata": {},
    "plan_type": "renewal",
    "product": {
      "id": "prod_xxxxxxxxxxxxx",
      "title": "Pro Trading Course"
    },
    "purchase_url": "https://whop.com/checkout/plan_xxxxxxxxxxxxx",
    "release_method": "buy_now",
    "renewal_price": 10.0,
    "sku": null,
    "stock": null,
    "tax_type": "unspecified",
    "title": "Monthly",
    "trial_period_days": null,
    "unlimited_stock": true,
    "updated_at": "2026-10-15T09:00:00Z",
    "visibility": "visible"
  }
}

On this page