Developer docs
/
Rebilly API
/
Fees
/
Retrieve fee entries

Experimental Retrieve fee entries

Retrieves a list of fee entries.

Important: This operation is experimental and may not be backward compatible.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

get
/fees
Responses

200

List of fee entries retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
id
string <= 50 characters

ID of the fee.

type
required
string

Type of fee.

Enum: "buy" "sell"
name
required
string [ 1 .. 255 ] characters

Name of the fee.

filter
string or null [ 1 .. 255 ] characters

Filter that is based on the properties of the transaction and used to determine when to apply the fee.

required
object (FeeFormula)

Formula that is used to calculate the fee.

SettlementSettings (object) or null

Fee settlement settings. This value overrides the gateway account financial settings of the transaction.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

Response samples
application/json
[
{
"id": "fee_01GQT145JX3XBRJ8K812Y3GRE9",
"type": "buy",
"name": "A gateway fee",
"filter": "type:sale,capture;result:approved",


"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",

}
]