---
title: "Create a new ClioPaymentsLink"
method: POST
path: "/clio_payments/links.json"
tags: ["Clio Payments Links"]
---

# Create a new ClioPaymentsLink

`POST /clio_payments/links.json`

Outlines the parameters and data fields used when creating a new ClioPaymentsLink

## Query parameters

- `fields` string

## Headers

- `X-API-VERSION` string

## Request body

- object
  - `data` object, required
    - `amount` number, double — The amount to be paid. If not provided, the client will be able to specify an amount.
    - `currency` string, required — The currency the payment will be processed in. The supported currency depends on the account's location ('USD' for a US account). The currency must be a valid ISO 4217 currency code.
    - `description` string, required — Only applicable for a direct payment. A short description of the purpose of the payment. Max 255 characters.
    - `destination_account` object, required
      - `id` integer, required — The ID of the bank account that the payment will be deposited into.
    - `destination_contact` object
      - `id` integer — Only applicable for a direct payment. The contact that the payment will be associated with. If not defined, and the payment is collecting an unallocated balance, then the payment can be associated with a contact manually within Manage after it has been made.
    - `duration` integer, required — The amount of time, in seconds, that the payment link will be active for. The maximum allowed value is '7776000' (90 days in seconds).
    - `email_address` string — Pre-fills the relevant field for the client when filling out their details in the payment link.
    - `is_allocated_as_revenue` boolean — Only applicable for a direct payment. If true, the payment will be allocated as revenue and cannot be later linked to a bill. If false, the payment will be collected as an unallocated balance. Payments into trust can not be allocated as revenue. Defaults to false.
    - `subject` object, required
      - `id` integer, required — The ID of the record associated with the payment link.
      - `type` 'BankAccount' | 'Bill' | 'Contact', required — The type of the record associated with the payment link. The type of record determines the behavior of the payment link. Type of subject object: * 'BankAccount' results in a payment link for a direct payment. * 'Bill' results in a payment link for paying an existing invoice or trust request. * 'Contact' results in a payment link for paying the outstanding invoices of a contact.

## Response `201`

Created

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity
- `429` — Too Many Requests

---

[API](https://skmtc.net/clio/apis/clio-api-documentation.md) · [All operations](https://skmtc.net/clio/apis/clio-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clio/clio-api-documentation/revisions/73791ddd1207/schema)
