Skip to navigation
REST RPC APISubscriptions

Retrieve Rotating Ordinal Subscription Context

View as Markdown

Returns the Ordinal Subscription Context for the given subscription and product. This ordinal represents the number of recurring orders for the given product and subscription combination - see https://docs.ordergroove.com/advanced/ordinal-rotating#example for an example.

Authentication

x-api-keystring

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

OR
authorizationstring

Storefront API Scope — client-side, scoped to one customer, sent as a signature in the authorization header. See Authentication.

Path parameters

subscription_idstringRequired
Subscription Public ID
product_idstringRequired
Product ID

Response

200
Active Subscriptionobject
OR
Inactive Subscription + Rotating Productobject