Skip to main content

Create coupon in Paddle

Create coupon in Paddle.

Application

  • Paddle

Inputs (what you have)

NameDescriptionData TypeRequired?Example
Connected AccountThe connected account to use for the requestConnected AccountYes
Coupon typeEither product (valid for specified products or subscription plans) or checkout (valid for any checkout)Predefined Choice ListNo
Product ID 1Text (Short)No
Product ID 2Text (Short)No
Product ID 3Text (Short)No
Discount typeEither flat or percentagePredefined Choice ListNo
Discount amount %Discount amount in percentageNumberNo
CurrencyThe currency must match the balance currency specified in your accountPredefined Choice ListNo
Allowed usesNumber of times a coupon can be used in a checkout. This will be set to 999,999 by default, if not specifiedNumberNo
Coupon codeWill be randomly generated if not specifiedText (Short)No
Coupon prefixPrefix for generated codes. Not valid if coupon_code is specifiedText (Short)No
DescriptionDescription of the coupon. This will be displayed in the Seller DashboardText (Long)No
ExpiresThe coupon will expire on the date at 00:00:00 UTCDatetimeNo
Group nameThe name of the coupon group this coupon should be assigned toText (Short)No
Number of couponsNumber of coupons to generate. Not valid if coupon_code is specifiedNumberNo
Recurring?If the coupon is used on subscription products, this indicates whether the discount should apply to recurring payments after the initial purchaseTrue/FalseNo

Outputs (what you get)

NameDescriptionData TypeRequired?Example
JSON OutputJSON output returned by the APIText (Long)No

Outcomes

NameDescription
SuccessThis status is selected if the job has successfully completed.
UnsuccessfulThis status is selected if the job has completed unsuccessfully.

Requirements

  • N/A