RoundPlanAPI reference

Trips

List a trip's payments

GET/api/v1/trips/{id}/paymentsScope payments:read

The same payments the client sees on their trip page: never cancelled ones or ones still being prepared. Returned whole, never paged, as one list: what is due first, by due date (undated last); then what is paid, most recent first. The page groups split payments together; this list does not.

Amounts are integers in minor units: 125000 in EUR is €1,250.00. See Money, dates and versions.

Path parameters

idstring

Query parameters

No parameters.

Returns

A list of Payment objects.

object"list"
next_cursorstring or null

Errors

401unauthorizedNo key, a malformed one, or a key that does not exist or was revoked. Send it as Authorization: Bearer <key>.
403api_not_enabledRoundPlan has not turned on API access for this agency.
403subscription_inactiveThe agency's trial expired or its subscription ended.
403insufficient_scopeThe key cannot read this. An owner adds payments:read to a key in Settings → API.
404not_foundNothing with that id in this agency.
429rate_limitedToo many requests. Wait the seconds in Retry-After. See Errors and rate limits.
500internal_errorSomething went wrong on our side. Retry later.