Payments · Couplr Developers

Base URL: https://couplrfsm.com/api/v1. Conventions shared by every endpoint (examples, ids, dates, money) are on the API reference page. Errors, pagination and idempotency are in Errors, limits and retries.

List an invoice's payments#

GET /api/v1/invoices/{id}/payments · requires the payments:read ability

Every payment collected on one invoice, oldest first. Not paginated.

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes

Example request

curl "https://couplrfsm.com/api/v1/invoices/9d3f6a52-0c1e-4c57-9d0a-3a0f8a4a7b21/payments" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response (200)

{
    "data": [
        {
            "id": 5581,
            "invoice_id": "9d3f6a52-0c1e-4c57-9d0a-3a0f8a4a7b21",
            "invoice_number": "1047",
            "customer_id": 1842,
            "amount": "389.00",
            "method": "card",
            "status": "paid",
            "paid_at": "2026-12-02T18:01:44+00:00",
            "invoice_refunded_amount": "0.00",
            "invoice_refund_pending_amount": "0.00",
            "created_at": "2026-12-02T18:01:44+00:00",
            "updated_at": "2026-12-02T18:01:44+00:00"
        }
    ]
}

Errors

Status	When
`401`	No key (`api_key_missing`), the key is unknown or revoked (`api_key_invalid`), the key had an end date that has passed (`api_key_expired`), or the key belongs to a private trial sandbox whose access window has ended (`sandbox_expired`).
`403`	The key lacks the ability this endpoint needs (`ability_missing`), no admin user is left to act for the key (`no_acting_admin`), or the company's account is not yet verified.
`404`	No such record in this company (`not_found`).
`429`	Too many requests (`rate_limited`). Wait `Retry-After` seconds.

List payments#

GET /api/v1/payments · requires the payments:read ability

Payments collected on the company's invoices, most recently paid first. updated_since also returns a payment whose invoice changed, so a refund brings the payment back.

Query parameters

Name	Type	Required	Description
`page`	integer	No	Default: `1`.
`per_page`	integer	No	Values above 100 are served as 100. Default: `25`.
`updated_since`	string (date-time)	No	Only records changed at or after this time. ISO 8601, for example `2026-11-14T15:00:00Z`.
`invoice_id`	string (uuid)	No
`customer_id`	integer	No
`method`	string: `card`, `bank`, `financing`, `cash`, `check`, `other`	No
`paid_from`	string (date)	No
`paid_to`	string (date)	No

Example request

curl "https://couplrfsm.com/api/v1/payments" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response (200)

{
    "data": [
        {
            "id": 5581,
            "invoice_id": "9d3f6a52-0c1e-4c57-9d0a-3a0f8a4a7b21",
            "invoice_number": "1047",
            "customer_id": 1842,
            "amount": "389.00",
            "method": "card",
            "status": "paid",
            "paid_at": "2026-12-02T18:01:44+00:00",
            "invoice_refunded_amount": "0.00",
            "invoice_refund_pending_amount": "0.00",
            "created_at": "2026-12-02T18:01:44+00:00",
            "updated_at": "2026-12-02T18:01:44+00:00"
        }
    ],
    "meta": {
        "page": 1,
        "per_page": 25,
        "total": 1,
        "last_page": 1
    }
}

Errors

Status	When
`401`	No key (`api_key_missing`), the key is unknown or revoked (`api_key_invalid`), the key had an end date that has passed (`api_key_expired`), or the key belongs to a private trial sandbox whose access window has ended (`sandbox_expired`).
`403`	The key lacks the ability this endpoint needs (`ability_missing`), no admin user is left to act for the key (`no_acting_admin`), or the company's account is not yet verified.
`422`	A parameter or field is invalid (`validation_failed`). `errors` maps each field to its messages.
`429`	Too many requests (`rate_limited`). Wait `Retry-After` seconds.