Récupérer une liste de toutes les remises associées à votre compte.
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);
}{
"items": [
{
"amount": 123,
"business_id": "<string>",
"code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"discount_id": "<string>",
"restricted_to": [
"<string>"
],
"times_used": 123,
"type": "percentage",
"expires_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"subscription_cycles": 123,
"usage_limit": 123
}
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Page size (default = 10, max = 100).
x >= 0Page number (default = 0).
x >= 0List of active Discounts
Array of active (non-deleted) discounts for the current page.
Afficher attributs enfants
The discount amount.
discount_type is percentage, this is in basis points
(e.g., 540 => 5.4%).$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.
The type of discount, e.g. percentage, flat, or flat_per_unit.
percentage Optional date/time after which discount is expired.
Name for the Discount
Number of subscription billing cycles this discount is valid for. If not provided, the discount will be applied indefinitely to all recurring payments related to the subscription.
Usage limit for this discount, if any.
Cette page vous a-t-elle été utile ?
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);
}{
"items": [
{
"amount": 123,
"business_id": "<string>",
"code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"discount_id": "<string>",
"restricted_to": [
"<string>"
],
"times_used": 123,
"type": "percentage",
"expires_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"subscription_cycles": 123,
"usage_limit": 123
}
]
}