Developer docs
/
Rebilly API
/
Fees
/
Create a fee entry

Experimental Create a fee entry

Creates a fee entry.

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

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
Request Body schema: application/json
required
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.

post
/fees
Request samples
application/json

Transaction fees for Stripe. Discount rate fees are a separate record.

{
"type": "buy",
"name": "Stripe transaction fees",
"filter": "type:sale,capture;result:approved;gatewayAccountId:stripe",
"formula": {
"type": "fixed-fee",
"currency": "USD",
"amount": 0.3
}
}
Responses

201

Fee entry created.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

Response samples
application/json

Stripe transaction fees. Discount rate fees are a separate record.

{
"id": "fee_01GQT145JX3XBRJ8K812Y3GRE9",
"type": "buy",
"name": "Stripe transaction fees",
"filter": "type:sale,capture;result:approved;gatewayAccountId:stripe",
"formula": {
"type": "fixed-fee",
"currency": "USD",
"amount": 0.3
},
"createdTime": "2021-12-15T14:15:22Z",
"updatedTime": "2021-12-15T14:15:22Z",
"_links": [

]
}