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

# Payment Links

> Create and manage reusable payment links

A payment link is a shareable URL that customers open to initiate a payment. Each link has a fixed price. When a customer opens a link, a checkout session is created for them automatically.

## URL parameters

| Parameter       | Description                                                                                                                                                                                                                                                |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `prefill_email` | Pre-fills the customer email on the session so the checkout email step is skipped, e.g. `/l/{slug}?prefill_email=jane@example.com`. Useful when your own page already captured the email. Invalid values are ignored and the email step is shown as usual. |

<Note>
  Payment links require `links:read` or `links:write` scope depending on the operation.
</Note>

## The payment link object

| Field          | Type           | Description                                          |
| -------------- | -------------- | ---------------------------------------------------- |
| `id`           | uuid           | Unique identifier                                    |
| `object`       | string         | Always `"payment_link"`                              |
| `slug`         | string         | URL-safe identifier. The checkout URL is `/l/{slug}` |
| `title`        | string         | Display name shown on the checkout page              |
| `description`  | string \| null | Optional description                                 |
| `fiatAmount`   | string         | Price as a decimal string, e.g. `"49.99"`            |
| `fiatCurrency` | string         | 3-letter ISO currency code, e.g. `"USD"`             |
| `successUrl`   | string \| null | Redirect after successful payment                    |
| `cancelUrl`    | string \| null | Redirect if the customer cancels                     |
| `active`       | boolean        | Inactive links cannot create new sessions            |
| `checkoutUrl`  | string         | Shareable URL to give to customers                   |
| `createdAt`    | datetime       |                                                      |
| `updatedAt`    | datetime       |                                                      |

<api-reference openapi="GET /payment_links" />

<api-reference openapi="POST /payment_links" />

<api-reference openapi="GET /payment_links/{id}" />

<api-reference openapi="PATCH /payment_links/{id}" />

<api-reference openapi="DELETE /payment_links/{id}" />