DiscountAgreement

An agreement that lets a customer use a discount. It records the context the discount was validated in and tracks its usage.

type DiscountAgreement {
  context: DiscountAgreementContext!
  discount: Discount!
  discountApplications(
    after: String
    before: String
    first: Int
    last: Int
  ): DiscountApplicationConnection!
  discountCode: DiscountCode
  errorLog: [ErrorLogEntry!]!
  id: GlobalID!
  status: DiscountAgreementStatus!
  validated: Boolean!
}

Fields

DiscountAgreement.context ● DiscountAgreementContext! non-null object types

The customer and order details the discount was validated against.

DiscountAgreement.discount ● Discount! non-null object types

The discount the agreement applies.

DiscountAgreement.discountApplications ● DiscountApplicationConnection! non-null object types

The applications of the agreement's discount to price sources.

DiscountAgreement.discountApplications.after ● String scalar types

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

DiscountAgreement.discountApplications.before ● String scalar types

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

DiscountAgreement.discountApplications.first ● Int scalar types

Returns the first _n_ elements from the list.

DiscountAgreement.discountApplications.last ● Int scalar types

Returns the last _n_ elements from the list.

DiscountAgreement.discountCode ● DiscountCode object types

The discount code redeemed for the agreement, if any.

DiscountAgreement.errorLog ● [ErrorLogEntry!]! non-null object types

The latest errors logged against the agreement.

DiscountAgreement.id ● GlobalID! non-null scalar types

The discount agreement's ID.

DiscountAgreement.status ● DiscountAgreementStatus! non-null enum types

The discount agreement's status.

DiscountAgreement.validated ● Boolean! non-null scalar types

Whether the agreement's discount has been validated.

Member Of

DiscountAgreementConnection object ● DiscountAgreementEdge object ● SubscriptionDiscount object