Create Plan

JavaScript

import Whop from '@whop/sdk';

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

const plan = await client.plans.create();

console.log(plan.id);

curl --request POST \
  --url https://api.whop.com/api/v1/plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "<string>",
  "adaptive_pricing_enabled": true,
  "billing_period": 123,
  "checkout_styling": {},
  "currency": "<string>",
  "custom_fields": [
    {
      "field_type": "text",
      "id": "<string>",
      "name": "<string>",
      "order": 123,
      "placeholder": "<string>",
      "required": true
    }
  ],
  "description": "<string>",
  "expiration_days": 123,
  "image": {
    "direct_upload_id": "<string>",
    "id": "<string>"
  },
  "initial_price": 123,
  "internal_notes": "<string>",
  "legacy_payment_method_controls": true,
  "metadata": {},
  "override_tax_type": "<string>",
  "payment_method_configuration": {
    "disabled": [
      "<string>"
    ],
    "enabled": [
      "<string>"
    ],
    "include_platform_defaults": true
  },
  "plan_type": "<string>",
  "product_id": "<string>",
  "release_method": "<string>",
  "renewal_price": 123,
  "split_pay_required_payments": 123,
  "stock": 123,
  "title": "<string>",
  "trial_period_days": 123,
  "unlimited_stock": true,
  "visibility": "<string>"
}
'

import requests

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

payload = {
    "account_id": "<string>",
    "adaptive_pricing_enabled": True,
    "billing_period": 123,
    "checkout_styling": {},
    "currency": "<string>",
    "custom_fields": [
        {
            "field_type": "text",
            "id": "<string>",
            "name": "<string>",
            "order": 123,
            "placeholder": "<string>",
            "required": True
        }
    ],
    "description": "<string>",
    "expiration_days": 123,
    "image": {
        "direct_upload_id": "<string>",
        "id": "<string>"
    },
    "initial_price": 123,
    "internal_notes": "<string>",
    "legacy_payment_method_controls": True,
    "metadata": {},
    "override_tax_type": "<string>",
    "payment_method_configuration": {
        "disabled": ["<string>"],
        "enabled": ["<string>"],
        "include_platform_defaults": True
    },
    "plan_type": "<string>",
    "product_id": "<string>",
    "release_method": "<string>",
    "renewal_price": 123,
    "split_pay_required_payments": 123,
    "stock": 123,
    "title": "<string>",
    "trial_period_days": 123,
    "unlimited_stock": True,
    "visibility": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/plans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => '<string>',
    'adaptive_pricing_enabled' => true,
    'billing_period' => 123,
    'checkout_styling' => [
        
    ],
    'currency' => '<string>',
    'custom_fields' => [
        [
                'field_type' => 'text',
                'id' => '<string>',
                'name' => '<string>',
                'order' => 123,
                'placeholder' => '<string>',
                'required' => true
        ]
    ],
    'description' => '<string>',
    'expiration_days' => 123,
    'image' => [
        'direct_upload_id' => '<string>',
        'id' => '<string>'
    ],
    'initial_price' => 123,
    'internal_notes' => '<string>',
    'legacy_payment_method_controls' => true,
    'metadata' => [
        
    ],
    'override_tax_type' => '<string>',
    'payment_method_configuration' => [
        'disabled' => [
                '<string>'
        ],
        'enabled' => [
                '<string>'
        ],
        'include_platform_defaults' => true
    ],
    'plan_type' => '<string>',
    'product_id' => '<string>',
    'release_method' => '<string>',
    'renewal_price' => 123,
    'split_pay_required_payments' => 123,
    'stock' => 123,
    'title' => '<string>',
    'trial_period_days' => 123,
    'unlimited_stock' => true,
    'visibility' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"account_id\": \"<string>\",\n  \"adaptive_pricing_enabled\": true,\n  \"billing_period\": 123,\n  \"checkout_styling\": {},\n  \"currency\": \"<string>\",\n  \"custom_fields\": [\n    {\n      \"field_type\": \"text\",\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"order\": 123,\n      \"placeholder\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"description\": \"<string>\",\n  \"expiration_days\": 123,\n  \"image\": {\n    \"direct_upload_id\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"initial_price\": 123,\n  \"internal_notes\": \"<string>\",\n  \"legacy_payment_method_controls\": true,\n  \"metadata\": {},\n  \"override_tax_type\": \"<string>\",\n  \"payment_method_configuration\": {\n    \"disabled\": [\n      \"<string>\"\n    ],\n    \"enabled\": [\n      \"<string>\"\n    ],\n    \"include_platform_defaults\": true\n  },\n  \"plan_type\": \"<string>\",\n  \"product_id\": \"<string>\",\n  \"release_method\": \"<string>\",\n  \"renewal_price\": 123,\n  \"split_pay_required_payments\": 123,\n  \"stock\": 123,\n  \"title\": \"<string>\",\n  \"trial_period_days\": 123,\n  \"unlimited_stock\": true,\n  \"visibility\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.whop.com/api/v1/plans")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"<string>\",\n  \"adaptive_pricing_enabled\": true,\n  \"billing_period\": 123,\n  \"checkout_styling\": {},\n  \"currency\": \"<string>\",\n  \"custom_fields\": [\n    {\n      \"field_type\": \"text\",\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"order\": 123,\n      \"placeholder\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"description\": \"<string>\",\n  \"expiration_days\": 123,\n  \"image\": {\n    \"direct_upload_id\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"initial_price\": 123,\n  \"internal_notes\": \"<string>\",\n  \"legacy_payment_method_controls\": true,\n  \"metadata\": {},\n  \"override_tax_type\": \"<string>\",\n  \"payment_method_configuration\": {\n    \"disabled\": [\n      \"<string>\"\n    ],\n    \"enabled\": [\n      \"<string>\"\n    ],\n    \"include_platform_defaults\": true\n  },\n  \"plan_type\": \"<string>\",\n  \"product_id\": \"<string>\",\n  \"release_method\": \"<string>\",\n  \"renewal_price\": 123,\n  \"split_pay_required_payments\": 123,\n  \"stock\": 123,\n  \"title\": \"<string>\",\n  \"trial_period_days\": 123,\n  \"unlimited_stock\": true,\n  \"visibility\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"<string>\",\n  \"adaptive_pricing_enabled\": true,\n  \"billing_period\": 123,\n  \"checkout_styling\": {},\n  \"currency\": \"<string>\",\n  \"custom_fields\": [\n    {\n      \"field_type\": \"text\",\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"order\": 123,\n      \"placeholder\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"description\": \"<string>\",\n  \"expiration_days\": 123,\n  \"image\": {\n    \"direct_upload_id\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"initial_price\": 123,\n  \"internal_notes\": \"<string>\",\n  \"legacy_payment_method_controls\": true,\n  \"metadata\": {},\n  \"override_tax_type\": \"<string>\",\n  \"payment_method_configuration\": {\n    \"disabled\": [\n      \"<string>\"\n    ],\n    \"enabled\": [\n      \"<string>\"\n    ],\n    \"include_platform_defaults\": true\n  },\n  \"plan_type\": \"<string>\",\n  \"product_id\": \"<string>\",\n  \"release_method\": \"<string>\",\n  \"renewal_price\": 123,\n  \"split_pay_required_payments\": 123,\n  \"stock\": 123,\n  \"title\": \"<string>\",\n  \"trial_period_days\": 123,\n  \"unlimited_stock\": true,\n  \"visibility\": \"<string>\"\n}"

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

{
  "account": {},
  "adaptive_pricing_enabled": true,
  "billing_period": 123,
  "collect_tax": true,
  "created_at": "<string>",
  "currency": "usd",
  "custom_fields": [
    {
      "field_type": "text",
      "id": "<string>",
      "name": "<string>",
      "order": 123,
      "placeholder": "<string>",
      "required": true
    }
  ],
  "description": "<string>",
  "expiration_days": 123,
  "id": "<string>",
  "initial_price": 123,
  "internal_notes": "<string>",
  "invoice": {},
  "member_count": 123,
  "metadata": {},
  "payment_method_configuration": {},
  "plan_type": "renewal",
  "product": {},
  "purchase_url": "<string>",
  "release_method": "buy_now",
  "renewal_price": 123,
  "split_pay_required_payments": 123,
  "stock": 123,
  "tax_type": "inclusive",
  "three_ds_level": "mandate_challenge",
  "title": "<string>",
  "trial_period_days": 123,
  "unlimited_stock": true,
  "updated_at": "<string>",
  "visibility": "visible"
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

POST

plans

JavaScript

import Whop from '@whop/sdk';

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

const plan = await client.plans.create();

console.log(plan.id);

curl --request POST \
  --url https://api.whop.com/api/v1/plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "<string>",
  "adaptive_pricing_enabled": true,
  "billing_period": 123,
  "checkout_styling": {},
  "currency": "<string>",
  "custom_fields": [
    {
      "field_type": "text",
      "id": "<string>",
      "name": "<string>",
      "order": 123,
      "placeholder": "<string>",
      "required": true
    }
  ],
  "description": "<string>",
  "expiration_days": 123,
  "image": {
    "direct_upload_id": "<string>",
    "id": "<string>"
  },
  "initial_price": 123,
  "internal_notes": "<string>",
  "legacy_payment_method_controls": true,
  "metadata": {},
  "override_tax_type": "<string>",
  "payment_method_configuration": {
    "disabled": [
      "<string>"
    ],
    "enabled": [
      "<string>"
    ],
    "include_platform_defaults": true
  },
  "plan_type": "<string>",
  "product_id": "<string>",
  "release_method": "<string>",
  "renewal_price": 123,
  "split_pay_required_payments": 123,
  "stock": 123,
  "title": "<string>",
  "trial_period_days": 123,
  "unlimited_stock": true,
  "visibility": "<string>"
}
'

import requests

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

payload = {
    "account_id": "<string>",
    "adaptive_pricing_enabled": True,
    "billing_period": 123,
    "checkout_styling": {},
    "currency": "<string>",
    "custom_fields": [
        {
            "field_type": "text",
            "id": "<string>",
            "name": "<string>",
            "order": 123,
            "placeholder": "<string>",
            "required": True
        }
    ],
    "description": "<string>",
    "expiration_days": 123,
    "image": {
        "direct_upload_id": "<string>",
        "id": "<string>"
    },
    "initial_price": 123,
    "internal_notes": "<string>",
    "legacy_payment_method_controls": True,
    "metadata": {},
    "override_tax_type": "<string>",
    "payment_method_configuration": {
        "disabled": ["<string>"],
        "enabled": ["<string>"],
        "include_platform_defaults": True
    },
    "plan_type": "<string>",
    "product_id": "<string>",
    "release_method": "<string>",
    "renewal_price": 123,
    "split_pay_required_payments": 123,
    "stock": 123,
    "title": "<string>",
    "trial_period_days": 123,
    "unlimited_stock": True,
    "visibility": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/plans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => '<string>',
    'adaptive_pricing_enabled' => true,
    'billing_period' => 123,
    'checkout_styling' => [
        
    ],
    'currency' => '<string>',
    'custom_fields' => [
        [
                'field_type' => 'text',
                'id' => '<string>',
                'name' => '<string>',
                'order' => 123,
                'placeholder' => '<string>',
                'required' => true
        ]
    ],
    'description' => '<string>',
    'expiration_days' => 123,
    'image' => [
        'direct_upload_id' => '<string>',
        'id' => '<string>'
    ],
    'initial_price' => 123,
    'internal_notes' => '<string>',
    'legacy_payment_method_controls' => true,
    'metadata' => [
        
    ],
    'override_tax_type' => '<string>',
    'payment_method_configuration' => [
        'disabled' => [
                '<string>'
        ],
        'enabled' => [
                '<string>'
        ],
        'include_platform_defaults' => true
    ],
    'plan_type' => '<string>',
    'product_id' => '<string>',
    'release_method' => '<string>',
    'renewal_price' => 123,
    'split_pay_required_payments' => 123,
    'stock' => 123,
    'title' => '<string>',
    'trial_period_days' => 123,
    'unlimited_stock' => true,
    'visibility' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"account_id\": \"<string>\",\n  \"adaptive_pricing_enabled\": true,\n  \"billing_period\": 123,\n  \"checkout_styling\": {},\n  \"currency\": \"<string>\",\n  \"custom_fields\": [\n    {\n      \"field_type\": \"text\",\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"order\": 123,\n      \"placeholder\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"description\": \"<string>\",\n  \"expiration_days\": 123,\n  \"image\": {\n    \"direct_upload_id\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"initial_price\": 123,\n  \"internal_notes\": \"<string>\",\n  \"legacy_payment_method_controls\": true,\n  \"metadata\": {},\n  \"override_tax_type\": \"<string>\",\n  \"payment_method_configuration\": {\n    \"disabled\": [\n      \"<string>\"\n    ],\n    \"enabled\": [\n      \"<string>\"\n    ],\n    \"include_platform_defaults\": true\n  },\n  \"plan_type\": \"<string>\",\n  \"product_id\": \"<string>\",\n  \"release_method\": \"<string>\",\n  \"renewal_price\": 123,\n  \"split_pay_required_payments\": 123,\n  \"stock\": 123,\n  \"title\": \"<string>\",\n  \"trial_period_days\": 123,\n  \"unlimited_stock\": true,\n  \"visibility\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.whop.com/api/v1/plans")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"<string>\",\n  \"adaptive_pricing_enabled\": true,\n  \"billing_period\": 123,\n  \"checkout_styling\": {},\n  \"currency\": \"<string>\",\n  \"custom_fields\": [\n    {\n      \"field_type\": \"text\",\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"order\": 123,\n      \"placeholder\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"description\": \"<string>\",\n  \"expiration_days\": 123,\n  \"image\": {\n    \"direct_upload_id\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"initial_price\": 123,\n  \"internal_notes\": \"<string>\",\n  \"legacy_payment_method_controls\": true,\n  \"metadata\": {},\n  \"override_tax_type\": \"<string>\",\n  \"payment_method_configuration\": {\n    \"disabled\": [\n      \"<string>\"\n    ],\n    \"enabled\": [\n      \"<string>\"\n    ],\n    \"include_platform_defaults\": true\n  },\n  \"plan_type\": \"<string>\",\n  \"product_id\": \"<string>\",\n  \"release_method\": \"<string>\",\n  \"renewal_price\": 123,\n  \"split_pay_required_payments\": 123,\n  \"stock\": 123,\n  \"title\": \"<string>\",\n  \"trial_period_days\": 123,\n  \"unlimited_stock\": true,\n  \"visibility\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"<string>\",\n  \"adaptive_pricing_enabled\": true,\n  \"billing_period\": 123,\n  \"checkout_styling\": {},\n  \"currency\": \"<string>\",\n  \"custom_fields\": [\n    {\n      \"field_type\": \"text\",\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"order\": 123,\n      \"placeholder\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"description\": \"<string>\",\n  \"expiration_days\": 123,\n  \"image\": {\n    \"direct_upload_id\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"initial_price\": 123,\n  \"internal_notes\": \"<string>\",\n  \"legacy_payment_method_controls\": true,\n  \"metadata\": {},\n  \"override_tax_type\": \"<string>\",\n  \"payment_method_configuration\": {\n    \"disabled\": [\n      \"<string>\"\n    ],\n    \"enabled\": [\n      \"<string>\"\n    ],\n    \"include_platform_defaults\": true\n  },\n  \"plan_type\": \"<string>\",\n  \"product_id\": \"<string>\",\n  \"release_method\": \"<string>\",\n  \"renewal_price\": 123,\n  \"split_pay_required_payments\": 123,\n  \"stock\": 123,\n  \"title\": \"<string>\",\n  \"trial_period_days\": 123,\n  \"unlimited_stock\": true,\n  \"visibility\": \"<string>\"\n}"

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

{
  "account": {},
  "adaptive_pricing_enabled": true,
  "billing_period": 123,
  "collect_tax": true,
  "created_at": "<string>",
  "currency": "usd",
  "custom_fields": [
    {
      "field_type": "text",
      "id": "<string>",
      "name": "<string>",
      "order": 123,
      "placeholder": "<string>",
      "required": true
    }
  ],
  "description": "<string>",
  "expiration_days": 123,
  "id": "<string>",
  "initial_price": 123,
  "internal_notes": "<string>",
  "invoice": {},
  "member_count": 123,
  "metadata": {},
  "payment_method_configuration": {},
  "plan_type": "renewal",
  "product": {},
  "purchase_url": "<string>",
  "release_method": "buy_now",
  "renewal_price": 123,
  "split_pay_required_payments": 123,
  "stock": 123,
  "tax_type": "inclusive",
  "three_ds_level": "mandate_challenge",
  "title": "<string>",
  "trial_period_days": 123,
  "unlimited_stock": true,
  "updated_at": "<string>",
  "visibility": "visible"
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Idempotency-Key

string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255

Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-07-20"

Body

application/json

account_id

string

The unique identifier of the account to create this plan for. Defaults to the caller's account.

adaptive_pricing_enabled

boolean | null

Whether this plan accepts local currency payments via adaptive pricing.

billing_period

integer | null

Recurring billing interval in days, such as 30 for monthly or 365 for annual.

checkout_styling

object | null

Checkout styling overrides for this plan.

currency

string

The three-letter ISO currency code for the plan's pricing. Defaults to USD.

custom_fields

object[] | null

An array of custom field definitions to collect from customers at checkout. Omitting this field clears existing custom fields.

Show child attributes

description

string | null

A text description of the plan displayed to customers on the product page.

expiration_days

integer | null

Access duration in days before the membership expires.

image

object | null

An image displayed on the product page to represent this plan.

Show child attributes

initial_price

number | null

Initial amount charged in the plan's currency, e.g. 10.43 for $10.43.

internal_notes

string | null

Private notes visible only to the account owner. Not shown to customers.

legacy_payment_method_controls

boolean | null

Whether this plan uses legacy payment method controls.

metadata

object | null

Custom key-value pairs to store on the plan. Included in webhook payloads for payment and membership events. Max 50 keys, 100 chars per key, 500 chars per string value.

override_tax_type

string

Override the default tax classification for this specific plan.

payment_method_configuration

object | null

Explicit payment method configuration for the plan. When not provided, the account's defaults apply.

Show child attributes

plan_type

string

Plan billing type, such as one_time or renewal.

product_id

string

The unique identifier of the product to attach this plan to.

release_method

string

Sales method for this plan, such as buy_now or waitlist.

renewal_price

number | null

The amount charged each billing period for recurring plans, in the plan's currency.

split_pay_required_payments

integer | null

Installment payments required before the subscription pauses.

stock

integer | null

The maximum number of units available for purchase. Ignored when unlimited_stock is true.

three_ds_level

enum<string>

3D Secure behavior for this plan. Send null to inherit the account default.

Available options:

mandate_challenge,

frictionless

title

string | null

The display name of the plan shown to customers on the product page.

trial_period_days

integer | null

Free trial duration before the first recurring charge.

unlimited_stock

boolean | null

Whether the plan has unlimited stock. When true, the stock field is ignored.

visibility

string

Whether the plan is visible to customers or hidden from public view.

Response

plan created

account

object | null

required

Account that sells this plan; null for standalone invoice plans.

adaptive_pricing_enabled

boolean

required

Whether this plan accepts local currency payments via adaptive pricing.

billing_period

number | null

required

Recurring billing interval in days, such as 30 for monthly or 365 for annual. null for one-time plans.

collect_tax

boolean

required

Whether tax is collected on purchases of this plan.

created_at

string

required

When the plan was created, as an ISO 8601 timestamp.

currency

enum<string>

required

Three-letter ISO currency code for this plan's prices.

Available options:

usd,

sgd,

inr,

aud,

brl,

cad,

dkk,

eur,

nok,

gbp,

sek,

chf,

hkd,

huf,

jpy,

mxn,

myr,

pln,

czk,

nzd,

aed,

eth,

ape,

cop,

ron,

thb,

bgn,

idr,

dop,

php,

try,

krw,

twd,

vnd,

pkr,

clp,

uyu,

ars,

zar,

dzd,

tnd,

mad,

kes,

kwd,

jod,

all,

xcd,

amd,

bsd,

bhd,

bob,

bam,

khr,

crc,

xof,

egp,

etb,

gmd,

ghs,

gtq,

gyd,

ils,

jmd,

mop,

mga,

mur,

mdl,

mnt,

nad,

ngn,

mkd,

omr,

pyg,

pen,

qar,

rwf,

sar,

rsd,

lkr,

tzs,

ttd,

uzs,

rub,

btc,

cny,

usdt,

kzt,

awg,

whop_usd,

xau

Example:

"usd"

custom_fields

object[]

required

Show child attributes

description

string | null

required

Customer-visible plan description.

expiration_days

number | null

required

Access duration in days for expiration-based plans.

string

required

Plan ID, prefixed plan_.

initial_price

number

required

Initial purchase price in plan currency.

internal_notes

string | null

required

Private notes visible only to authorized team members.

invoice

object | null

required

Invoice this plan was generated for; null unless created for an invoice.

member_count

number | null

required

Active memberships through this plan, when visible to the requester.

metadata

object | null

required

Custom key-value pairs stored on the plan.

payment_method_configuration

object | null

required

Payment method configuration (enabled, disabled, include_platform_defaults); null when plan uses default settings.

plan_type

enum<string>

required

Billing model for this plan: renewal (recurring) or one_time (single payment).

Available options:

renewal,

one_time

Example:

"renewal"

product

object | null

required

Product this plan belongs to; null for standalone plans.

purchase_url

string

required

URL where customers can purchase this plan directly.

release_method

enum<string>

required

Sales method for this plan, such as buy_now or waitlist.

Available options:

buy_now,

waitlist

Example:

"buy_now"

renewal_price

number

required

Recurring price charged every billing period.

split_pay_required_payments

number | null

required

Installment payments required before the subscription pauses.

stock

number | null

required

Units available for purchase, when visible to the requester.

tax_type

enum<string>

required

How tax is handled for this plan.

Available options:

inclusive,

exclusive,

unspecified

Example:

"inclusive"

three_ds_level

enum<string> | null

required

3D Secure behavior for this plan; null inherits account default.

Available options:

mandate_challenge,

frictionless,

null

Example:

"mandate_challenge"

title

string | null

required

Plan display name shown to customers.

trial_period_days

number | null

required

Free trial days before the first renewal charge. null if no trial is configured or the user has already used a trial for this plan.

unlimited_stock

boolean

required

Whether the plan has unlimited stock.

updated_at

string

required

When the plan was last updated, as an ISO 8601 timestamp.

visibility

enum<string>

required

Whether the plan is visible to customers or hidden from public view.

Available options:

visible,

hidden,

archived,

quick_link

Example:

"visible"

List Plans

Retrieve Plan

⌘I

Introduction

Reference

Core Resources

Money

Commerce

Partners

Workforce

Tracking

Ads

Media

Identity

Developer

Authorizations

Headers

Body

Response