GET
/
v1
/
discounts
Retrieve discount
curl --request GET \
  --url https://api.creem.io/v1/discounts \
  --header 'x-api-key: <x-api-key>'
{
  "id": "<string>",
  "mode": "test",
  "object": "discount",
  "status": "active",
  "name": "Holiday Sale",
  "code": "HOLIDAY2024",
  "type": "percentage",
  "amount": 20,
  "currency": "USD",
  "percentage": 15,
  "expiry_date": "2024-12-31T23:59:59Z",
  "max_redemptions": 100,
  "duration": "repeating",
  "duration_in_months": 6,
  "applies_to_products": [
    "prod_123",
    "prod_456"
  ]
}

Headers

​
x-api-key
string
required

Query Parameters

​
discount_id
string

The unique identifier of the discount (provide either discount_id OR discount_code)

​
discount_code
string

The unique discount code (provide either discount_id OR discount_code)

Response

200 - application/json

Successfully retrieved the discount

The response is of type object.