Skip to main content
objectPaymentPlanPrice

Implements

Fields

amount
Int

Price charged for this option, in cents. Null when the plan carries no monetary charge.

currency
String!

ISO currency code the amount is charged in.

hasFreeTrial
Boolean

Whether this option offers a free trial before the first charge.

Required scopes: host:read:network, host:read:network_plans, host:write:network_plans (any one)

installmentCount
Int

Number of payments this plan is split into. Null unless it is an installment plan.

interval
String

Recurring billing cadence, such as month or year. Null for a one-time purchase.

isOneTime
Boolean!

Whether this is a single one-time purchase rather than a recurring plan.

name
String!

Price point name shown to members, such as Monthly or 3 Monthly Installments.

resourceId
ID!

Resource ID for this object, for interop with the Admin API.

trialPeriodDays
Int

Free trial days a member gets before the first charge. Null when this option has no trial. Only subscriptions carry a trial.

Required scopes: host:read:network, host:read:network_plans, host:write:network_plans (any one)