---
title: "List payment links and subscriptions for a client"
method: GET
path: "/clients/{id}/payments"
tags: ["Agencies"]
---

# List payment links and subscriptions for a client

`GET /clients/{id}/payments`

## Request

- Base URL: `https://api.hypamoon.com/api/v1`
- URL: `https://api.hypamoon.com/api/v1/clients/{id}/payments`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://app.hypamoon.com/oauth/authorize`, token URL `https://api.hypamoon.com/oauth/token`, scopes: `clients:read`)

The payment links and subscriptions your agency made for this client project, newest first. Without the payer's email or name.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `limit` integer

## Response `200`

The payments.

- object
  - `object` 'list', required
  - `data` object[], required
    - `object` 'client_payment_link' | 'client_subscription', required
    - `id` string, uuid, required
    - `client_project_id` string, uuid, required
    - `status` 'open' | 'paid' | 'failed' | 'expired' | 'active' | 'canceled', required
    - `amount_cents` integer, required
    - `fee_cents` integer, required
    - `currency` string, required
    - `description` string, required
    - `interval` 'month' | 'year' | 'null', nullable
    - `paid_until` string, nullable
    - `canceled_at` string, nullable
    - `test` boolean, required
    - `checkout_url` string, nullable, required
    - `paid_at` string, nullable, required
    - `created_at` string, required

## Other responses

- `401`: Unauthorized: unauthorized, missing_api_key, invalid_api_key, api_key_revoked, project_deleted.
- `403`: Forbidden: project_not_enabled, key_mode_mismatch, missing_scope, verification_required.
- `404`: Not Found: not_found.
- `422`: Unprocessable Content: validation_failed.
- `429`: Too Many Requests: rate_limited.
- `500`: Internal Server Error: internal_error.
- `503`: Service Unavailable: service_unavailable.

---

[API](https://skmtc.dev/hypamoon/apis/hypamoon-api.md) · [All operations](https://skmtc.dev/hypamoon/apis/hypamoon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hypamoon/apis/hypamoon-api/revisions/9f0b90004c06?raw)