List memberships

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 membership of client.memberships.list()) {
  console.log(membership.id);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/memberships",
  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/memberships"

	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/memberships")

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": [
    {
      "cancel_at_period_end": true,
      "cancel_option": "too_expensive",
      "cancelation_status": "won_back",
      "canceled_at": "2023-12-01T05:00:00.401Z",
      "cancellation_reason": "I found a better alternative.",
      "checkout_configuration_id": "ch_xxxxxxxxxxxxxxx",
      "company": {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "Pickaxe"
      },
      "created_at": "2023-12-01T05:00:00.401Z",
      "currency": "usd",
      "formatted_renewal_price": "$25.00 / month",
      "id": "mem_xxxxxxxxxxxxxx",
      "initial_price_paid": "$25.00",
      "joined_at": "2023-12-01T05:00:00.401Z",
      "license_key": "A1B2C3-D4E5F6-G7H8I9",
      "manage_url": "https://whop.com/billing/manage/mem_abc123",
      "member": {
        "id": "mber_xxxxxxxxxxxxx"
      },
      "metadata": {},
      "payment_collection_paused": true,
      "plan": {
        "id": "plan_xxxxxxxxxxxxx",
        "metadata": {}
      },
      "product": {
        "id": "prod_xxxxxxxxxxxxx",
        "metadata": {},
        "title": "Pickaxe Analytics"
      },
      "promo_code": {
        "id": "promo_xxxxxxxxxxxx"
      },
      "renewal_period_end": "2023-12-01T05:00:00.401Z",
      "renewal_period_start": "2023-12-01T05:00:00.401Z",
      "status": "trialing",
      "updated_at": "2023-12-01T05:00:00.401Z",
      "user": {
        "email": "john.doe@example.com",
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "profile_pic": "<string>",
        "username": "johndoe42"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "<string>"
  },
  "total_count": 42
}

{
  "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

memberships

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 membership of client.memberships.list()) {
  console.log(membership.id);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/memberships",
  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/memberships"

	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/memberships")

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": [
    {
      "cancel_at_period_end": true,
      "cancel_option": "too_expensive",
      "cancelation_status": "won_back",
      "canceled_at": "2023-12-01T05:00:00.401Z",
      "cancellation_reason": "I found a better alternative.",
      "checkout_configuration_id": "ch_xxxxxxxxxxxxxxx",
      "company": {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "Pickaxe"
      },
      "created_at": "2023-12-01T05:00:00.401Z",
      "currency": "usd",
      "formatted_renewal_price": "$25.00 / month",
      "id": "mem_xxxxxxxxxxxxxx",
      "initial_price_paid": "$25.00",
      "joined_at": "2023-12-01T05:00:00.401Z",
      "license_key": "A1B2C3-D4E5F6-G7H8I9",
      "manage_url": "https://whop.com/billing/manage/mem_abc123",
      "member": {
        "id": "mber_xxxxxxxxxxxxx"
      },
      "metadata": {},
      "payment_collection_paused": true,
      "plan": {
        "id": "plan_xxxxxxxxxxxxx",
        "metadata": {}
      },
      "product": {
        "id": "prod_xxxxxxxxxxxxx",
        "metadata": {},
        "title": "Pickaxe Analytics"
      },
      "promo_code": {
        "id": "promo_xxxxxxxxxxxx"
      },
      "renewal_period_end": "2023-12-01T05:00:00.401Z",
      "renewal_period_start": "2023-12-01T05:00:00.401Z",
      "status": "trialing",
      "updated_at": "2023-12-01T05:00:00.401Z",
      "user": {
        "email": "john.doe@example.com",
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "profile_pic": "<string>",
        "username": "johndoe42"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "<string>"
  },
  "total_count": 42
}

{
  "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

The unique identifier of the company to list memberships for. Required when using an API key.

Example:

"biz_xxxxxxxxxxxxxx"

direction

enum<string>

The sort direction for results. Defaults to descending.

Available options:

asc,

desc

order

enum<string>

The field to sort results by. Null uses the default sort order.

Available options:

id,

created_at,

status,

canceled_at,

date_joined,

total_spend

product_ids

string[]

Filter to only memberships belonging 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.

statuses

enum<string>[]

Filter to only memberships matching these statuses.

The status of a membership

Available options:

trialing,

active,

past_due,

completed,

canceled,

expired,

unresolved,

drafted,

canceling

cancel_options

enum<string>[]

Filter to only memberships matching these cancellation reasons.

The different reasons a user can choose for why they are canceling their membership.

Available options:

too_expensive,

switching,

missing_features,

technical_issues,

bad_experience,

other,

testing

cancelation_status

enum<string>

Filter memberships by whether the customer is canceling, left, or was won back.

Available options:

won_back,

left,

canceling

has_cancelation_reason

boolean

Filter memberships by whether they have a structured or free-text cancellation reason.

include_text_only_cancelation_reasons

boolean

When filtering by the other cancellation option, also include memberships that only have a free-text cancellation reason.

plan_ids

string[]

Filter to only memberships belonging to these plan identifiers.

user_ids

string[]

Filter to only memberships belonging to these user identifiers.

Filter to only memberships that used these promo code identifiers.

created_before

string<date-time>

Only return memberships created before this timestamp.

Example:

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

created_after

string<date-time>

Only return memberships created after this timestamp.

Example:

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

Response

A successful response

The connection type for PublicMembership.

data

object[]

required

A list of nodes.

Show child attributes

page_info

object

required

Information to aid in pagination.

Show child attributes

total_count

integer

required

The total number of items in this connection.

Example:

42

⌘I

Introduction

Ledger stats

Developer

Ads

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Stats

Authorizations

Query Parameters

Response