Skip to main content
PATCH
Update a membership

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Path Parameters

id
integer
required

Body

application/json
status
enum<string>

Statuses the platform derives itself (expired, used, pending_payment) cannot be set here. Send status on its own - autoRenew, the allowance fields and the commitment fields cannot be combined with it, because a status transition sets them itself. active only applies to a paused membership.

Available options:
active,
paused,
cancelled
cancelMode
enum<string>
default:end_of_period

Only valid with status: cancelled. Keep access until the paid period ends, or end it today.

Available options:
immediate,
end_of_period
applyEarlyCancellationCharge
boolean
default:false

Only valid with status: cancelled. Raise the early cancellation charge the club's membership policy sets for ending a membership before its minimum commitment, as an owed charge on the member's account. Without it the cancellation is recorded with that charge waived.

resumeAt
string<date-time> | null

Only valid with status: paused. When the pause lifts by itself; must be in the future.

autoRenew
boolean
maxUses
number | null

Session allowance; null for unlimited

usesRemaining
number | null

Sessions left, for setting a balance migrated in. Only together with maxUses

validFor
object

What it covers, replaced whole. scopes picks classes, areas and/or instructors; classTypes, areaTypes and instructorTypes narrow a scope to those type ids, and a scope with no list covers every type in it. No scopes means general coverage (direct entry), refused (400) unless the plan's own coverage is general. Refused (400) on a membership with several allowances.

sessionUnit
enum<string>

Whether a use is a booking or an hour; a change recounts what is left in the new unit. Refused (400) on a membership with several allowances, and on general coverage, where a check-in always counts one use.

Available options:
booking,
hour
sessionLengthMinutes
integer | null

How long one visit lasts at the door, from its first entry; null until the end of the club's day. Refused (400) unless the membership counts sessions per booking.

Required range: 1 <= x <= 1440
shareWithAccount
boolean

Whether the people on the holder's account can use it too

billingFrequency
enum<string>

How it bills from the next renewal. one_time stops renewal, so it ends with the period already paid for. Refused (400) on a season pass, a paused or ended membership, or one already set to end, and where no period is still running for the new billing to follow on from. Also refused on a membership that counts sessions when moving it to one_time, or when it has no charge on record, because sessions already spent would be counted again. Where the minimum term would no longer outlast one payment, send commitmentMonths with it.

Available options:
one_time,
weekly,
monthly,
quarterly,
annually,
custom
customPeriod
integer | null

With billingFrequency custom, how many customPeriodUnit a period lasts

Required range: 1 <= x <= 3650
customPeriodUnit
enum<string> | null

With billingFrequency custom, the unit of customPeriod

Available options:
days,
weeks,
months
allowances
object[]

On a membership with several allowances, in place of validFor, maxUses, usesRemaining and sessionUnit. Name only the allowances that change; what is left out stays as it is. No two may cover the same type. What is used stays used: a count raised by two leaves two more.

commitmentMonths
integer | null

A new minimum term in months, counted from the membership's start date; null removes the commitment. Refused (400) on a membership that does not renew.

Required range: 1 <= x <= 120

Response

The updated membership

A customer's membership on a plan. The plan is snapshotted onto it at creation, so allowance and coverage behave exactly as they do for a membership sold in 1club.

membershipId
integer
membershipUuid
string<uuid>

Stable unguessable identifier. Prefer this over membershipId when storing a reference.

contactId
integer

Customer the membership belongs to

planId
integer
planName
string | null
clubId
integer | null

Club the membership is limited to; null when it applies organization-wide.

status
string

active, paused, cancelled, expired, used, pending, or pending_payment

startDate
string<date-time>
endDate
string<date-time> | null
renewalDate
string<date-time> | null
autoRenew
boolean
price
number | null
billingFrequency
string
customPeriod
integer | null

With billingFrequency: custom, how many customPeriodUnit a period lasts; otherwise null.

customPeriodUnit
string | null

days, weeks or months, with billingFrequency: custom; otherwise null.

maxUses
number | null

Session allowance snapshotted from the plan; null when unlimited. With several allowances, their total.

usesRemaining
number | null

Sessions left; with several allowances, their total.

usesAdjustment
number

Sessions staff gave (or took back) this allowance period, on top of maxUses. Why usesRemaining can exceed maxUses.

allowances
object[]

Its session counters: one for an ordinary membership, several for one sold from a plan like 5 Yoga + 4 Pilates, each with its own balance.

sessionLengthMinutes
integer | null

How long one visit lasts at the door, in minutes from its first entry; null until the end of the club's day.

shareWithAccount
boolean

Whether the people on the holder's account can use it too.

commitmentEndsAt
string<date-time> | null

When the member's minimum commitment is met - they cannot cancel online before it; null for none. Counted from the start date and pushed out by pauses.

commitmentMonths
integer | null

The term agreed, in months; null when there is none.

createdAt
string<date-time>