Skip to main content
inputUpdatePaymentPlanInput

Fields

addSpaceIds
[ID!]

Spaces to attach to the plan.

approvalEnabled
Boolean

Whether to require Host approval for new members.

benefits
[String!]

Bullet-style list of plan benefits. Replaces the existing list.

clientMutationId
String

A unique identifier for the client performing the mutation.

description
String

Custom description for the plan.

id
ID!
required

Payment Plan ID — resource ID or GlobalID.

internalNotes
String

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

landingSpaceId
ID

Space members land on after joining via this plan — resource ID or GlobalID.

name
String

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

pitch
String

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

profileQuestionsEnabled
Boolean

Whether to ask screening questions during the join flow.

removeSpaceIds
[ID!]

Spaces to detach from the plan. A plan must keep at least one Space.

spaceIds
[ID!]

Replace the full set of Spaces the plan grants access to. Ignored when addSpaceIds or removeSpaceIds is passed.

spaceIdsOrder
[ID!]

Display order for the plan's Spaces.

taxCategory
String

Tax category the plan's sales are reported under: eservice, standard, or non_taxable.