मुख्य सामग्री पर जाएं
GET
JavaScript

प्राधिकरण

Authorization
string
header
आवश्यक

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

पथ पैरामीटर

code
string
आवश्यक

The discount code (e.g., 'SAVE20')

प्रतिक्रिया

Fetched discount by code

amount
integer<int32>
आवश्यक

The discount amount in basis points (e.g., 540 => 5.4%).

business_id
string
आवश्यक

The business this discount belongs to.

code
string
आवश्यक

The discount code (up to 16 chars).

created_at
string<date-time>
आवश्यक

Timestamp when the discount is created

discount_id
string
आवश्यक

The unique discount ID

metadata
Metadata · object
आवश्यक

Arbitrary key-value metadata. Values can be string, integer, number, or boolean.

preserve_on_plan_change
boolean
आवश्यक

Whether this discount should be preserved when a subscription changes plans. Default: false (discount is removed on plan change)

restricted_to
string[]
आवश्यक

List of product IDs to which this discount is restricted.

times_used
integer<int32>
आवश्यक

How many times this discount has been used.

type
enum<string>
आवश्यक

The type of discount. Currently only percentage is supported.

उपलब्ध विकल्प:
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.

अंतिम संशोधन 1 अप्रैल 2026