Hoppa till huvudinnehåll
GET
JavaScript

Auktoriseringar

Authorization
string
header
obligatorisk

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

Sökvägsparametrar

code
string
obligatorisk

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

Svar

Fetched discount by code

amount
integer<int32>
obligatorisk

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

business_id
string
obligatorisk

The business this discount belongs to.

code
string
obligatorisk

The discount code (up to 16 chars).

created_at
string<date-time>
obligatorisk

Timestamp when the discount is created

discount_id
string
obligatorisk

The unique discount ID

metadata
Metadata · object
obligatorisk

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

preserve_on_plan_change
boolean
obligatorisk

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

restricted_to
string[]
obligatorisk

List of product IDs to which this discount is restricted.

times_used
integer<int32>
obligatorisk

How many times this discount has been used.

type
enum<string>
obligatorisk

The type of discount. Currently only percentage is supported.

Tillgängliga alternativ:
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.

Senast ändrad 1 april 2026