Member subscriptions

A loyalty member with an active subscription may gain access to exclusive subscription benefits.

Get member subscriptions

Use the GetCurrentMember endpoint to get the authenticated member's subscriptions.

{
  "member": {
    "id": "string",
    "hash": "string",
    "subscriptions": {
      "current": {
        "subscriptionId": 0,
        "status": "Active",
        "startsAt": "2019-08-24T14:15:22Z",
        "expiresAt": "2019-08-24T14:15:22Z",
        "contractedTermEndsAt": "2019-08-24T14:15:22Z",
        "billingDetails": {
          "isRecurring": true,
          "reactivationPrice": {
            "valueIncludingTax": 0.1,
            "valueExcludingTax": 0.1,
            "tax": 0.1
          },
          "isUsingThirdPartyPaymentProvider": true,
          "currentBillingPeriodStartsAt": "2019-08-24T14:15:22Z",
          "nextBillingPeriodStartsAt": "2019-08-24T14:15:22Z",
          "billingError": {
            "willBeRetried": true
          },
          "hasLastContractedPaymentBeenMade": true,
          "hasNextBillingPeriodPriceAdjustment": true
        },
        "holdPeriod": {
          "startDate": "2019-08-24T14:15:22Z",
          "endDate": "2019-08-24T14:15:22Z"
        },
        "isCancellationAllowed": true,
        "cancelsAt": "2019-08-24T14:15:22Z"
      },
      "future": null,
      "canPurchaseFutureSubscription": false,
      "canPurchaseFutureSubscriptionAt": "2019-08-24T14:15:22Z"
    }
  }
}

Current subscription

A member's current subscription provides the member access to subscription benefits while it is in an Active state.

Future subscription

The member will have a future subscription if they have purchased a future subscription.

A member's future subscription will provide the member access to subscription benefits when their current subscription ends.

Member subscription status

Each member subscription has a status property that indicates the current state of the subscription.

Active

The subscription is Active and the member has access to their subscription benefits.

Frozen

The subscription is Frozen due to a repeated billing error. The member needs to manually reactivate their subscription to re-enable their subscription benefits.

On hold

The subscription is OnHold due to a member-initiated hold period. The member will automatically regain access to their subscription benefits when the hold period ends.

Not started

A member's future subscription will have the NotStarted status while their current subscription is still Active.

The member will have access to the subscription benefits of their current subscription during this time, but won't have access to their future subscription until it becomes Active.

Member subscription cards

A member with an active subscription will have a MemberSubscriptionCard that can be used to purchase Subscription tickets.

Use the GetMemberTicketRedemptionCards endpoint to get the authenticated member's ticket redemption cards.

This endpoint returns the authenticated member's MemberSubscriptionCard (if they have a subscription), and any friend's cards that have been shared with the member.