Skip to main content
GET
/
v1
/
payment-requests
/
{id}
Get a payment request
curl --request GET \
  --url https://api.plane.com/v1/payment-requests/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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
}

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.

​
Parameters

​
id
string
required
The ID of a payment request object.

​
Returns

Return the Payment Request object. 
{
  "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
}