JOjoinsophic
billing

Retrieve a fee

Changed on

Retrieve a fee by ID, including its variants.

get/fees/{fee_id}

Request

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

Path parameters

fee_idstring required

Response

OK

aliasstring required

Stable alias of the fee.

chargeable_currenciesobject required

Fee amounts by chargeable currency.

created_atstring date-time required

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

descriptionstring nullable required

Description of the fee.

display_namestring required

Display name of the fee.

fee_type'transaction' | 'recurring' required
idstring required

Unique resource identifier.

modified_atstring date-time required

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

namestring required

Internal name of the fee.

tax_ratestring nullable required

Tax rate applied to the fee.

transaction_typestring nullable required

Transaction type to which the fee applies.

Example response

{
  "tax_rate": "0.20"
}

Changes

  • 6a63920239d8Revision changes
    • breaking

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

    • warning

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

    • warning

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

    • info

      removed from the response property allOf list for the response 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