coupons

Graphql fields and variables for the coupons 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 CouponConnection type.

query coupons ($after: String, $before: String, $first: Int, $last: Int, $filter: String, $viewId: ID, $sort: String) {
  coupons (after: $after, before: $before, first: $first, last: $last, filter: $filter, viewId: $viewId, sort: $sort) {
    edges {
      cursor
      node {
        active
        couponCode
        createdAt
        currencyId
        description
        discountAmount
        discountPercentage
        id
        name
        planId
        redemptionEndDate
        redemptionsCount
        redemptionsMax
        updatedAt
      }
    }
    totalCount
    pageInfo {
      startCursor
      endCursor
      hasNextPage
      hasPreviousPage
    }
  }
}

Arguments

Name
Type
Description

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.

filter

String

viewId

ID

sort

String

Response

Last updated

Was this helpful?