Skip to main content
GET
JavaScript

Autorisierungen

Authorization
string
header
erforderlich

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

Pfadparameter

code
string
erforderlich

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

Antwort

Fetched discount by code

amount
integer<int32>
erforderlich

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

business_id
string
erforderlich

The business this discount belongs to.

code
string
erforderlich

The discount code (up to 16 chars).

created_at
string<date-time>
erforderlich

Timestamp when the discount is created

customer_eligibility
enum<string>
erforderlich

Who may redeem this discount code.

Verfügbare Optionen:
any,
first_time,
existing,
specific
discount_id
string
erforderlich

The unique discount ID

metadata
Metadata · object
erforderlich

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

preserve_on_plan_change
boolean
erforderlich

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

restricted_to
string[]
erforderlich

List of product IDs to which this discount is restricted.

times_used
integer<int32>
erforderlich

How many times this discount has been used.

type
enum<string>
erforderlich

The type of discount (percentage or flat).

Verfügbare Optionen:
flat,
percentage
currency_options
object[]

Per-currency options (flat deduction / percentage cap + minimum subtotal). Empty for discounts without any configured currency options.

expires_at
string<date-time> | null

Optional date/time after which discount is expired.

name
string | null

Name for the Discount

per_customer_usage_limit
integer<int32> | null

Maximum number of times a single customer may redeem this discount, if any.

starts_at
string<date-time> | null

Optional date/time before which the discount is not yet active. NULL = active immediately.

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.

Zuletzt geändert am 1. April 2026