Membership

Grant a free membership

Changed on

Staff give a member a complimentary membership on the keyring they hand over. The keyring's serial becomes the member number. Requires membership.write.

post/membership/members

Request

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

Request body

teamIdstring required
memberNumberinteger required

The serial printed on the keyring being handed over. It becomes the member number.

emailstring email required

The member's email. Their existing account is used, or a new one is created that they sign in to with this email.

firstNamestring required
lastNamestring required
endsAtstring date-time nullable required

When the free membership ends. Null for no end date. See defaultMembershipGrantEnd().

Example request

{
  "memberNumber": 42
}

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