Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Whop Promo Codes API

Discount / promo codes applied at checkout.

Whop Promo Codes API is one of 12 APIs that Whop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Promo Codes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.whop.com/api/v1, https://sandbox-api.whop.com/api/v1.

5 operations 2 paths 2 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.whop.com/api/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Whop Promo Codes API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Whop API key) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication. Use a Company/Account API key or an App API key in the Authorization: Bearer header. OAuth access tokens are used when acting on b…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Promo Codes 5

Discount / promo codes applied at checkout.

GET
/promo_codes
List promo codes
listPromoCodes → 200
POST
/promo_codes
Create a promo code
createPromoCode body → 201
GET
/promo_codes/{id}
Retrieve a promo code
retrievePromoCode 1 param → 200
POST
/promo_codes/{id}
Update a promo code
updatePromoCode 1 param body → 200
DELETE
/promo_codes/{id}
Delete a promo code
deletePromoCode 1 param → 204

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are PromoCode (6 properties), PageInfo (4 properties). Each schema is shown below with its type and property counts.

PromoCode
object
A discount / promo code applied at checkout.
6 properties
PageInfo
object
Cursor pagination metadata.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whop-promo-codes-api-openapi.yml Raw ↑

Other APIs Whop publishes across the network.

Whop GraphQL API
Whop Realtime WebSocket API
Whop Checkout Configurations API
Whop Companies API
Whop Memberships API
Whop Payments API
Whop Plans API
Whop Products API
Whop Transfers API
Whop Users API
Whop Webhooks API