v1
latestOpenAPI 3.0.12026-08-06135498863.0 KBSubscriptions
Creates an in progress subscription order
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
post/ocapi/v1/orders/subscription
Headers
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"
}
]
}
}
]
}
}