REST RPC APISubscriptions

Set Subscription Ordinal for Rotating Product

View as Markdown
Control where the customer's rotating subscription is on the rotation cycle This endpoint accepts the Application API Scope only. Storefront API Scope signatures are rejected.

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

Path parameters

subscription_idstringRequired
Subscription Public ID

Request

This endpoint expects an object.
rotating_productstringRequired
External Product ID
ordinalintegerOptional
Positive integer that tracks where the subscription is on the rotating subscription cycle

Response

200
ordinalintegerOptionalDefaults to 0
rotation_productstringOptional
subscriptionstringOptional

Errors

400
Bad Request Error