Subscription hold periods

A subscription hold period allows a member to temporarily pause their subscription.

Scheduling a subscription hold period

A subscription hold period can be scheduled by cinema staff in the Vista Loyalty Manager application.

NOTE

A subscription hold period cannot be scheduled via OCAPI.

During a hold period

Hold periods have a defined start and end time, during which the member's current subscription will have the OnHold status. The member will not be billed during this time and will not have access to their subscription benefits.

Copy
Copied
{
  "member": {
    "id": "string",
    "hash": "string",
    "subscriptions": {
      "current": {
        "subscriptionId": 0,
        "status": "OnHold",
        "holdPeriod": {
          "startDate": "2019-08-24T14:15:22Z",
          "endDate": "2019-08-24T14:15:22Z"
        },
        "isCancellationAllowed": false
      },
      "future": null
    }
  }
}
NOTE

Some properties have been omitted from the code snippet above for brevity.