Skip to main content
{
	"account": {},
	"adaptive_pricing_enabled": true,
	"billing_period": 0,
	"collect_tax": true,
	"created_at": "<string>",
	"currency": "usd",
	"custom_fields": [
		{
			"field_type": "text",
			"id": "<string>",
			"name": "<string>",
			"order": 0,
			"placeholder": "<string>",
			"required": true
		}
	],
	"description": "<string>",
	"expiration_days": 0,
	"id": "<string>",
	"initial_price": 0,
	"internal_notes": "<string>",
	"invoice": {},
	"member_count": 0,
	"metadata": {},
	"payment_method_configuration": {},
	"plan_type": "renewal",
	"product": {},
	"purchase_url": "<string>",
	"release_method": "buy_now",
	"renewal_price": 0,
	"split_pay_required_payments": 0,
	"stock": 0,
	"tax_type": "inclusive",
	"three_ds_level": "mandate_challenge",
	"title": "<string>",
	"trial_period_days": 0,
	"unlimited_stock": true,
	"updated_at": "<string>",
	"visibility": "visible"
}
​
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
string
required
Three-letter ISO currency code for this plan’s prices.Example: usd
​
custom_fields
array<PlanCustomField>
required
​
description
string | null
required
Customer-visible plan description.
​
expiration_days
number | null
required
Access duration in days for expiration-based plans.
​
id
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
string
required
Billing model for this plan: renewal (recurring) or one_time (single payment).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
string
required
Sales method for this plan, such as buy_now or 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
string
required
How tax is handled for this plan.Example: inclusive
​
three_ds_level
string | null
required
3D Secure behavior for this plan; null inherits account default.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
string
required
Whether the plan is visible to customers or hidden from public view.Example: visible