Skip to content
MothershipDevelopers

API referenceReference

Rebills

What a rebill is, how its review works, and what each status, dispute status and line item type means.

6 min read

A carrier can bill more than the quoted price after it moves a shipment. It reweighs the freight and finds it heavier, the driver waits at the dock, or the first delivery attempt fails. Mothership passes those charges on as a rebill, with one line item per charge.

A rebill belongs to one shipment. The first rebill on MS5016101 is MSSR5016101, and a second one is MSSR5016101-2. Retrieve a rebill takes either the reference number or the rebill's id.

The API reads rebills and their disputes. Accepting a charge, disputing it and answering Mothership's questions happen on the Billing page in your dashboard.

The review window

A new rebill is scheduled. Until disputableUntil, you can accept each line item or dispute it. Line items you leave alone are charged as billed when the window closes.

To find the rebills that need you, list them with status=scheduled. To find the disputes where Mothership is waiting on you, list them with disputeStatus=info-needed. Each takes one call to List rebills, because filters on different parameters must all match.

Amounts

Every amount is in cents, in US dollars. amountCents is the total of the line items, processingFeeCents is the carrier bill processing fee, and totalAmountCents is the two together. The processing fee may apply if the rebill is finalized or a dispute is lost.

A line item whose dispute is approved isn't charged, and a waived or voided rebill costs nothing. Once the review is over, invoiceId names the invoice that charges the rebill. Retrieve an invoice shows what was charged and whether it has been paid.

Rebill statuses

StatusDescription
scheduledWaiting for your review. Accept or dispute each line item in your dashboard before disputableUntil. Line items you leave alone are charged as billed when the window closes.
disputedAt least one line item is disputed. Each line item's dispute.status says where its dispute is.
acceptedYou accepted every line item. Mothership finalizes the rebill and charges it next.
finalizedThe review is over and the charge is being made. Line items with an approved dispute are left out, and invoiceId names the invoice.
processedMothership finished processing the rebill. That doesn't mean the invoice is paid, so check invoiceId with Retrieve an invoice.
failedMothership couldn't charge the rebill automatically. Pay the open invoice in invoiceId.
waivedMothership covered the charge. You pay nothing.
voidedThe rebill was cancelled. You pay nothing.

Disputes

A line item has at most one dispute. It shows up as the line item's dispute, and List a rebill's disputes lists every dispute on a rebill in one array. reason and message are what you wrote when you disputed the charge, and fileIds are the files you attached, which Retrieve a file downloads.

Dispute statuses

StatusDescription
under-reviewMothership is reviewing your dispute before it goes to the carrier. This usually takes 1 to 2 days.
with-carrierMothership sent the dispute to the carrier and is waiting for its decision, which usually takes 5 to 7 business days.
info-neededMothership needs more from you, and infoRequested says what. Reply from your dashboard within 7 days, or the dispute is withdrawn and the line item is charged.
resolved-approvedThe carrier approved the dispute. You aren't charged for the line item.
resolved-waived-approvedMothership waived the line item in your favor. You aren't charged for it.
resolved-chargedThe carrier upheld the charge, so the line item is charged.
withdrawnYou withdrew the dispute and accepted the charge.
voidedClosed because the rebill was waived or voided.

Line item types

Each line item's type says what the carrier charged for. name is the same charge as the dashboard names it, and explanation, avoidanceGuidance and disputeEvidence explain it in Markdown.

Line item typeDescription
bill-of-lading-correctionThe carrier corrected details on the bill of lading.
reconsignmentThe delivery address changed after pickup, so the carrier rerouted the freight.
delivery-attemptThe carrier tried to deliver but couldn't, and came back.
driver-laborThe driver loaded or unloaded the freight.
expedited-deliveryThe freight moved faster than the service you booked.
additional-freightThe carrier picked up more freight than you booked.
lumper-feeWorkers at the dock were paid to load or unload the freight.
pickup-address-changeThe pickup address changed after booking.
pickup-attemptThe carrier came for the freight but couldn't pick it up, such as when it wasn't ready.
reactivated-shipmentThe carrier restarted a shipment that had been cancelled or put on hold.
return-shipmentThe carrier brought the freight back to the shipper.
detentionThe driver waited at pickup or delivery longer than the free time the carrier allows.
incorrect-weightThe carrier weighed the freight and found it heavier than booked.
liftgate-pickupThe driver used a liftgate to load the freight at pickup.
liftgate-deliveryThe driver used a liftgate to unload the freight at delivery.
incorrect-dimensionsThe carrier measured the freight and found it larger than booked.
appointmentThe carrier had to book an appointment to pick up or deliver.
residential-pickupThe pickup was at a residential address.
residential-deliveryThe delivery was to a residential address.
inside-pickupThe driver collected the freight from inside the building.
inside-deliveryThe driver brought the freight inside the building.
excessive-lengthA piece of freight was longer than the carrier's standard length.
commodity-class-upThe carrier rated the freight at a higher freight class than booked.
tradeshowThe pickup or delivery was at a trade show or convention.
blind-shipmentThe paperwork kept the shipper and consignee from seeing each other.
government-airport-gas-mine-or-refinery-deliveryThe delivery was to a government site, an airport, a gas or oil site, a mine or a refinery.
container-freight-station-pickupThe pickup was at a container freight station.
container-freight-station-deliveryThe delivery was to a container freight station.
storage-feeThe carrier stored the freight, such as while it waited to deliver.
amazon-distribution-centerThe delivery was to an Amazon distribution center.
call-before-deliveryThe carrier called the consignee before delivering.
carrier-or-service-upgradeThe shipment moved with a different carrier or a higher service level than booked.
limited-truck-access-pickupThe pickup location was hard for a truck to reach.
limited-truck-access-deliveryThe delivery location was hard for a truck to reach.
hazmatThe freight contained hazardous materials.
toll-feeTolls on the route.
freight-coverageCoverage for loss of or damage to the freight.
oversize-feeThe freight was larger or heavier than the carrier's standard limits.
scheduled-deliveryThe delivery was scheduled for a set time.
documentationThe carrier prepared or handled paperwork for the shipment.
cancellation-feeThe carrier charged for a cancellation, usually one made close to the pickup time.
cargo-details-updatedThe carrier inspected the freight and found its weight, dimensions or commodity didn't match the booking.