Create Coupon

Creates a new discount coupon.

Mutation

Mutation

mutation CreateCoupon($input: CreateCouponInput!) {
  createOneCoupon(input: $input) {
    id
    code
    status
    type
    discountValue
    duration
    durationInMonths
    maxRedemptions
  }
}

{
  "input": {
    "code": "SAVE20",
    "type": "PERCENTAGE",
    "discountValue": 20,
    "duration": "FOREVER",
    "maxRedemptions": 100
  }
}

{
  "data": {
    "createOneCoupon": {
      "id": "coupon-123",
      "code": "SAVE20",
      "status": "ACTIVE",
      "type": "PERCENTAGE",
      "discountValue": 20,
      "duration": "FOREVER",
      "durationInMonths": null,
      "maxRedemptions": 100
    }
  }
}

Parameters

input · CreateCouponInput · required

Input for creating a coupon

Show properties

code · String · required

Unique coupon code

type · CouponType · required

PERCENTAGE or FIXED_AMOUNT

discountValue · Float · required

Discount amount or percentage

duration · CouponDuration

ONE_TIME, REPEATING, or FOREVER

durationInMonths · Int

Months for REPEATING duration

maxRedemptions · Int

Maximum total uses

currency · Currency

Currency for FIXED_AMOUNT type

environmentId · UUID

Environment ID

Examples

Percentage Discount

{
  "input": {
    "code": "SAVE20",
    "type": "PERCENTAGE",
    "discountValue": 20,
    "duration": "FOREVER"
  }
}

Fixed Amount Discount

{
  "input": {
    "code": "SAVE10",
    "type": "FIXED_AMOUNT",
    "discountValue": 10,
    "currency": "USD",
    "duration": "ONE_TIME"
  }
}

Limited Duration

{
  "input": {
    "code": "TRIAL3",
    "type": "PERCENTAGE",
    "discountValue": 50,
    "duration": "REPEATING",
    "durationInMonths": 3
  }
}

Related Operations

• Set Coupon on Customer - Apply coupon
• List Coupons - Query coupons