Skip to content

Update fee

PUT
/v1/fees/{fee_id}

Update a fee.

fee_id
required
Fee Id
string format: uuid
FeeUpdate

Schema for updating a fee.

object
payment_status
Any of:
FeePaymentStatus

Fee payment status enum.

string
Allowed values: pending succeeded failed refunded
description
Any of:
string
taxes_amount_cents
Any of:
number
total_amount_cents
Any of:
number

Successful Response

FeeResponse

Schema for fee response.

object
id
required
Id
string format: uuid
invoice_id
Any of:
string format: uuid
charge_id
Any of:
string format: uuid
subscription_id
Any of:
string format: uuid
commitment_id
Any of:
string format: uuid
customer_id
required
Customer Id
string format: uuid
fee_type
required
Fee Type
string
amount_cents
required
Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
taxes_amount_cents
required
Taxes Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
total_amount_cents
required
Total Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
units
required
Units
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
events_count
required
Events Count
integer
unit_amount_cents
required
Unit Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
payment_status
required
Payment Status
string
description
Any of:
string
metric_code
Any of:
string
properties
required
Properties
object
key
additional properties
any
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Unauthorized – invalid or missing API key

Fee not found

Validation error