Skip to main content
objectPaymentCoupon

Implements

Fields

Per-currency fixed discounts. Empty for percentage Promo Codes.

code
String!

The code a member enters to redeem the discount.

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

createdAt
ISO8601DateTime!

When the Promo Code was created.

description
String

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

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

durationInMonths
Int

Number of months a repeating discount applies. Null unless duration is repeating.

id
ID!

ID of the object.

percentageOff
Int

Percent off the plan price (0-100). Null for amount-off Promo Codes.

plans

Payment Plans the Promo Code is restricted to. Empty when it applies to every plan.

Redemptions of this Promo Code, oldest first. Empty for non-host viewers.

Arguments
after
String

Returns the elements in the list that come after the specified cursor.

before
String

Returns the elements in the list that come before the specified cursor.

first
Int

Returns the first n elements from the list.

last
Int

Returns the last n elements from the list.

term
String

Filter by a case-insensitive substring match on the Payment Plan name or the member's first or last name.

resourceId
ID!

Resource ID for this object, for interop with the Admin API.

Whether the Promo Code is active or inactive.

timesRedeemed
Int

How many times the Promo Code has been redeemed. Null until first computed.

updatedAt
ISO8601DateTime!

When the Promo Code was last updated.