JOjoinsophic
billing

Retrieve a fee charge

Changed on

Retrieve a fee charge by ID.

get/fee-charges/{fee_charge_id}

Request

  • Base URL
    https://api.engine.usesophic.com
  • Auth
    HTTP bearer

Path parameters

fee_charge_idstring required

Response

OK

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

The notional the fee was priced on. Null when the amount does not depend on a notional, as a flat fee does not.

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

  • 6a63920239d8Revision changes
    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from no type to string for status

    • warning

      added the new EUR enum value to the // response property for the response status

    • warning

      added the new EUR enum value to the response property for the response status

    • warning

      added the new EUR enum value to the // response property for the response status

    • warning

      added the new GBP enum value to the // response property for the response status

    • warning

      added the new GBP enum value to the response property for the response status

    • warning

      added the new GBP enum value to the // response property for the response status

    • warning

      added the new USD enum value to the // response property for the response status

    • warning

      added the new USD enum value to the response property for the response status

    • warning

      added the new USD enum value to the // response property for the response status

    • info

      removed from the // response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • aa43bab6253cRevision changes
    • breaking

      response property context/additionalProperties/ list-of-types was widened by adding types array to media type application/json of response 400