Skip to main content
POST
Record a payment for a charge

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer
required

Body

application/json
paymentMethodDefinitionId
integer
required

One of your payment methods recorded by hand, from GET /v1/platform/payment-methods.

paymentDate
string<date>

The day the money arrived, YYYY-MM-DD on the club's clock, never after today. Defaults to now.

Response

The charge, paid, with the payment recorded

A billing transaction with amounts, payment status, and links to the originating booking or membership.

outstanding
number
required

What the charge still owes, tax included (0 once recorded)

payment
object
required
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>

The day the charge counts on in every money report: when it was sold, a booking's visit, or the start of the membership period it pays for.

dueDate
string<date-time> | null

The day an unpaid charge falls due (midnight UTC naming the calendar day), set only where that is later than date: a Season Pass sold ahead is dated at its sale and owed from the day it starts. Null means it is due on date.

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