---
name: payment-links-routes
description: Handle 5 OpenAPI operation(s) under /v1/payment_links for the payment links route group.
---

# payment links API Routes

Handle 5 OpenAPI operation(s) under /v1/payment_links for the payment links route group.

Use the generated operation tools to make real API calls. Do not invent API responses.
If a tool reports missing setup, return the exact setup field name to the caller.
For write, update, or delete operations, state the intended action before calling the tool.

## Operations

### get_payment_links

- Operation ID: `get_payment_links`
- Route: `GET /v1/payment_links`
- Mode: READ
- Summary: List all payment links
- Parameters:
  - `active` in `query`
  - `ending_before` in `query`
  - `expand` in `query`
  - `limit` in `query`
  - `starting_after` in `query`
- Body: JSON request body accepted.

### post_payment_links

- Operation ID: `post_payment_links`
- Route: `POST /v1/payment_links`
- Mode: WRITE
- Summary: Create a payment link
- Body: JSON request body accepted.

### get_payment_links_payment_link

- Operation ID: `get_payment_links_payment_link`
- Route: `GET /v1/payment_links/{payment_link}`
- Mode: READ
- Summary: Retrieve payment link
- Parameters:
  - `expand` in `query`
  - `payment_link` in `path` required
- Body: JSON request body accepted.

### post_payment_links_payment_link

- Operation ID: `post_payment_links_payment_link`
- Route: `POST /v1/payment_links/{payment_link}`
- Mode: WRITE
- Summary: Update a payment link
- Parameters:
  - `payment_link` in `path` required
- Body: JSON request body accepted.

### get_payment_links_payment_link_line_items

- Operation ID: `get_payment_links_payment_link_line_items`
- Route: `GET /v1/payment_links/{payment_link}/line_items`
- Mode: READ
- Summary: Retrieve a payment link's line items
- Parameters:
  - `ending_before` in `query`
  - `expand` in `query`
  - `limit` in `query`
  - `payment_link` in `path` required
  - `starting_after` in `query`
- Body: JSON request body accepted.
