Skip to main content
POST
Pay an invoice

Authorizations

X-SALESBRICKS-KEY
string
header
required

API key for authentication

Path Parameters

invoice_id
string
required
Pattern: ^([a-zA-Z\d\-]+)$

Body

payment_method_id
string
required

The Stripe payment method ID to use for this payment

auto_pay_invoices
boolean | null

Whether to enable auto-pay for future invoices

Response

payment_id
string<uuid>
required
read-only

Unique identifier for the payment

invoice_number
string | null
required
read-only

The invoice number this payment was made against, snapshotted from the invoice version current when the payment was recorded — it does not change when the invoice is later regenerated, so it may differ from the invoice's top-level invoice_number. Falls back to the invoice's current number when no version is linked. Join payments to invoices by ID, not by number.

invoice_version_id
string<uuid> | null
required
read-only

Identifier of the invoice version this payment was made against — the version current when the payment was recorded. Null only when the invoice has no versions (it was never generated).

paid_amount
integer | null
required
read-only

The amount paid

paid_at
string<date-time> | null
required
read-only

the date at which this payment was paid

currency
string
required
read-only

The currency in which the payment is denominated (e.g., USD, EUR)

error
string | null
required
read-only

Any errors that occured during this payment processing