Skip to main content
View as Markdown

The SubscriptionPlan object

The SubscriptionPlan object.

note

11 of 11 fields on this object have no description yet. Field documentation lives in the SDK types (types/subscription.ts) so it stays in one place — this page is generated from it.

Fields​

FieldTypeDescription
planId
REQUIRED		string
merchantId
REQUIRED		string
name
REQUIRED		string
description
OPTIONAL		string
amount
REQUIRED		number
currency
REQUIRED		string
interval
REQUIRED		BillingIntervalSee BillingInterval. BillingInterval
intervalCount
REQUIRED		number
trialDays
REQUIRED		number
status
REQUIRED		SubscriptionPlanStatusSee SubscriptionPlanStatus. SubscriptionPlanStatus
metadata
OPTIONAL		Record<string, unknown>

Example​

{
  "planId": "plan_1a2b3c",
  "merchantId": "merchant_1a2b3c",
  "name": "string",
  "description": "string",
  "amount": 5000,
  "currency": "USD",
  "interval": "day",
  "intervalCount": 1,
  "trialDays": 1,
  "status": "active"
}