PaymentPlan
A host-to-member Payment Plan (a Bundle with pricing) that grants access to one or more Spaces.
PaymentPlanImplements
Fields
Whether new members require Host approval before joining through this plan.
Bullet-style list of plan benefits. Empty when the Host has not added any.
When the Payment Plan was created.
Custom description shown to prospective members. Plain text.
Whether the plan is sold to people outside the Network (its landing page grants Network membership).
Host-only note for differentiating plans. Not shown to members.
Required scopes: host:read:network, host:read:network_plans, host:write:network_plans (any one)
Space members land on after joining via this plan.
Number of members who currently hold this plan. Counts subscribers for a subscription plan and purchasers for a one-time plan; a plan sold both ways counts both. Computed live.
Required scopes: host:read:network, host:read:network_plans,
host:write:network_plans, host:read:network_members,
host:write:network_members (any one)
Whether the plan grants access to more than one Space.
Plan name shown to members.
Short sales pitch shown to prospective members on the plan's landing surface. Plain text.
Pricing options (price points) offered by this plan.
Pricing model: free, subscription, one_time, installment, or one_time_installment.
Screening questions shown during the plan's join flow. Only active questions, in display order.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Filter to a single join flow. Omit to return questions for every context.
Returns the first n elements from the list.
Returns the last n elements from the list.
Whether the join flow asks screening questions.
Resource ID for this object, for interop with the Admin API.
Spaces this plan grants access to, in display order.
Lifecycle status of the plan.
Tax category the plan's sales are reported under.
Required scopes: host:read:network, host:read:network_plans, host:write:network_plans (any one)
When the Payment Plan last changed.
Admin URL where the Host can review and publish this plan.
Whether members can see this plan. Newly created plans start hidden until the Host publishes them.