Creates an Coupon object
- Parameters:
params - a dict of parameters; valid keys are:
-
amountOff : Amount off of the price of the
product in minor units in the currency of the merchant. While
this field is optional, you must provide either amountOff or
percentOff for a coupon. Example: 1000 = 10.00
-
couponCode : Code that identifies the coupon to
be used. required
-
description : A brief section that describes the
coupon.
-
durationInMonths : Duration in months that the
coupon will be applied after it has first been selected.
-
endDate : Last date of the coupon in UTC millis
that the coupon can be applied to a subscription. This ends
at 23:59:59 of the merchant timezone.
-
maxRedemptions : Maximum number of redemptions
allowed for the coupon. A redemption is defined as when the
coupon is applied to the subscription for the first time.
-
percentOff : Percentage off of the price of the
product. While this field is optional, you must provide
either amountOff or percentOff for a coupon. The percent off
is a whole number.
-
startDate : First date of the coupon in UTC
millis that the coupon can be applied to a subscription. This
starts at midnight of the merchant timezone. required
auth_args - an Authentication object used for the API call. If no value is
passed the gloabl keys simplify.public_key and
simplify.private_key are used. For backwards compatibility the
public and private keys may be passed instead of an
Authentication object.
private_api_key - Private key to use for the API call. If None , the
value of simplify.private_key will be used.
- Returns:
- a Coupon object
|