recurringPayments

QUERY

Returns recurring payments.

Arguments

query

SqlQuery

The query to filter the recurring payments with based on Pay Theory defined data. Detailed information about the query object can be found here.

limit

Int

The number of recurring payments to return.

offset

String

The value of the offset item for which the list is being sorted.

direction

MoveDirection

The direction of the pagination. Makes sure the results are returned in the correct order.

Values

BACKWARDFORWARD

offset_id

String

The recurring_id of the offset item.

Response

RecurringPayments

items

[RecurringPayment]| null

List of Recurring Payments.

total_row_count

Int| null

Total number of rows matching the query.

Examples

List recurring schedules

Filters on merchant_uid. remaining_payments is null for schedules with no end date.

SUCCESS 200

GRAPHQL

query RecurringPayments($query: SqlQuery, $limit: Int) {
  recurringPayments(query: $query, limit: $limit) {
    items {
      recurring_id
      merchant_uid
      recurring_name
      amount_per_payment
      fee_per_payment
      total_amount_per_payment
      fee_mode
      payment_interval
      prev_payment_date
      next_payment_date
      remaining_payments
      status
      is_active
      created_date
    }
    total_row_count
  }
}