DiscountAutomaticBxgy object

Version unstable

An automatic BXGY discount.

Required access

Apps must have read_discounts access scope.

Connections

  • events (EventConnection!)

    The paginated list of events associated with the host subject.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • comments
    • created_at
    • subject_type
    • verb

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( EventSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

Fields

  • asyncUsageCount (Int!)

    The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.

  • createdAt (DateTime!)

    The date and time when the discount was created.

  • customerBuys (DiscountCustomerBuys!)

    The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

  • customerGets (DiscountCustomerGets!)

    The qualifying items in an order, the quantity of each one, and the total value of the discount.

  • endsAt (DateTime)

    The date and time when the discount ends. For open-ended discounts, use null.

  • startsAt (DateTime!)

    The date and time when the discount starts.

  • status (DiscountStatus!)

    The status of the discount.