> ## 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.

# Create a payment request

> Create a contractor payment request in your Plane workspace.

### Parameters

<ParamField body="worker" type="string" required>
  The ID of the worker submitting or receiving this payment request.
</ParamField>

<ParamField body="amount" type="string" required>
  The requested amount in decimal format.
</ParamField>

<ParamField body="currency" type="string" required>
  Three-letter ISO currency code, in uppercase.
</ParamField>

<ParamField body="reference" type="string">
  Optional external reference, such as an invoice number.
</ParamField>

<ParamField body="note" type="string">
  Optional memo attached to the request.
</ParamField>

<ParamField body="period" type="object">
  Optional period this request is associated with.

  <Expandable title="child attributes">
    <ResponseField name="starts" type="string">
      Inclusive start date for the period.
    </ResponseField>

    <ResponseField name="ends" type="string">
      Inclusive end date for the period.
    </ResponseField>
  </Expandable>
</ParamField>

### Returns

Returns the created payment request ID. Retrieve the full
[Payment Request object](/reference/payment-requests/object) with
[Get a payment request](/reference/payment-requests/get).

<ResponseExample>
  ```json Response theme={null}
  {
    "id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX"
  }
  ```
</ResponseExample>