Skip to main content
GET
Retrieve a fee charge

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

fee_charge_id
string
required

Response

OK

amount_fee
string
required

Fee amount before tax.

Example:

"10.00"

amount_tax
string
required

Tax amount charged.

Example:

"2.00"

amount_total
string
required

Total fee and tax amount.

Example:

"12.00"

collected_amount
string
required

Cash actually collected for the charge so far.

Example:

"8.00"

collected_at
string<date-time> | null
required

Date and time the charge was collected.

Example:

"2026-02-01T09:30:00Z"

collections
FeeCollection · object[]
required

Collection events that paid the charge down, in the order they were recorded. Empty means nothing has been collected.

created_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the resource was created.

currency
enum<string>
required

Currency of the charge amounts.

Available options:
EUR,
USD,
GBP
fee
Fee · object
required

Fee represented by this charge.

id
string
required

Unique resource identifier.

is_fully_refunded
boolean
required

Whether the full charge has been refunded.

is_partially_refunded
boolean
required

Whether part of the charge has been refunded.

modified_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the resource was last modified.

outstanding_amount
string
required

What is still owed on the charge: the uncollected portion net of refunds, zero until the charge becomes due.

Example:

"4.00"

period_end
string<date> | null
required

End date of the period covered by the charge.

Example:

"2026-01-31"

period_start
string<date> | null
required

Start date of the period covered by the charge.

Example:

"2026-01-01"

refundable_amount
string
required

Amount remaining eligible for refund.

Example:

"7.00"

refunded_amount
string
required

Amount already refunded.

Example:

"5.00"

refunds
Refund · object[]
required

Refunds issued for the fee charge.

Transaction associated with the fee charge.

Amount of the associated transaction.

Example:

"250.00"

tax_rate
string | null
required

Tax rate applied to the fee charge.

Example:

"0.20"