Skip to Content
TillorManual
Payment groups

Get Payment Group

Acesso

Membro da organização com esta permissão:

  • payments:read

Uma chave de API com scopes também precisa da permissão nos seus scopes.

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

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).

Authorization

ApiKeyAuth
headerx-api-key<token>

API key for authentication

Path Parameters

organizationId*string

The ID or slug of the organization

id*string

Query Parameters

include?|array<>|string
withStats?boolean|string|number|null

Response Body

Payment group; may include aggregate stats when withStats is enabled.

application/json
  1. response
Example Request
curl -X GET 'https://api.tillor.eu/orgs//payment-groups/string'
Example Response
null

Create Payment Group POST

Creates a new payment group. The customer is propagated per member payment from the invoice at assign-time, not stored on the group itself. Optional `metadata` is an integration-owned JSON object for dedupe keys, external shift ids, etc.

Update Payment Group PATCH

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