/
Patch a fee entry

Patch a fee entry
Experimental

Request

Patches a fee entry.

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

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

Bodyapplication/jsonrequired
typestring

Type of fee.

Enum:"buy""sell"
namestring, [ 1 .. 255 ] characters

Name of the fee.

Example:"A gateway fee"
filterstring or null, [ 1 .. 255 ] characters

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

Example:"type:sale,capture;result:approved"
formulaobject(FeeFormula)
settlementSettingsSettlementSettings (object) or null
One of:

Settlement settings. Use these settings to set up settlement accounts.

curl -i -X PATCH \
  'https://www.rebilly.com/_mock/catalog/all/fees/{id}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "type": "buy",
    "name": "Stripe transaction fees",
    "filter": "type:sale,capture;result:approved;gatewayAccountId:stripe",
    "formula": {
      "type": "fixed-fee",
      "currency": "USD",
      "amount": 0.3
    }
  }'

Responses

Fee entry patched.

Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the fee.

Example:"fee_01GQT145JX3XBRJ8K812Y3GRE9"
typestringrequired

Type of fee.

Enum:"buy""sell"
namestring, [ 1 .. 255 ] charactersrequired

Name of the fee.

Example:"A gateway fee"
filterstring or null, [ 1 .. 255 ] characters

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

Example:"type:sale,capture;result:approved"
formulaobject(FeeFormula)required
settlementSettingsSettlementSettings (object) or null
One of:

Settlement settings. Use these settings to set up settlement accounts.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

Response
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": [
    { … }
  ]
}