GET
/
v2
/
products
/
{id}
curl --request GET \
  --url https://api.whop.com/api/v2/products/{id}
{
  "id": "<string>",
  "name": "<string>",
  "visibility": "visible",
  "created_at": 123,
  "experiences": [
    [
      "<any>"
    ]
  ],
  "plans": [
    [
      "<any>"
    ]
  ]
}

Headers

Authorization
string

Your API key, which can be found on the Whop Business Dashboard. You must prepend your key with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

id
string
required

The ID of the Product, which will look like prod_************* or pass_*************

Query Parameters

expand
enum<string>[]

Whether or not to expand the Experiences and Plans on the returned Product(s). Pass an array with each object(s) you want to expand, e.g. [experiences, plans]

Available options:
experiences,
plans

Response

200 - application/json
id
string

The ID of the Product, which will look like prod_************* or pass_*************

name
string

The name of the Product

visibility
enum<string>

The visibility of the Product

Available options:
visible,
hidden,
archived,
quick_link
created_at
integer

The time at which the Product was created. Measured in seconds since the Unix epoch.

experiences
array

The Experiences that are included in this Product

plans
array

The visible Plans that are included in this Product. Quick links and archived plans will not be included. There is a limit of 10 plans that can be returned for this field.

Was this page helpful?

List ProductsUpdate a Product