v1
latestOpenAPI 3.0.12026-08-06135498863.0 KBSubscriptions
Sets the subscription for an in progress subscription order
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
put/ocapi/v1/orders/{orderId}/subscription
Path parameters
orderIdstring required
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
Request body
Response
Success
Example response
{
"order": {
"vouchers": [
{
"maskedBarcode": "12.......6789",
"voucherTypeDescription": {
"translations": [
{
"languageTag": "en-US"
}
]
}
}
],
"payments": [
{
"maskedCardNumber": "12.......6789"
}
]
},
"relatedData": {
"films": [
{
"title": {
"translations": [
{
"languageTag": "en-US"
}
]
},
"censorRatingNote": {
"translations": [
{
"languageTag": "en-US"
}
]
}
}
],
"ticketTypes": [
{
"description": {
"translations": [
{
"languageTag": "en-US"
}
]
},
"longDescription": {
"translations": [
{
"languageTag": "en-US"
}
]
}
}
],
"items": [
{
"name": {
"translations": [
{
"languageTag": "en-US"
}
]
}
}
],
"sites": [
{
"contactDetails": {
"address": {
"line1": "60 Khyber Pass Road",
"line2": "Grafton",
"city": "Auckland 1023"
}
},
"ianaTimeZoneName": "America/New_York",
"name": {
"translations": [
{
"languageTag": "en-US"
}
]
}
}
],
"screens": [
{
"name": {
"translations": [
{
"languageTag": "en-US"
}
]
}
}
],
"censorRatings": [
{
"classification": {
"translations": [
{
"languageTag": "en-US"
}
]
},
"classificationDescription": {
"translations": [
{
"languageTag": "en-US"
}
]
}
}
],
"itemServiceAreas": [
{
"name": {
"translations": [
{
"languageTag": "en-US"
}
]
},
"shortName": {
"translations": [
{
"languageTag": "en-US"
}
]
}
}
],
"itemShowtimeDeliveryWindows": [
{
"name": {
"translations": [
{
"languageTag": "en-US"
}
]
}
}
],
"subscriptionBillingOption": {
"name": {
"translations": [
{
"languageTag": "en-US"
}
]
}
},
"subscription": {
"name": {
"translations": [
{
"languageTag": "en-US"
}
]
}
},
"balanceType": {
"name": {
"translations": [
{
"languageTag": "en-US"
}
]
},
"unitName": "Points"
},
"areaCategories": [
{
"name": {
"translations": [
{
"languageTag": "en-US"
}
]
}
}
],
"itemPostalDeliveryMethods": [
{
"name": {
"translations": [
{
"languageTag": "en-US"
}
]
}
}
]
}
}