الانتقال إلى المحتوى الرئيسي
GET
/
discounts
/
{discount_id}
JavaScript
import DodoPayments from 'dodopayments';

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

const discount = await client.discounts.retrieve('discount_id');

console.log(discount.business_id);
{
  "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
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
discount_id
string
required

Discount Id

Response

Fetched discount by ID

​
amount
integer<int32>
required

The discount amount.

  • If discount_type is percentage, this is in basis points (e.g., 540 => 5.4%).
  • Otherwise, this is USD cents (e.g., 100 => $1.00).
​
business_id
string
required

The business this discount belongs to.

​
code
string
required

The discount code (up to 16 chars).

​
created_at
string<date-time>
required

Timestamp when the discount is created

​
discount_id
string
required

The unique discount ID

​
restricted_to
string[]
required

List of product IDs to which this discount is restricted.

​
times_used
integer<int32>
required

How many times this discount has been used.

​
type
enum<string>
required

The type of discount, e.g. percentage, flat, or flat_per_unit.

الخيارات المتاحة:
percentage
​
expires_at
string<date-time> | null

Optional date/time after which discount is expired.

​
name
string | null

Name for the Discount

​
subscription_cycles
integer<int32> | null

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
integer<int32> | null

Usage limit for this discount, if any.