About coupons

What are coupons on the Inspire Payments Platform?

Overview

You can use coupons to give discounts to your customers. To give a discount, you send your customer a promotion code. The customer can use a coupon by entering the promotion code at the time of payment.

Types of coupons

These are the types of coupons you can create for your customers:

• Percentage - discounts the price by a percentage.
• Fixed amount - takes the fixed amount off the price.
• Price override - the customer is entitled to purchase at the price set by the coupon.
• Trial - the customer is entitled to a free trial of your product.

Applying coupons

A coupon can be applied to an invoice or an order.

Coupons are applied to invoices in one of three ways:

• Once - give your customer a one-time discount.
• Forever - the customer gets a discount every time they purchase the product.
• For a set number of cycles - the coupon can be used on a fixed number of recurring invoices.

One coupon can be used per subscription.

Coupon codes

To use a coupon, a customer can enter a coupon code before paying for a product.

Customers are tracked by their email. The coupons are validated against the end user's email address.

Coupon codess can be disabled before the coupon reaches its total discount budget using the Archive coupon code endpoint.

To make the coupon code active again, use Unarchive coupon code.

Disabling coupons

Coupons have a Redemption date - the date after which the customer cannot activate the coupon (the coupon expires).

A coupon has a budget associated with it. That is the total discounts you are willing to give customers on a specific product. Coupons expire when the budget is reached.

Properties of the Coupon Object

• id (String): Coupond ID.
• name (String): Coupon name.
• discountPercentage (Number): Discount product price by this percentage.
• discountAmount (Number): Discount product price by this ammount.
• maximumAmount (Number): Maximum discount ammount allowed by this coupon.
• durationMonths (Number): How many months can this coupon be applied. Relevant for coupons that can be applied repetedly.
• trialDays (Number): How many trial days this coupon grants.
• currency: Object describing the coupon currency.
• couponDurations (String): Describes the type of duration for coupons that can be applied repetedly. Possible values:
  • Forever
  • Once
  • Multiple months
• couponTypes: Object describing the coupon type.
• maxRedemptions (Number): The maximum number of allowed redemptions.
• redemptions (Number): Number of redemptions so far.
• expirationDate (String): Date and time when the coupon expires.
• additionalTrialDays (Number): Number of additional trial days.
• isUnique (Boolean): If True, this coupon cannot be combined with other coupons.
• createdDate (String): Date and time when the coupon was created.
• valid (Boolean): True if the coupon is valid, False otherwise.
• codes (Object Array): Array of coupon code objects.
• priceTiers (String Array): Price tiers.
• metadata (Object): Custom properties stored as key-value pairs.
• subscriptionCouponRedeems (Object Array): Array of objects describing coupon redemptions.