Subscriptions

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

put/ocapi/v1/orders/{orderId}/subscription

Request

Base URL
https://developer.vista.co (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/vista/apis/vista-digital-platform/docs/ocapi/v1/orders/:orderId/subscription/put.ts
A function with typed inputs. Its response is checked against the schema.

orderIdstring required

The unique identifier of the in progress subscription order being modified

loyaltySessionTokenstring

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

Connect-Region-Codestring

Region Code

subscriptionBillingOptionIdstring required

Gets the unique identifier of the subscription billing option

discountIdstring nullable

Gets the unique identifier of the discount used, if applicable

voucherIdstring nullable

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

Success

Oct 22, 2026c46f30854000 Revision changes
- info
  added the optional property // to the response with the status
- info
  added the optional property //// to the response with the status
Oct 9, 202641415d239083 Revision changes
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new Tab enum value to the /// response property for the response status
- info
  the response property // became required for the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status