API ReferenceBillingFees

Get a fee

Retrieve a fee by ID, stage, and version.

Required permissions: fee:read.

Authentication

AuthorizationBearer

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

Path parameters

fee_idstringRequired
The ID of the fee.

Headers

X-Penny-As-Businessstring or nullOptional

Act on behalf of another business that has granted you access. Requires the business:act_as permission.

Query parameters

stageintegerOptional>=0Defaults to 0

Stage to return; 0 returns the latest.

versionintegerOptional>=0Defaults to 0

Resource version to return; 0 returns the latest.

Response

The fee.
fee_idstring
Unique identifier for the fee, assigned by Penny.
versioninteger
A counter, assigned by Penny, that increases each time this fee is updated.
version_timedatetime
When this version of the fee was recorded.
stageinteger

Tracks how far this fee has progressed through its billing lifecycle, increasing each time the fee moves to its next stage — for example, from assessment to collection.

stage_timedatetime
When the fee entered its current lifecycle stage.
currencyenum

The three-letter ISO 4217 currency code the fee amount is stated in.

Allowed values:
amountstringformat: "^-?\d+(\.\d+)?$"
The total amount of this fee, expressed as a decimal string in the fee's currency.
statusenum
The fee's current status in its billing lifecycle, such as assessed, pending collection, or collected.
sourceobject
The entity that caused this fee to be assessed, such as a specific card, transaction, or account.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error