bookings

POST /bookings/{id}/collect-overage-fee

Collect booking overage fee

Request

Path parameters

idinteger required

Request body

admin_messagestring

Admin message for audit trail

dry_claimboolean

Dry run mode - calculate charges without executing

messagestring

Message to send to renter about post-trip charges

usage_overage_onlyboolean

Legacy usage-based overage collection (mileage/generator) Set to true to only collect existing mileage and generator overages

Response

actual_deposit_datestring
adjustmentinteger
amountinteger
auto_depositboolean
availablestring

Available tells us when the funds are expected to have cleared the bank

booking_idinteger
brandstring
can_deleteboolean
can_finance_syncboolean
can_refundboolean
can_retryboolean
can_reverse_transferboolean
can_syncboolean
can_transferboolean
cc_feeinteger
chargedstring
createdstring
created_by_idinteger
deposit_datestring
descriptionstring
display_charge_typestring
display_payment_processor_namestring
display_typestring
dispute_reasonstring nullable
dispute_statusstring nullable
disputedboolean
expected_deposit_datestring
failedboolean
fraudulentboolean
fx_feeinteger

DEPRECATED - DO NOT USE

idinteger
is_refundboolean
last_fourstring
original_charge_idTransaction circular
our_feeinteger
outdoorsy_feeinteger
owner_federal_withholding_taxinteger
owner_feeinteger
owner_integrations_feeinteger nullable
owner_quebec_sales_taxinteger
paidboolean
payment_metaunknown
payment_sourcestring
processor_settlement_idstring nullable
recipient_idinteger
refund_sourcestring
refundedinteger
refunded_cc_feeinteger
refunded_feeinteger
refunded_fx_feeinteger
refunded_outdoorsy_feeinteger
refunded_owner_federal_withholding_taxinteger
refunded_owner_feeinteger
refunded_owner_integrations_feeinteger nullable
refunded_owner_quebec_sales_taxinteger
refunded_service_feeinteger
retry_payout_idTransaction circular
sales_taxinteger
service_feeinteger
statusstring
stripe_feeinteger
stripe_fee_refundinteger
stripe_idstring
transferTransaction circular
typestring

Changes

No recorded changes to this operation across all 1 revision of this API.