Initiates creation of a future recurring member subscription and also loads and initiates the creation or selection of a member payment card using an embedded UI for the future recurring member subscription

Completed Order Assets

Operations

Completed Orders

Operations

Orders

Operations

Seats

Operations

Discounts

Operations

Events

Operations

Showtimes

Operations

Films

Operations

Gift Cards

Operations

Items

Operations

Journeys

Operations

Third Party Passes

Operations

Loyalty

Operations

Authentication

Operations

Members

Operations

Member Completed Orders

Operations

Friends

Operations

Password Reset

Operations

Payments

Operations

Member Rewards

Operations

Subscriptions

Operations

Sets Vista as the payment provider for the member subscription belonging to the currently authenticated member

Request

Licenses Required

Vista.Ocapi
Vista.Subscriptions

Headers

loyaltySessionTokenstring

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Codestring

Region Code

curl -i -X PUT \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members/current/subscriptions/current/billing/payment-provider/vista \
  -H 'Connect-Region-Code: string' \
  -H 'loyaltySessionToken: string'

Responses

Member subscription payment provider updated.

Loads and initiates the creation or selection of a member payment card using an embedded UI for the current or future recurring member subscription of the currently authenticated member

Request

The member payment card will be used for recurring subscription billing.

If the member has a future recurring member subscription, the member payment card will be authenticated for their future subscription.

Licenses Required

Vista.Ocapi
Vista.Subscriptions

Headers

loyaltySessionTokenstring

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Codestring

Region Code

Body

required

The values needed to create an embedded member payment card

webPaymentMethodIdinteger(int32)required

Gets the unique identifier of the web payment method

redirectReturnUrlstring or null(uri)

Gets the URL that the browser will be directed to after the embedded payment has finished, if the requested web payment method requires redirect

languageTagstring or null

Gets the IETF (RFC 4646) language tag

curl -i -X POST \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members/current/subscriptions/recurring/payment-card/embedded \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -H 'loyaltySessionToken: string' \
  -d '{
    "webPaymentMethodId": 0,
    "redirectReturnUrl": "http://example.com",
    "languageTag": "string"
  }'

Responses

Success

Bodyapplication/json

memberPaymentCardIdstringnon-emptyrequired

Gets the unique identifier of the member payment card

webPaymentMethodIdinteger(int32)required

Gets the unique identifier of the web payment method

connectorFunctionNamestringnon-emptyrequired

Gets the name of the connector function that needs to be called

connectorParametersJsonstringnon-emptyrequired

Gets the JSON blob of parameters required by the connector

createCardTokenUrlstring(uri)required

Gets the create card token URL

sdkScriptUrlsArray of stringsrequired

Gets the list of SDK script URLs that need to be loaded

isButtonIncludedbooleanrequired

Gets a value indicating whether the payment connector UI includes a submit button

isPrimaryCardOptionIncludedbooleanrequired

Gets a value indicating whether the primary card option is included

connectorScriptUrlsArray of stringsrequired

Gets the list of connector script URLs that need to be loaded

Response

application/json

{
  "memberPaymentCardId": "string",
  "webPaymentMethodId": 0,
  "connectorFunctionName": "string",
  "connectorParametersJson": "string",
  "createCardTokenUrl": "http://example.com",
  "sdkScriptUrls": [
    "string"
  ],
  "isButtonIncluded": true,
  "isPrimaryCardOptionIncluded": true,
  "connectorScriptUrls": [
    "string"
  ]
}

Initiates creation of a future recurring member subscription and also loads and initiates the creation or selection of a member payment card using an embedded UI for the future recurring member subscription

Request

Upon creating or selecting the member payment card, the member's recurring member subscriptions Future will be set.

The GetFutureRecurringSubscriptionCreation endpoint should be polled to determine the status of the future recurring subscription.

Sets Vista as the payment provider for the member subscription, if not already set to Vista.

Licenses Required

Vista.Ocapi
Vista.Subscriptions

Headers

Connect-Region-Codestring

Region Code

Body

The values needed to create the future recurring subscription payment

webPaymentMethodIdinteger(int32)required

Gets the unique identifier of the web payment method

redirectReturnUrlstring or null(uri)

Gets the URL that the browser will be directed to after the embedded payment has finished, if the requested web payment method requires redirect

languageTagstring or null

Gets the IETF (RFC 4646) language tag

subscriptionBillingOptionIdstringnon-emptyrequired

Gets the unique identifier of the subscription billing option that will be regularly charged to the created or selected member payment card

curl -i -X POST \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members/current/subscriptions/future-recurring/payment-card/embedded \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "webPaymentMethodId": 0,
    "redirectReturnUrl": "http://example.com",
    "languageTag": "string",
    "subscriptionBillingOptionId": "string"
  }'

Responses

Success

Bodyapplication/json

memberPaymentCardIdstringnon-emptyrequired

Gets the unique identifier of the member payment card

webPaymentMethodIdinteger(int32)required

Gets the unique identifier of the web payment method

connectorFunctionNamestringnon-emptyrequired

Gets the name of the connector function that needs to be called

connectorParametersJsonstringnon-emptyrequired

Gets the JSON blob of parameters required by the connector

createCardTokenUrlstring(uri)required

Gets the create card token URL

sdkScriptUrlsArray of stringsrequired

Gets the list of SDK script URLs that need to be loaded

isButtonIncludedbooleanrequired

Gets a value indicating whether the payment connector UI includes a submit button

isPrimaryCardOptionIncludedbooleanrequired

Gets a value indicating whether the primary card option is included

connectorScriptUrlsArray of stringsrequired

Gets the list of connector script URLs that need to be loaded

Response

application/json

{
  "memberPaymentCardId": "string",
  "webPaymentMethodId": 0,
  "connectorFunctionName": "string",
  "connectorParametersJson": "string",
  "createCardTokenUrl": "http://example.com",
  "sdkScriptUrls": [
    "string"
  ],
  "isButtonIncluded": true,
  "isPrimaryCardOptionIncluded": true,
  "connectorScriptUrls": [
    "string"
  ]
}

Gets the status of a created future recurring member subscription

Request

This endpoint may be polled to determine the creation status of the future recurring subscription after creating a future recurring subscription payment card.

Licenses Required

Vista.Ocapi
Vista.Subscriptions

Headers

Connect-Region-Codestring

Region Code

curl -i -X GET \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members/current/subscriptions/future-recurring/creation \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json

statusstring(FutureRecurringMemberSubscriptionCreationStatus)required

Gets the creation status of the future recurring member subscription

Enum"NotStarted""Pending""Failed""Completed"

subscriptionBillingOptionIdstringnon-emptyrequired

Gets the unique identifier of the subscription billing option used for the creation of the future recurring member subscription

Response

application/json

{
  "status": "NotStarted",
  "subscriptionBillingOptionId": "string"
}

Cancels the current member subscription for the currently authenticated member

Request

Members may cancel their member subscription if:

Self-cancellation has been enabled in Loyalty;
The member is on a recurring billing option;
The member has an active or frozen account status;
The member has paid for all billing periods before the member subscription ContractedTermEndsAt

Licenses Required

Vista.Ocapi
Vista.Subscriptions

Headers

loyaltySessionTokenstring

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Codestring

Region Code

curl -i -X DELETE \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members/current/subscriptions/current \
  -H 'Connect-Region-Code: string' \
  -H 'loyaltySessionToken: string'

Responses

Member current subscription cancelled.

Creates an in progress subscription order

Request

If no subscription order action is provided, the subscription order Action will be defaulted to subscription order action Purchase

Orders with the subscription order action Reactivate action will be created with the subscription order Subscription automatically set to the reactivation billing option.

Licenses Required

Vista.Ocapi
Vista.Subscriptions

Headers

Connect-Region-Codestring

Region Code

Body

Details of the subscription order to be created

actionstring(SubscriptionOrderAction)required

Gets the subscription order action

Enum"Purchase""Reactivate"

curl -i -X POST \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/subscription \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "action": "Purchase"
  }'

Responses

Success

Bodyapplication/json

orderobject(InProgressSubscriptionOrder)required

Gets the in progress order base entity

order.idstring or null

Gets the unique identifier

order.typestring(OrderType)required

Gets the type

Enum"Standard""GiftShop""Subscription"

order.statusstring(OrderStatus)required

Gets the status

Enum"InProgress""Completed"

order.totalPriceobject(MonetaryValue)required

Gets the total price to be displayed to the customer

order.totalPrice.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.totalPrice.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.totalPrice.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.vouchersArray of objects(OrderVoucher)required

Gets the list of order voucher entities

order.vouchers[].idstringnon-emptyrequired

Gets the identifier that can be used to uniquely identify the voucher within the order base

order.vouchers[].typestring(VoucherType)required

Gets the type

Enum"Ticket""Subscription""Deal"

order.vouchers[].maskedBarcodestringnon-emptyrequired

Gets a masked representation of the barcode

Example: "12.......6789"

order.vouchers[].voucherTypeCodestringnon-emptyrequired

Gets the unique identifier of the voucher type

order.vouchers[].voucherTypeDescriptionobject(Translatable)

Gets the voucher type description text, and its translations

order.dealsArray of objects(OrderDeal)required

Gets the list of order deal entities

order.deals[].idstringnon-emptyread-onlyrequired

Gets the identifier that can be used to uniquely identify the deal within the order base

order.deals[].dealIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the deal base used

order.deals[].voucherIdstring or null

Gets the unique identifier of the order voucher used, if applicable

order.paymentsArray of OrderRedirectPayment (object) or OrderMemberBalancePayment (object) or OrderGiftCardPayment (object) or OrderExternallyProcessedPayment (object) or OrderEmbeddedPayment (object) or OrderCinemaProcessedPayment (object)required

Gets the list of order payment base entities

One of:

Represents a redirect payment that has been added to an order base

order.payments[].idstringnon-emptyrequired

Gets the identifier that can be used to uniquely identify the payment within the order base

order.payments[].typestring(OrderPaymentType)required

Gets the type

Enum"CinemaProcessed""Embedded""GiftCard""Redirect""MemberBalance""ExternallyProcessed"

order.payments[].valuenumber(double)required

Gets the monetary value

order.payments[].statusstring(OrderPaymentStatus)required

Gets the status

Enum"NotStarted""Pending""Declined""Completed"

order.subscriptionobject(OrderSubscription)

Gets the subscription

order.actionstring(SubscriptionOrderAction)required

Gets the subscription order action

Enum"Purchase""Reactivate"

order.expiresAtstring(date-time)required

Gets the date and time that the order is set to expire

order.hasCustomerbooleanrequired

Gets a value indicating whether the order customer has been set

order.amountSavedobject(MonetaryValue)required

Gets the monetary amount saved via discounted prices

order.amountSaved.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.amountSaved.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.amountSaved.taxnumber(double)read-onlyrequired

Gets the amount of tax

relatedDataobject(OrderRelatedData)required

Gets the related data for the in progress order base entity

relatedData.filmsArray of objects(OrderRelatedFilm)required

Gets the list of related order related film entities

relatedData.films[].idstringnon-emptyrequired

relatedData.films[].titleobject(Translatable)required

Represents some customer-visible translatable Text in the default language, and a list of translation entities

relatedData.films[].title.textstringnon-emptyrequired

Gets the text in the default language

relatedData.films[].title.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.films[].title.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.films[].title.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.films[].externalIdsobject(FilmExternalIds)required

Represents the external identifiers linked to a film

relatedData.films[].externalIds.moviexchangeReleaseIdstring or null(uuid)

Gets the unique identifier of the linked movieXchange film release entity

relatedData.films[].externalIds.corporateIdstring or null

Gets the unique corporate identifier

relatedData.films[].censorRatingIdstring or null

relatedData.films[].censorRatingNoteobject(Translatable)

Represents some customer-visible translatable Text in the default language, and a list of translation entities

relatedData.ticketTypesArray of objects(OrderRelatedTicketType)required

Gets the list of related order related ticket type entities

relatedData.ticketTypes[].idstringnon-emptyread-onlyrequired

relatedData.ticketTypes[].descriptionobject(Translatable)required

Represents some customer-visible translatable Text in the default language, and a list of translation entities

relatedData.ticketTypes[].description.textstringnon-emptyrequired

Gets the text in the default language

relatedData.ticketTypes[].description.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.ticketTypes[].description.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.ticketTypes[].description.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.ticketTypes[].longDescriptionobject(Translatable)required

Represents some customer-visible translatable Text in the default language, and a list of translation entities

relatedData.ticketTypes[].longDescription.textstringnon-emptyrequired

Gets the text in the default language

relatedData.ticketTypes[].longDescription.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.ticketTypes[].longDescription.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.ticketTypes[].longDescription.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.itemsArray of objects(OrderRelatedItem)required

Gets the list of related order related item entities

relatedData.items[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.items[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.items[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.items[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.items[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.items[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.items[].hoCodestringnon-emptyrequired

Gets the Head Office code

relatedData.items[].hopkstring or null

Gets the Head Office primary key

relatedData.items[].isSundryboolean

Gets a value indicating whether this is a sundry item

relatedData.items[].isPreparationRequiredboolean

Gets a value indicating whether the item requires preparation

relatedData.showtimesArray of objects(OrderRelatedShowtime)required

Gets the list of related order related showtime entities

relatedData.showtimes[].idstringnon-emptyread-onlyrequired

relatedData.showtimes[].scheduleobject(ShowtimeSchedule)required

Represents the dates and times relevant to a showtime, e.g. its start, end, film start, etc

relatedData.showtimes[].schedule.businessDatestring(date-time)required

Gets the showtime entity's business date

relatedData.showtimes[].schedule.startsAtstring(date-time)required

Gets the date and time that the showtime starts

relatedData.showtimes[].schedule.endsAtstring(date-time)required

Gets the date and time that the showtime ends

relatedData.showtimes[].schedule.filmStartsAtstring(date-time)required

Gets the date and time that the film screening starts

relatedData.showtimes[].schedule.filmEndsAtstring(date-time)required

Gets the date and time that the film screening ends

relatedData.showtimes[].schedule.inSeatItemDeliveryobject(ShowtimeInSeatItemDeliverySchedule)

Gets the showtime in seat item delivery schedule entity, if applicable

relatedData.showtimes[].filmIdstringnon-emptyrequired

relatedData.showtimes[].siteIdstringnon-emptyrequired

relatedData.showtimes[].screenIdstringnon-emptyread-onlyrequired

relatedData.sitesArray of LoyaltySite (object) or Site (object)required

Gets the list of related site entities

One of:

Represents a site in Vista Loyalty

relatedData.sites[].locationobject(GeographicLocation)

Gets the geographic location

relatedData.sites[].contactDetailsobject(SiteContactDetails)required

Gets the contact details

relatedData.sites[].contactDetails.phoneNumbersArray of objects(PhoneNumber)required

Gets the list of phone number entities

relatedData.sites[].contactDetails.phoneNumbers[].typestring(PhoneNumberType)required

Gets the type

Enum"Home""Mobile""Work""Business""Fax"

relatedData.sites[].contactDetails.phoneNumbers[].numberstringnon-emptyrequired

Gets the phone number

relatedData.sites[].contactDetails.emailstring or null

Gets the email address

relatedData.sites[].contactDetails.addressobject(SiteAddress)

Represents the physical address of a site

relatedData.sites[].ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"

relatedData.sites[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.sites[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.sites[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.sites[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.sites[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.sites[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.sites[].hasSellableItemsbooleanrequired

Gets a value indicating whether the site has any sellable item entities

relatedData.sites[].allowedItemDeliveryMethodsArray of strings(ItemDeliveryMethod)required

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"

relatedData.screensArray of objects(Screen)required

Gets the list of related screen entities

relatedData.screens[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.screens[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.screens[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.screens[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.screens[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.screens[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.censorRatingsArray of objects(CensorRating)required

Gets the list of related censor rating entities

relatedData.censorRatings[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.censorRatings[].classificationobject(Translatable)required

Gets the classification text, and its translations

relatedData.censorRatings[].classification.textstringnon-emptyrequired

Gets the text in the default language

relatedData.censorRatings[].classification.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.censorRatings[].classification.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.censorRatings[].classification.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.censorRatings[].classificationDescriptionobject(Translatable)

Gets the censor rating Classification description text, and its translations

relatedData.censorRatings[].ageRestrictionobject(CensorRatingAgeRestriction)

Gets the age restriction, if applicable

relatedData.itemServiceAreasArray of objects(ItemServiceArea)required

Gets the list of related item service area entities

relatedData.itemServiceAreas[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.itemServiceAreas[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.itemServiceAreas[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.itemServiceAreas[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.itemServiceAreas[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.itemServiceAreas[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.itemServiceAreas[].shortNameobject(Translatable)required

Gets the short name text, and its translations

relatedData.itemServiceAreas[].shortName.textstringnon-emptyrequired

Gets the text in the default language

relatedData.itemServiceAreas[].shortName.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.itemServiceAreas[].shortName.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.itemServiceAreas[].shortName.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.itemShowtimeDeliveryWindowsArray of objects(ItemShowtimeDeliveryWindowBase)required

Gets the list of related item showtime delivery window base entities

relatedData.itemShowtimeDeliveryWindows[].minutesinteger(int32)required

Gets the targeted delivery time, as a number of minutes from showtime schedule StartsAt

relatedData.itemShowtimeDeliveryWindows[].typestring(ItemShowtimeDeliveryWindowType)required

Gets the type

Value"MinutesFromStart"

relatedData.itemShowtimeDeliveryWindows[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.itemShowtimeDeliveryWindows[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.itemShowtimeDeliveryWindows[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.itemShowtimeDeliveryWindows[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.itemShowtimeDeliveryWindows[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.itemShowtimeDeliveryWindows[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.subscriptionBillingOptionobject(OrderRelatedSubscriptionBillingOption)

Gets the related order related subscription billing option entity

relatedData.subscriptionobject(OrderRelatedSubscription)

Gets the related order related subscription entity

relatedData.balanceTypeobject(BalanceType)

Gets the related balance type entity, if applicable

relatedData.areaCategoriesArray of objects(AreaCategory)required

Gets the list of related area category entities

relatedData.areaCategories[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.areaCategories[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.areaCategories[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.areaCategories[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.areaCategories[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.areaCategories[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.areaCategories[].hopkstring or null

Gets the Head Office primary key

relatedData.areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

relatedData.areaCategories[].isInSeatItemDeliveryAvailablebooleanrequired

Gets a value indicating whether in-seat item delivery is available for seats belonging to this area category

relatedData.itemPostalDeliveryMethodsArray of objects(OrderRelatedItemPostalDeliveryMethod)required

Gets the list of related order related item postal delivery method entities

relatedData.itemPostalDeliveryMethods[].isDefaultbooleanrequired

Gets a value indicating whether this is the default delivery method

relatedData.itemPostalDeliveryMethods[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.itemPostalDeliveryMethods[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.itemPostalDeliveryMethods[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.itemPostalDeliveryMethods[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.itemPostalDeliveryMethods[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.itemPostalDeliveryMethods[].name.translations[].textstringnon-emptyrequired

Gets the translated text

Response

application/json

{
  "order": {
    "id": "string",
    "type": "Standard",
    "status": "InProgress",
    "totalPrice": { … },
    "vouchers": [ … ],
    "deals": [ … ],
    "payments": [ … ],
    "subscription": { … },
    "action": "Purchase",
    "expiresAt": "2019-08-24T14:15:22Z",
    "hasCustomer": true,
    "amountSaved": { … }
  },
  "relatedData": {
    "films": [ … ],
    "ticketTypes": [ … ],
    "items": [ … ],
    "showtimes": [ … ],
    "sites": [ … ],
    "screens": [ … ],
    "censorRatings": [ … ],
    "itemServiceAreas": [ … ],
    "itemShowtimeDeliveryWindows": [ … ],
    "subscriptionBillingOption": { … },
    "subscription": { … },
    "balanceType": { … },
    "areaCategories": [ … ],
    "itemPostalDeliveryMethods": [ … ]
  }
}

Sets the subscription for an in progress subscription order

Request

This endpoint cannot be used for an in progress subscription order with subscription order Action equal to subscription order action Reactivate

Licenses Required

Vista.Ocapi
Vista.Subscriptions

Path

orderIdstringrequired

The unique identifier of the in progress subscription order being modified

Headers

loyaltySessionTokenstring

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Codestring

Region Code

Body

required

The requested subscription

subscriptionBillingOptionIdstringnon-emptyrequired

Gets the unique identifier of the subscription billing option

discountIdstring or null

Gets the unique identifier of the discount used, if applicable

voucherIdstring or null

Gets the unique identifier of the order voucher used, if applicable

curl -i -X PUT \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/subscription' \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -H 'loyaltySessionToken: string' \
  -d '{
    "subscriptionBillingOptionId": "string",
    "discountId": "string",
    "voucherId": "string"
  }'