v2
latestOpenAPI 3.0.12026-07-262352981007.0 KBSubscriptions
Get subscription promotions
Retrieves promotions available for the specified subscription.
get/subscriptions/{id}/promotions
Path parameters
idstring required
The unique identifier of the subscription
Query parameters
Offsetinteger
Limitinteger
Response
When request is successful. Returns a paged collection of 'SubscriptionPromotion' objects.
Example response
{
"value": [
{
"id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
"tiers": [
{
"id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
"name": "Intake",
"prices": [
{
"default": true,
"active": true,
"type": "Recurring",
"name": "\"$109 per user/month\"",
"amount": 5900,
"interval": "Monthly"
}
],
"createdDate": "2022-04-23T14:00:00Z",
"updatedDate": "2022-04-23T14:00:00Z"
}
],
"addOns": [
{
"id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
"name": "Intake",
"prices": [
{
"default": true,
"active": true,
"type": "Recurring",
"name": "\"$109 per user/month\"",
"amount": 5900,
"interval": "Monthly"
}
],
"createdDate": "2022-04-23T14:00:00Z",
"updatedDate": "2022-04-23T14:00:00Z"
}
],
"name": "Summer Sale 2024",
"description": "Summer Sale 2024",
"durationDays": 7,
"amountOff": 2000,
"percentOff": 20.5,
"numUsed": 42,
"createdDate": "2024-01-15T10:00:00Z",
"expirationDate": "2024-12-31T23:59:59Z",
"codes": [
{
"id": "promo_code_1234",
"name": "SUMMER2024",
"description": "100% discount!",
"code": "SUMMER2024",
"minimumAmount": 5000,
"limit": 100,
"createdDate": "2024-01-15T10:00:00Z",
"expiratonDate": "2024-12-31T23:59:59Z"
}
]
}
]
}