List Discounts

Retrieve a list of all discounts associated with your account.

GET /discounts

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const discount of client.discounts.list()) {
  console.log(discount.business_id);
}

200

{
  "items": [
    {
      "amount": 123,
      "business_id": "<string>",
      "code": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "discount_id": "<string>",
      "metadata": {},
      "preserve_on_plan_change": true,
      "restricted_to": [
        "<string>"
      ],
      "times_used": 123,
      "expires_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "subscription_cycles": 123,
      "usage_limit": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page_size · integer<int32>

Page size (default = 10, max = 100).

Required range: x >= 0

page_number · integer<int32>

Page number (default = 0).

Required range: x >= 0

code · string

Filter by discount code (partial match, case-insensitive)

discount_type · enum<string>

Filter by discount type (percentage)

Available options: percentage

active · boolean

Filter by active status (true = not expired, false = expired)

product_id · string

Filter by product restriction (only discounts that apply to this product)

Response

200

application/json

List of active Discounts

items · object[] · required

Array of active (non-deleted) discounts for the current page.

Show child attributes