> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plane.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List payment requests

> Returns a list of all payment requests in your Plane workspace.

### Parameters

<ParamField query="status" type="string">
  Only return payment requests in this status, one of `pending`, `approved`, `declined`,
  `processed`, or `cancelled`.
</ParamField>

<ParamField query="limit" type="number">
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
  default is 10.
</ParamField>

<ParamField query="starting_after" type="string">
  A cursor for use in pagination. `starting_after` is an object ID that defines your place in the
  list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`,
  your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the
  list.
</ParamField>

<ParamField query="ending_before" type="string">
  A cursor for use in pagination. `ending_before` is an object ID that defines your place in the
  list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`,
  your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of
  the list.
</ParamField>

### Returns

A dictionary with a `payment_requests` property that contains an array of
[Payment Request](/reference/payment-requests/object) objects.

<ResponseExample>
  ```json Response theme={null}
  {
    "payment_requests": [
      {
        "id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX",
        "worker": "wr_anqRSFcK36ie85",
        "amount": "1200.00",
        "currency": "EUR",
        "status": "pending",
        "reference": "EV1S3GDM",
        "note": "Payment for July",
        "period": {
          "starts": "2023-07-01",
          "ends": "2023-07-31"
        },
        "documents": [],
        "approvals": [],
        "payment": null
      }
    ]
  }
  ```
</ResponseExample>
