Sign in
latestOpenAPI 3.1.12026-08-108026304.2 KB

7b222e8ec91c

Issued memberships

Create an issued membership

Creates a new issued membership for membership type

post/v1/issued_memberships

Response

Successfully created an issued membership

objectstring

Object type identifier

idstring

A unique identifier for the issued membership

codestring

Unique membership code for identification and redemption

benefitsstring[]

List of benefits associated with this membership

emailstring

Email address of the member

first_namestring

First name of the member

full_namestring

Full name of the member

is_valid'true' | 'false'

Whether the membership is currently valid (not expired and not voided)

last_namestring

Last name of the member

max_redemptionsinteger nullable

Maximum number of redemptions allowed. Null means unlimited.

membership_type_idstring

ID of the membership type

membership_type_namestring

Name of the membership type

redemptionsinteger

Number of times this membership has been redeemed

Example response

{
  "object": "issued_membership",
  "id": "im_123",
  "code": "MMABC123",
  "benefits": [
    "Free entry to all events",
    "10% discount on merchandise"
  ],
  "email": "john.doe@example.com",
  "first_name": "John",
  "full_name": "John Doe",
  "is_valid": "true",
  "issue_date": {
    "date": "2024-01-01",
    "formatted": "Mon 1 Jan 2024 12:00 PM",
    "iso": "2024-01-01T12:00:00+00:00",
    "time": "12:00",
    "timezone": "+00:00",
    "unix": 1704110400
  },
  "last_name": "Doe",
  "max_redemptions": 10,
  "membership_type_id": "mt_456",
  "membership_type_name": "Annual Pass",
  "redemption_collection": [],
  "redemptions": 0,
  "valid_from": {
    "date": "2024-01-01",
    "formatted": "Mon 1 Jan 2024 12:00 PM",
    "iso": "2024-01-01T12:00:00+00:00",
    "time": "12:00",
    "timezone": "+00:00",
    "unix": 1704110400
  },
  "valid_to": {
    "date": "2024-12-31",
    "formatted": "Tue 31 Dec 2024 11:59 PM",
    "iso": "2024-12-31T23:59:59+00:00",
    "time": "23:59",
    "timezone": "+00:00",
    "unix": 1735689599
  },
  "voided_at": null
}