> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve product > Retrieves the details of an existing product. Required permissions: - `access_pass:basic:read` ## OpenAPI ````yaml /openapi/api-v1-stable.json get /products/{id} openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: '2026-08-13' servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: Products name: Products - description: Payments name: Payments - description: Refunds name: Refunds - description: Disputes name: Disputes - description: Dispute alerts name: Dispute alerts - description: Resolution center cases name: Resolution center cases - description: Checkout configurations name: Checkout configurations - description: Setup intents name: Setup intents - description: Payment methods name: Payment methods - description: Invoices name: Invoices - description: Promo codes name: Promo codes - description: Card transactions name: Card transactions - description: Ledger accounts name: Ledger accounts - description: Withdrawals name: Withdrawals - description: Payout methods name: Payout methods - description: Verifications name: Verifications - description: Identity profiles name: Identity profiles - description: Payout accounts name: Payout accounts - description: Topups name: Topups - description: Companies name: Companies - description: Authorized users name: Authorized users - description: Fee markups name: Fee markups - description: Members name: Members - description: Memberships name: Memberships - description: Leads name: Leads - description: Entries name: Entries - description: Shipments name: Shipments - description: Reviews name: Reviews - description: Company token transactions name: Company token transactions - description: Affiliates name: Affiliates - description: Experiences name: Experiences - description: Forums name: Forums - description: Forum posts name: Forum posts - description: Chat channels name: Chat channels - description: Support channels name: Support channels - description: Messages name: Messages - description: Reactions name: Reactions - description: Dm members name: Dm members - description: Dm channels name: Dm channels - description: Notifications name: Notifications - description: Courses name: Courses - description: Course chapters name: Course chapters - description: Course lessons name: Course lessons - description: Course students name: Course students - description: Course lesson interactions name: Course lesson interactions - description: Apps name: Apps - description: Webhooks name: Webhooks - description: App builds name: App builds - description: Access tokens name: Access tokens - description: Account links name: Account links - description: Files name: Files - description: Ai chats name: Ai chats - description: Bounties name: Bounties - description: Stats name: Stats - description: Conversions name: Conversions - description: Ad reports name: Ad reports paths: /products/{id}: get: tags: - Products summary: Retrieve product description: |- Retrieves the details of an existing product. Required permissions: - `access_pass:basic:read` operationId: retrieveProduct parameters: - description: The unique identifier or route slug of the product. in: path name: id required: true schema: example: prod_xxxxxxxxxxxxx type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Product' description: A successful response '400': content: application/json: example: error: code: parameter_missing message: 'Missing required parameter: amount.' param: amount type: invalid_request_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Bad request '401': content: application/json: example: error: message: Invalid or missing API key type: unauthorized schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Unauthorized '403': content: application/json: example: error: message: You do not have permission to access this resource type: forbidden schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Forbidden '404': content: application/json: example: error: message: Resource not found type: not_found schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Not found '422': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Verification required '429': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Too many requests '500': content: application/json: example: error: message: An unexpected error occurred type: internal_server_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Internal server error security: - bearerAuth: - access_pass:basic:read x-codeSamples: - lang: JavaScript source: |- import Whop from '@whop/sdk'; const client = new Whop(); const product = await client.products.retrieve('id'); console.log(product.id); components: schemas: Product: description: >- A product is a digital good or service sold on Whop. Products contain plans for pricing and experiences for content delivery. properties: company: description: The company this product belongs to. properties: id: description: The unique identifier for the company. example: biz_xxxxxxxxxxxxxx type: string route: description: >- URL slug for the account's store page, e.g. `pickaxe` in whop.com/pickaxe. example: pickaxe type: string title: description: The display name of the company shown to customers. example: Pickaxe type: string required: - id - route - title type: object created_at: description: The datetime the product was created. example: '2023-12-01T05:00:00.401Z' format: date-time type: string custom_cta: $ref: '#/components/schemas/CustomCtas' description: Call-to-action button label shown on the product purchase page. custom_cta_url: description: >- An optional URL that the call-to-action button links to instead of the default checkout flow. Null if no custom URL is set. example: https://example.com/signup type: - string - 'null' custom_statement_descriptor: description: >- Custom bank statement descriptor for product purchases. Maximum 22 characters, including required `WHOP*` prefix. example: PICKAXE type: - string - 'null' description: description: >- A brief summary of what the product offers, displayed on product pages and search results. example: Track your revenue, members, and growth in real time. type: - string - 'null' external_identifier: description: >- External identifier for the product. Providing it on a product creation endpoint updates the existing product with this identifier instead of creating a new one. example: ext_prod_12345 type: - string - 'null' gallery_images: description: The gallery images for this product, ordered by position. items: description: Represents an image attachment properties: content_type: description: >- Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg. example: image/jpeg type: - string - 'null' id: description: >- Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. type: string url: description: >- A pre-optimized URL for rendering this attachment on the client. This should be used for displaying attachments in apps. example: https://media.whop.com/abc123/optimized.jpg type: - string - 'null' required: - id - url - content_type type: object type: array global_affiliate_percentage: description: >- Marketplace affiliate commission percentage for this product, or `null` if program is inactive. example: 6.9 type: - number - 'null' global_affiliate_status: $ref: '#/components/schemas/GlobalAffiliateStatuses' description: >- The enrollment status of this product in the Whop marketplace global affiliate program. headline: description: >- A short marketing headline displayed prominently on the product's product page. example: Real-time data analytics for creators type: - string - 'null' id: description: The unique identifier for the product. example: prod_xxxxxxxxxxxxx type: string member_affiliate_percentage: description: >- Member referral commission percentage for this product, or `null` if program is inactive. example: 6.9 type: - number - 'null' member_affiliate_status: $ref: '#/components/schemas/GlobalAffiliateStatuses' description: >- The enrollment status of this product in the member affiliate program. member_count: description: >- Active memberships for this product. Returns `0` if the account has disabled public member counts. example: 42 type: integer metadata: additionalProperties: true description: >- Custom key-value pairs stored on the product and included in payment and membership webhook payloads. Max 50 keys, 100 characters per key, 500 characters per string value. type: - object - 'null' owner_user: description: The user who owns the company that sells this product. properties: id: description: The unique identifier for the user. example: user_xxxxxxxxxxxxx type: string name: description: The user's display name shown on their public profile. example: John Doe type: - string - 'null' username: description: The user's unique username shown on their public profile. example: johndoe42 type: string required: - id - name - username type: object product_tax_code: description: >- The tax classification code applied to purchases of this product for sales tax calculation. Null if no tax code is assigned. properties: id: description: The unique identifier for the product tax code. example: ptc_xxxxxxxxxxxxxx type: string name: description: >- Human-readable name of this tax classification, such as 'Digital - SaaS'. example: Digital - SaaS type: string product_type: $ref: '#/components/schemas/ProductTaxCodeProductTypes' description: >- Broad product category this tax code covers, such as physical goods or digital services. required: - id - name - product_type type: - object - 'null' published_reviews_count: description: >- The total number of published customer reviews for this product's company. example: 42 type: integer route: description: >- URL slug in the product's public link, e.g. `pickaxe-analytics` in whop.com/company/pickaxe-analytics. example: pickaxe-analytics type: string title: description: >- The display name of the product shown to customers on the product page and in search results. example: Pickaxe Analytics type: string updated_at: description: The datetime the product was last updated. example: '2023-12-01T05:00:00.401Z' format: date-time type: string verified: description: >- Whether this company has been verified by Whop's trust and safety team. type: boolean visibility: $ref: '#/components/schemas/Visibility' description: >- Controls whether the product is visible to customers. When set to 'hidden', the product is only accessible via direct link. required: - id - title - visibility - headline - verified - created_at - updated_at - member_count - route - published_reviews_count - external_identifier - metadata - gallery_images - description - custom_cta - custom_cta_url - custom_statement_descriptor - global_affiliate_percentage - global_affiliate_status - member_affiliate_percentage - member_affiliate_status - product_tax_code - owner_user - company type: object CustomCtas: description: The different types of custom CTAs that can be selected. enum: - get_access - join - order_now - shop_now - call_now - donate_now - contact_us - sign_up - subscribe - purchase - get_offer - apply_now - complete_order type: string GlobalAffiliateStatuses: description: The different statuses of the global affiliate program for a product. enum: - enabled - disabled type: string ProductTaxCodeProductTypes: description: The product_type of the ProductTaxCode enum: - physical - digital - services type: string Visibility: description: Visibility of a resource enum: - visible - hidden - archived - quick_link type: string securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with `Bearer`, for example `Bearer ***************************`. scheme: bearer type: http ````