Skip to navigation
REST RPC APISubscriptions

Set Subscription Ordinal for Rotating Product

View as Markdown

Sets where a customer’s subscription is in an ordinal rotation.

rotating_product is required and must be an ordinal rotating product; omitting it returns 404 with Product not found. Ordinals are tracked per rotating product, because a subscription can be swapped from one rotating product to another. After a swap to a rotating product with no recorded ordinal, the previous product keeps its ordinal and the new product starts at its first delivery product (starting_ordinal 0) by default.

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
ordinalintegerRequired

Non-negative integer that sets where the subscription is in the rotation cycle

Response

200
ordinalintegerOptionalDefaults to 0
rotation_productstringOptional
subscriptionstringOptional

Errors

400
Bad Request Error