Skip to main content
GET
Get a membership scheme's settings
This endpoint is in beta: its request and response contract can still change while it’s being developed.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

schemeId
string
required

The id of one of your membership schemes.

Pattern: ^[a-fA-F0-9]{24}$

Response

The scheme's settings, including defaults your organization never changed.

How a membership scheme treats its members' access, renewals, cancellations and plan changes. Only your organizer's API keys can read these; member tokens cannot. A setting your organizer never chose reads as the value that applies.

id
string
required
membersShareAddress
boolean
required

Whether every member on a policy lives at the primary member's address.

renewalAccessGraceDays
number | null
required

Whole days, 0 to 30, after a member's paid period ends that they keep access while their renewal is unpaid. Null when none is set: then only a renewal still awaiting payment keeps access, for up to 7 days.

missedCycleCollection
enum<string>
required

Once a later renewal is paid, whether an older unpaid renewal stops being collected (STOP_WHEN_SUPERSEDED) or is still collected (COLLECT_ARREARS).

Available options:
STOP_WHEN_SUPERSEDED,
COLLECT_ARREARS
memberChangeRules
MembershipSchemeMemberChangeRules · object
required

What members may change about their own membership. Your organizer and Let's Do This aren't bound by these rules.

coolingOff
MembershipSchemeCoolingOff · object
required

How long after each event a member may cancel their whole membership straight away. Each is an ISO 8601 duration such as P14D; PT0S when the window is off.

coolingOffRefund
MembershipSchemeCoolingOffRefund · object
required

How a member who cancels inside a cooling-off window is refunded. A scheme that never chose reads as sending every such refund to Let's Do This support.

upsellAvailability
MembershipSchemeUpsellAvailability · object | null
required

Null when checkout offers the membership on every event occurrence.