Membership

End a free membership

Changed on

Ends a complimentary membership now. The member keeps their number. Paid memberships end through a refund or cancellation instead. Requires membership.write.

post/membership/members/{passId}/end

Request

  • Base URL: https://api.session.services
  • URL: https://api.session.services/membership/members/{passId}/end
  • Auth: API key in header x-tenant-id

Path parameters

passIdstring required

Request body

teamIdstring required

Response

OK

idstring required

Membership pass ID

programIdstring required
teamIdstring required
userIdstring required
memberNumberinteger required

Sequential number identifying the pass within its program. The first pass receives 200.

state'ACTIVE' | 'SUSPENDED' | 'INACTIVE' required
activeboolean required

True while the pass is ACTIVE and its paid term has not ended

paidThroughstring date-time required

End of the latest paid annual term

cancelAtstring date-time

Present when renewal is scheduled to stop. Benefits continue until paidThrough.

complimentaryboolean required

True while the current term was granted by staff for free. It never renews; a paidThrough of MEMBERSHIP_NO_END means it has no end date.

createdAtstring date-time required

Example response

{
  "memberNumber": 200
}

Changes