Skip to main content

payments

A list of payments.

The eventIds argument can be used to specify the events for which the payments are returned. When not specified, the events to which the calling principal has access to are used. Sandboxed events are always excluded.

See PaymentSearchFilterInput for details on how the optional input argument can be used to filter payments.

Optionally, the lastModified argument can be supplied to narrow the list of returned payments based on their last modified date.

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).
payments(
eventIds: [ID!]! =
input: PaymentSearchFilterInput! = [object Object]
lastModified: OpenEndedDateTimeRangeFilter
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [Payment!]!

Arguments​

payments.eventIds ● [ID!]! non-null scalar​

payments.input ● PaymentSearchFilterInput! non-null input​

payments.lastModified ● OpenEndedDateTimeRangeFilter input​

payments.limit ● PaginationLimit! non-null scalar​

payments.offset ● NonNegativeInt! non-null scalar​

Type​

Payment object​

Represents a payment.