Skip to main content
POST
/
api
/
v1
/
plans
Create Plan
curl --request POST \
  --url https://api.example.com/api/v1/plans \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "lookup_id": "<string>",
  "type": "<string>",
  "billing_interval": "<string>",
  "currency": "<string>",
  "trial_days": 123,
  "description": "<string>",
  "is_active": true
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Pro",
  "lookup_id": "pro",
  "type": "HYBRID",
  "billing_interval": "month",
  "currency": "USD",
  "is_active": true,
  "trial_days": 14,
  "created_at": "2025-01-01T00:00:00Z"
}
​
name
string
required
Display name for the plan
​
lookup_id
string
required
Unique slug identifier (must be unique per org)
​
type
string
required
Plan type: FIXED, USAGE, or HYBRID
​
billing_interval
string
required
Billing cadence: day, week, month, or year
​
currency
string
required
ISO 4217 currency code (e.g., USD, EUR, INR)
​
trial_days
integer
Number of free trial days (0 = no trial)
​
description
string
Human-readable description
​
is_active
boolean
default:"true"
Whether this plan accepts new subscriptions
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Pro",
  "lookup_id": "pro",
  "type": "HYBRID",
  "billing_interval": "month",
  "currency": "USD",
  "is_active": true,
  "trial_days": 14,
  "created_at": "2025-01-01T00:00:00Z"
}