Skip to content

Membership

A recurring membership offered by a business. Sessions reset or accumulate each billing period.

Implements

Fields

idID!
businessBusiness!
stripePublishableKeyString!
stripeConnectedAccountIdID

The business's connected account for its active Stripe mode; the client initialises Stripe.js with this for direct charges. Null until onboarding completes.

Bank debit (ACH / pre-authorized debit) offered for buying this membership, or null when it isn't on offer. Non-null is what tells the purchase sheet to render a payment-method choice at all; null leaves the sheet exactly as it was, card-only.

nameString

Resolved for the given locale, falling back to English. Defaults to the viewer's locale.

Arguments (1)
localeLocale
descriptionString

Resolved for the given locale, falling back to English. Defaults to the viewer's locale.

Arguments (1)
localeLocale
featuredImageImage
priceInt!
purchaseRulesProductPurchaseRules!
effectivePriceInt!
sortOrderInt!
purchasePageBlocks[PurchasePageBlock!]!

Ordered list of configurable blocks rendered on this product's purchase page (contract, signature, acknowledgement, recurring-summary, etc.). Empty for products that use the default purchase layout. config on each block is a JSON-encoded string.

sessionCountInt

Sessions granted per billing period. Null means the membership grants unlimited sessions; sessionsAccumulate is meaningless in that case.

billingCycleBillingCycle!

Used in