List payment schedules

get

https://sandbox.numeral.io/v1/payment_schedules

List and filter payment schedules.

Create a payment schedule with the payment_schedule attribute of Create payment order.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

1 to 100

Defaults to 25

starting_after

uuid

The ID of the object from which your list request will start. It is not included in the result.

sort_order

string

enum

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

Allowed:

start_date

date

The creation date of the payment schedule.

end_date

date

The creation date of the payment schedule.

status

string

enum

The status of the payment schedule.

Allowed:

interval

string

enum

The interval of the payment schedule.

Allowed:

original_payment_id

uuid

The ID of the payment order the payment schedule was created with.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400Validation error.