Identifying Key Membership Properties

Identifying Key Membership Properties

Membership Properties

  • Membership status at a booking level can be identified from the meta property in the get bookings endpoint response. The attribute of this property will be MembershipStatus and contains the following values: Active, Suspended, Cancelled, Expired, Pending, PendingDeactivation.

  • Membership status from a date range via the endpoint provides a data log of historical membership status changes. Cancellation or expiry date is retrieved via the same endpoint.

  • Membership start date can be identified via the bookingDate property via the get bookings endpoint, and provides the date the membership was valid from.

  • Membership billing cycle can be identified from the get tickets endpoint via the recurringPaymentFrequency property. This may return the values daily, weekly, monthly or yearly. The billing anniversary date will be the bookingDate returned via get bookings.

  • Recurring membership payments can be identified via the transactionLocation property found via the revenues endpoint, when the value is equal to recurringPayment.

    • Make sure to filter only for where the entryType property = Transaction.
    • The fundsReceived property will be the amount of the reccurring payment.

Membership redemptions

  • Membership redemptions are retrieved via the membership redemptions endpoint.
  • 'Redemptions' for memberships are triggered in two ways:
    • When the membership ID (ticketId) is used as a discount code applied to another booking, typically to purchase another product (most common)
    • When the membership booking item is 'checked-in' at POS (by clicking the checkbox), which also produces a record in the attendances endpoint.

Did this page help you?