メインコンテンツへスキップ
GET
JavaScript

承認

Authorization
string
header
必須

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

パスパラメータ

discount_id
string
必須

Discount Id

レスポンス

Fetched discount by ID

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.

最終更新日 2026年5月28日