billing

Retrieve a fee charge

Retrieve a fee charge by ID.

get/fee-charges/{fee_charge_id}

Path parameters

fee_charge_idstring required

Response

amount_feestring required

Fee amount before tax.

amount_taxstring required

Tax amount charged.

amount_totalstring required

Total fee and tax amount.

collected_amountstring required

Cash actually collected for the charge so far.

collected_atstring date-time nullable required

Date and time the charge was collected.

created_atstring date-time required

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

currency'EUR' | 'USD' | 'GBP' required

idstring required

Unique resource identifier.

is_fully_refundedboolean required

Whether the full charge has been refunded.

is_partially_refundedboolean required

Whether part of the charge has been refunded.

modified_atstring date-time required

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

outstanding_amountstring required

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

period_endstring date nullable required

End date of the period covered by the charge.

period_startstring date nullable required

Start date of the period covered by the charge.

refundable_amountstring required

Amount remaining eligible for refund.

refunded_amountstring required

Amount already refunded.

related_transactionstring nullable required

Transaction associated with the fee charge.

related_transaction_amountstring nullable required

Amount of the associated transaction.

tax_ratestring nullable required

Tax rate applied to the fee charge.

Example response

{
  "amount_fee": "10.00",
  "amount_tax": "2.00",
  "amount_total": "12.00",
  "collected_amount": "8.00",
  "collected_at": "2026-02-01T09:30:00Z",
  "collections": [
    {
      "amount": "4.00",
      "collected_at": "2026-07-02T09:00:00Z"
    }
  ],
  "fee": {
    "tax_rate": "0.20"
  },
  "outstanding_amount": "4.00",
  "period_end": "2026-01-31",
  "period_start": "2026-01-01",
  "refundable_amount": "7.00",
  "refunded_amount": "5.00",
  "refunds": [
    {
      "amount": "25.00"
    }
  ],
  "related_transaction_amount": "250.00",
  "tax_rate": "0.20"
}

Changes

Changed in 4 of the 11 revisions of this API.1414

Aug 13, 2026f891f50f1fed3See the full diff
- ○
  added the required property collected_amount to the response with the 200 status
  response-required-property-added
- ○
  added the required property collections to the response with the 200 status
  response-required-property-added
- ○
  added the required property outstanding_amount to the response with the 200 status
  response-required-property-added
Aug 3, 2026250f4b477cbf1See the full diff
- ○
  added the required property fee/allOf[subschema #1: Fee]/variants to the response with the 200 status
  response-required-property-added
Jul 17, 20268e8a8242f1f2149See the full diff
- ▲
  the currency response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ▲
  the fee response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the refunds/items/currency response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property fee/alias from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property fee/chargeable_currencies from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property fee/created_at from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property fee/description from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property fee/display_name from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property fee/fee_type from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property fee/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property fee/modified_at from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property fee/name from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property fee/tax_rate from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property fee/transaction_type from the response with the 200 status
  response-required-property-removed
- ○
  added Currency to the currency response property allOf list for the response status 200
  response-property-all-of-added
- ○
  added Currency to the refunds/items/currency response property allOf list for the response status 200
  response-property-all-of-added
- ○
  added Fee to the fee response property allOf list for the response status 200
  response-property-all-of-added
- ○
  removed the EUR enum value from the currency response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the EUR enum value from the refunds/items/currency response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the GBP enum value from the currency response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the GBP enum value from the refunds/items/currency response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the USD enum value from the currency response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the USD enum value from the refunds/items/currency response property for the response status 200
  response-property-enum-value-removed
Jul 13, 202603da9bc8e86b1See the full diff
- ○
  api tag billing added
  api-tag-added
This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history