Skip to main content
inputCreatePaymentPlanInput

Fields

amount
String

Price as decimal string (e.g. "9.99"). Use for single-currency paid plans; omit for free plans.

approvalEnabled
Boolean

Whether to require Host approval for new members. Defaults to false.

benefits
[String!]

Bullet-style list of plan benefits.

clientMutationId
String

A unique identifier for the client performing the mutation.

currency
String

Three-letter currency code (e.g. usd). Used with amount; ignored when prices is provided.

description
String

Custom description for the plan.

internalNotes
String

Host-only note for differentiating plans (max 150 chars).

interval
String

Billing interval for subscriptions: day, week, biweekly, month, quarter, biannual, year. Defaults to month.

landingSpaceId
ID

Space members land on after joining via this plan.

name
String!
required

Plan name shown to members (4-60 characters).

paymentPlatform
String

Payment platform: stripe (web) or apple (iOS). Defaults to stripe.

pitch
String

Short sales pitch shown to prospective members on the plan's landing surface.

Per-currency prices. Required when the Network has multiple enabled currencies for Stripe paid plans.

pricingType
String!
required

Pricing model: free, subscription, or one_time.

Screening questions (max 5). Only used when profileQuestionsEnabled is true.

profileQuestionsEnabled
Boolean

Whether to ask screening questions during the join flow. Defaults to false.

secondAmount
String

Price for the second pricing option (single-currency Networks). For installments, the per-installment amount.

secondInstallmentCount
Int

Number of installments (2-50) when the second option is an installment plan. Only valid with pricingType one_time.

secondInterval
String

Interval for a SECOND pricing option in the same plan. For subscriptions: a different subscription interval. For one_time: installment.

secondPrices

Per-currency prices for the second pricing option (multi-currency Stripe Networks).

spaceIds
[ID!]!
required

Spaces to include in the plan. Must contain at least one active Space; the Cohost Space cannot be included.

subscriptionGroupId
ID

Existing Subscription Group to add this plan to.

trialPeriodDays
Int

Free trial days (0-366). Only applies to subscriptions.