Skip to main content
GET
Get a platform fee

Authorizations

Authorization
string
header
required

Bearer token authentication. Pass your API key as Authorization: Bearer sk_.... See Authentication for keys, scopes, and sandbox vs production.

Path Parameters

fee_id
string
required

The platform fee's ID.

Response

The platform fee.

id
string

The platform fee's unique identifier, prefixed pf_.

Example:

"pf_8c1e04a7b93f2d6540ab1234"

charge
string

The charge that this fee was struck against, prefixed ch_.

Example:

"ch_9f4c1d2e7b6a4f8e9c0d1a2b3c4d5e6f"

collected_from
string

The account the fee was collected from: the seller on a destination charge, or the merchant itself on a direct charge.

Example:

"acct_3Wq8ZfT1yHnJ5sVe"

earned_by
string

The platform that earned the fee.

Example:

"acct_7KpQ2mNv4XbR9dLc"

amount
string

The fee amount, as a decimal string in currency.

Example:

"20000.00"

currency
string

The currency the sale was struck in, before any conversion, as an ISO 4217 code.

Example:

"NGN"

amount_refunded
string

How much of this fee has been reversed. Currently always "0.00": a platform fee is not reversed when its charge is refunded.

Example:

"0.00"

refunded
boolean

Whether the fee has been fully reversed. Derived from amount_refunded against amount, so it cannot disagree with them.

Example:

false

created_at
string

When the fee was recorded, ISO 8601 in UTC.

Example:

"2026-08-07T11:04:22.518Z"