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://developer.ordergroove.com/docs/ordinal-based-rotating-products#example for an example.
Authentication
Response Body Definitions
| Name | Type | Description | Example |
|---|---|---|---|
| ordinal | integer | Current Ordinal position for the given product in the given subscription. | 3 |
| rotating_product | string | Product ID | "48398751432995" |
| subscription | string | Subscription ID | "g65765d4932511ef8dcce65j0382kc89" |
| active | boolean | True if the context is for an active subscription+product pairing, False if it is for a previous pairing (such as may be the case if the subscription started with Product A, but was eventually sku swapped to Product B). | true |
Notes
The Product ID provided in the parameter must be a Rotating Ordinal Product associated with the Subscription, either currently or in the past. The 'active' key in the response body will indicate whether or not the product is currently subscribed to. If the Product has never been associated with the Subscription then an error will be returned.
If the Subscription is for a Bundle Product where the components are Ordinal Rotating Products, the context for each component must be retrieved individually, otherwise an error will be returned.
See https://developer.ordergroove.com/docs/ordinal-based-rotating-products for more information on Ordinal Rotating Products in general.