Skip to main content
GET
List transactions for the organization

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Query Parameters

startDate
string

Inclusive lower bound on transaction createdAt, as an ISO date-time or YYYY-MM-DD. Defaults to endDate - 24h, or to no bound when filtering by contact, booking or membership.

endDate
string

Exclusive upper bound on transaction createdAt, as an ISO date-time or YYYY-MM-DD. Defaults to now, or to no bound when filtering by contact, booking or membership.

paymentStatus
enum<string>

Filter by payment status. When omitted, all statuses are returned.

Available options:
pending,
paid,
void,
failed,
settled,
overdue,
partially_paid,
refunded,
cancelled
contactId
integer

Only transactions charged to this contact (the payer). Lifts the default window when no date bound is sent.

bookingId
integer

Only this booking's transactions - its charge, and any cancellation credit against it. Lifts the default window when no date bound is sent.

membershipId
integer

Only this membership's transactions - its sale, renewals, signup fee and adjustments. Lifts the default window when no date bound is sent.

transactionType
enum<string>

Only transactions of this kind.

Available options:
booking_creation,
booking_cancellation,
membership_creation,
membership_recurrence,
membership_signup_fee,
membership_price_adjustment,
membership_cancellation,
product_sale,
external_program_entry,
checkin_creation,
settlement
limit
integer
default:100

Maximum number of transactions to return.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of transactions to skip.

Required range: x >= 0

Response

List of transactions

id
integer
uuid
string<uuid>

Stable unguessable identifier. Prefer this over id when storing a reference.

description
string | null
transactionType
string | null

TransactionType enum value (e.g. booking_creation, membership_creation, product_sale, membership_recurrence, etc.). A settlement recorded with POST /v1/platform/transactions is settlement.

bookingId
integer | null
membershipId
integer | null
contactId
integer | null

The customer charged, when there is one.

clubId
integer | null

Set on a settlement only; other transactions take their club from their booking or membership.

createdAt
string<date-time>
date
string<date-time>
paymentStatus
enum<string>
Available options:
pending,
paid,
void,
failed,
settled,
overdue,
partially_paid,
refunded,
cancelled
amount
string

Pre-tax amount as a decimal string (e.g. "25.00"). Serialized as a string to preserve precision.

taxAmount
string

Tax portion as a decimal string.

totalAmount
string

Total billed amount as a decimal string (amount + taxAmount).