Skip to main content
GET
Retrieve a plan.

Path Parameters

planUid
string | null
required

The plan's unique identifier

Response

Created
string<date-time>
required
read-only
Minimum string length: 1
Updated
string<date-time>
required
read-only
Minimum string length: 1
IsQuantityEditable
boolean
required
IsTaxable
boolean
required
Uid
string | null
Maximum string length: 10
_objectType
string | null
ActivityEventData
unknown
Name
string | null
Maximum string length: 250
Description
string | null
PlanFamily
object | null
Example:
AccountRegistrationMode
enum<integer>

1 - Individual, 2 - Team

Available options:
1,
2
MinimumQuantity
integer<int32>
MaximumPeople
integer<int32> | null
MonthlyRate
number<decimal>
AnnualRate
number<decimal>
QuarterlyRate
number<decimal>
OneTimeRate
number<decimal>
SetupFee
number<decimal>
SkipSetupFeeOnPlanChange
boolean
IsActive
boolean
IsPerUser
boolean
RequirePaymentInformation
boolean
TrialPeriodDays
integer<int32>
TrialUntilDate
string<date-time> | null
ExpiresAfterMonths
integer<int32>
ExpirationDate
string<date-time> | null
PostLoginPath
string | null
Maximum string length: 250
StripeTaxCodeId
string | null
Maximum string length: 15
UnitOfMeasure
string | null
Maximum string length: 250
PlanAddOns
object[] | null
ContentGroups
ContentGroup · object[] | null
NumberOfSubscriptions
integer<int32> | null