Skip to main content
PUT
Create and add custom discount to subscription

Headers

X-API-Key
string

Query Parameters

contractId
integer<int64>
required

Subscription contract ID to add discount to

api_key
string

API Key (Deprecated - Use Header X-API-Key instead)

percentage
integer<int32>

Percentage discount value (use with discountType=PERCENTAGE)

discountTitle
string

Display title for the discount

recurringCycleLimit
integer<int32>

Number of billing cycles discount applies (null for unlimited)

appliesOnEachItem
boolean

Apply discount to each item individually (true) or entire order (false)

amount
number<double>

Fixed amount discount value (use with discountType=FIXED_AMOUNT)

discountType
string

Discount type: PERCENTAGE or FIXED_AMOUNT

Response

Discount successfully created and applied to subscription

billingAttempts
object
billingPolicy
object
createdAt
object
customAttributes
object[]
customer
object
customerPaymentMethod
object
deliveryMethod
object
deliveryPolicy
object
deliveryPrice
object
discounts
object
get__typename
string
id
string
lastPaymentStatus
enum<string>
Available options:
SUCCEEDED,
FAILED,
$UNKNOWN
lines
object
nextBillingDate
object
note
string
originOrder
object
status
enum<string>
Available options:
ACTIVE,
PAUSED,
CANCELLED,
EXPIRED,
FAILED,
$UNKNOWN
updatedAt
object