View as Markdown
Whop icon

Whop ACTION

Create Promo Code

Creates a new promo code with the given parameters in Whop. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Whop account once, then configure and run Create Promo Code from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "whop-create-promo-code",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    whop: { authProvisionId: "apn_xxxxxxx" },
    amountOff: 10,
    baseCurrency: "Base Currency",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Promo Code inputs
Property Type Description
amountOff Amount Off integer
The amount off (percentage or flat amount) for the Promo Code.
Required
baseCurrency Base Currency string
The monetary currency of the Promo Code.
Required
code Code string
The specific code used to apply the Promo Code at checkout.
Required
expirationDatetime Expiration Datetime integer
The date/time of when the Promo Code expires.
Optional
metadata Metadata object
The metadata that will be attached to the Membership upon successful purchase.
Optional
newUsersOnly New Users Only boolean
Restricts Promo Code use to users who haven't purchased from the company before.
Optional
numberOfIntervals Number Of Intervals integer
The number of billing cycles the Promo Code is applied for. By default, it is applied forever (0).
Optional
planId Plan Ids string[]
The IDs of plans associated with the Promo Code.
Optional Dynamic
promoType Promo Type string
Whether the Promo Code is a percentage or flat amount off.
Required
stock Stock integer
The number of total uses remaining for the Promo Code.
Required
unlimitedStock Unlimited Stock boolean
Whether or not the Promo Code has unlimited uses.
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
whop-create-promo-code
Version
0.0.2
App
Whop
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes