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

Experimental Upsert a fee entry

Creates or updates (upserts) a fee entry.

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

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

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.

put
/fees/{id}
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

200

Fee entry updated.

Response Schema: application/json
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.

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": [

]
}