Skip to main content
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

​
id
string
required

Unique identifier for the object.

​
mode
enum<string>
required

String representing the environment.

Available options:
test,
prod,
sandbox
​
object
string
required

A string representing the object’s type. Objects of the same type share the same value.

Example:

"discount"

​
status
enum<string>
required

The status of the discount (e.g., active, inactive).

Available options:
active,
draft,
expired,
scheduled
Example:

"active"

​
name
string
required

The name of the discount.

Example:

"Holiday Sale"

​
code
string
required

The discount code. A unique identifier for the discount.

Example:

"HOLIDAY2024"

​
type
enum<string>
required

The type of the discount, either "percentage" or "fixed".

Available options:
percentage,
fixed
Example:

"percentage"

​
amount
number

The amount of the discount. Can be a percentage or a fixed amount.

Example:

20

​
currency
string

The currency of the discount. Only required if type is "fixed".

Example:

"USD"

​
percentage
number

The percentage of the discount. Only applicable if type is "percentage".

Example:

15

​
expiry_date
string<date-time>

The expiry date of the discount.

Example:

"2024-12-31T23:59:59Z"

​
max_redemptions
number

The maximum number of redemptions allowed for the discount.

Example:

100

​
duration
enum<string>

The duration type for the discount.

Available options:
forever,
once,
repeating
Example:

"repeating"

​
duration_in_months
number

The number of months the discount is valid for. Only applicable if the duration is "repeating" and the product is a subscription.

Example:

6

​
applies_to_products
string[]

The list of product IDs to which this discount applies.

Example:
["prod_123", "prod_456"]
⌘I