coupon

Graphql fields and variables for the coupon query

The coupon record that can be applied to a subscription

Scope required: product:read

For a complete list of possible response fields see the Coupon type.

query coupon ($id: ID, $code: String) {
  coupon (id: $id, code: $code) {
    active
    couponCode
    createdAt
    currencyId
    description
    discountAmount
    discountPercentage
    duration
    id
    name
    planId
    redemptionEndDate
    redemptionsCount
    redemptionsMax
    remainingPeriods
    updatedAt
  }
}

Arguments

Name	Type	Description
id	ID	ID or Code required
code	String	ID or Code required

Response

• Coupon