Skip to Content
TillorManual
Payment groups

Update Payment Group

Access

Member of the organization with this permission:

  • payments:write

An API key with scopes also needs the permission among its scopes.

PATCH
/orgs/{organizationId}/payment-groups/{id}

Updates an OPEN payment group: name, description, and/or metadata (integration JSON; send null to clear metadata). ASSIGNED groups are immutable.

Authorization

ApiKeyAuth
headerx-api-key<token>

API key for authentication

Path Parameters

organizationId*string

The ID or slug of the organization

id*string

Request Body

application/json
  1. body
name?string
Length1 <= length
description?string|null
metadata?|null

Response Body

Updated payment group.

application/json
  1. response
Example Request
curl -X PATCH 'https://api.tillor.eu/orgs//payment-groups/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
null

Get Payment Group GET

Retrieves a payment group by its ID, optionally with member payments and assigned invoice. Pass `withStats` (e.g. `true`, `yes`, bare `?withStats`) to add `paymentCount`, `totalAmount`, and `totalAmountRemaining` (when member refunds apply) aggregated across member payments (same fields as the list endpoint).

Delete Payment Group DELETE

Deletes an OPEN payment group. Member payments are unlinked from the group (ON DELETE SET NULL); payment rows are not deleted.