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
Request
path Parameters
orderId
required
string

The unique identifier of the in progress subscription order being modified

header Parameters
loyaltySessionToken
string

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

Connect-Region-Code
string

Region Code

Request Body schema:
required

The requested subscription

subscriptionBillingOptionId
required
string non-empty

Gets the unique identifier of the subscription billing option

discountId
string or null

Gets the unique identifier of the discount used, if applicable

voucherId
string or null

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

Responses
200

Success

400

Request property is invalid or missing, or invalid order type.

401

No member authenticated.

404

Order does not exist.

put/ocapi/v1/orders/{orderId}/subscription
Request samples
{
  • "subscriptionBillingOptionId": "string",
  • "discountId": "string",
  • "voucherId": "string"
}
Response samples
application/json
{
  • "order": {
    },
  • "relatedData": {
    }
}