List promo codes

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const promoCodeListResponse of client.promoCodes.list({ account_id: 'account_id' })) {
  console.log(promoCodeListResponse.id);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/promo_codes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/promo_codes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/promo_codes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "amount_off": 6.9,
      "churned_users_only": true,
      "code": "<string>",
      "created_at": "2023-12-01T05:00:00.401Z",
      "currency": "usd",
      "duration": "forever",
      "existing_memberships_only": true,
      "expires_at": "2023-12-01T05:00:00.401Z",
      "id": "promo_xxxxxxxxxxxx",
      "new_users_only": true,
      "one_per_customer": true,
      "product": {
        "id": "prod_xxxxxxxxxxxxx",
        "title": "Pickaxe Analytics"
      },
      "promo_duration_months": 42,
      "promo_type": "percentage",
      "status": "active",
      "stock": 42,
      "unlimited_stock": true,
      "uses": 42
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

{
  "error": {
    "code": "parameter_missing",
    "message": "Missing required parameter: amount.",
    "param": "amount",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "message": "Invalid or missing API key",
    "type": "unauthorized"
  }
}

{
  "error": {
    "message": "You do not have permission to access this resource",
    "type": "forbidden"
  }
}

{
  "error": {
    "message": "Resource not found",
    "type": "not_found"
  }
}

{
  "error": null
}

{
  "error": null
}

{
  "error": {
    "message": "An unexpected error occurred",
    "type": "internal_server_error"
  }
}

GET

promo_codes

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const promoCodeListResponse of client.promoCodes.list({ account_id: 'account_id' })) {
  console.log(promoCodeListResponse.id);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/promo_codes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/promo_codes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/promo_codes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "amount_off": 6.9,
      "churned_users_only": true,
      "code": "<string>",
      "created_at": "2023-12-01T05:00:00.401Z",
      "currency": "usd",
      "duration": "forever",
      "existing_memberships_only": true,
      "expires_at": "2023-12-01T05:00:00.401Z",
      "id": "promo_xxxxxxxxxxxx",
      "new_users_only": true,
      "one_per_customer": true,
      "product": {
        "id": "prod_xxxxxxxxxxxxx",
        "title": "Pickaxe Analytics"
      },
      "promo_duration_months": 42,
      "promo_type": "percentage",
      "status": "active",
      "stock": 42,
      "unlimited_stock": true,
      "uses": 42
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

{
  "error": {
    "code": "parameter_missing",
    "message": "Missing required parameter: amount.",
    "param": "amount",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "message": "Invalid or missing API key",
    "type": "unauthorized"
  }
}

{
  "error": {
    "message": "You do not have permission to access this resource",
    "type": "forbidden"
  }
}

{
  "error": {
    "message": "Resource not found",
    "type": "not_found"
  }
}

{
  "error": null
}

{
  "error": null
}

{
  "error": {
    "message": "An unexpected error occurred",
    "type": "internal_server_error"
  }
}

Authorizations

Authorization

string

header

required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Query Parameters

after

string

Returns the elements in the list that come after the specified cursor.

before

string

Returns the elements in the list that come before the specified cursor.

first

integer

Returns the first n elements from the list.

Example:

42

last

integer

Returns the last n elements from the list.

Example:

42

company_id

string

required

The unique identifier of the company to list promo codes for.

Example:

"biz_xxxxxxxxxxxxxx"

product_ids

string[]

Filter to only promo codes scoped to these product identifiers.

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.

plan_ids

string[]

Filter to only promo codes scoped to these plan identifiers.

status

enum<string>

Filter to only promo codes matching this status.

Available options:

active,

inactive,

archived

created_before

string<date-time>

Only return promo codes created before this timestamp.

Example:

"2023-12-01T05:00:00.401Z"

created_after

string<date-time>

Only return promo codes created after this timestamp.

Example:

"2023-12-01T05:00:00.401Z"

Response

A successful response

The connection type for PromoCode.

data

object[]

required

A list of nodes.

Show child attributes

page_info

object

required

Information to aid in pagination.

Show child attributes

⌘I

Introduction

Ledger stats

Developer

Ads

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Stats

Authorizations

Query Parameters

Response