Skip to main content
inputCreatePaymentCouponInput

Fields

Per-currency fixed discounts. Use with an amount-off Promo Code; omit for percentage.

clientMutationId
String

A unique identifier for the client performing the mutation.

code
String!
required

The code a member enters to redeem the discount. Must be unique among active Promo Codes.

couponType

Whether the discount is a percentage or a fixed amount off.

description
String

Host-facing description of the Promo Code. Plain text.

duration

How long the discount applies: once, forever, or repeating.

durationInMonths
Int

Number of months a repeating discount applies. Required when duration is repeating; must be omitted otherwise.

percentageOff
Int

Percent off the plan price (0-100). Use with a percentage Promo Code; omit for amount-off.

planIds
[ID!]

Payment Plans to restrict the Promo Code to (resource IDs or GlobalIDs). Omit to apply it to every plan.