Discounts
List Discounts
API Documentation & SDKs
Subscriptions
Discounts
Licenses
Customers
Products
Payouts
Miscellaneous
Discounts
List Discounts
Retrieve a list of all discounts associated with your account.
GET
/
discounts
import DodoPayments from 'dodopayments';
const client = new DodoPayments({
bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});
async function main() {
// Automatically fetches more pages as needed.
for await (const discount of client.discounts.list()) {
console.log(discount.business_id);
}
}
main();
{
"items": [
{
"amount": 123,
"business_id": "<string>",
"code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"discount_id": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"restricted_to": [
"<string>"
],
"times_used": 123,
"type": "percentage",
"usage_limit": 123
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Page size (default = 10, max = 100).
Required range:
x >= 0
Page number (default = 0).
Required range:
x >= 0
Response
200 - application/json
List of active Discounts
Array of active (non-deleted) discounts for the current page.
The discount amount.
- If
discount_type
ispercentage
, this is in basis points (e.g., 540 => 5.4%). - Otherwise, this is USD cents (e.g., 100 =>
$1.00
).
The business this discount belongs to.
The discount code (up to 16 chars).
Timestamp when the discount is created
The unique discount ID
List of product IDs to which this discount is restricted.
How many times this discount has been used.
Available options:
percentage
Optional date/time after which discount is expired.
Name for the Discount
Usage limit for this discount, if any.
import DodoPayments from 'dodopayments';
const client = new DodoPayments({
bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});
async function main() {
// Automatically fetches more pages as needed.
for await (const discount of client.discounts.list()) {
console.log(discount.business_id);
}
}
main();
{
"items": [
{
"amount": 123,
"business_id": "<string>",
"code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"discount_id": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"restricted_to": [
"<string>"
],
"times_used": 123,
"type": "percentage",
"usage_limit": 123
}
]
}