Skip to content
MothershipDevelopers

API referenceRebills

List rebills

Lists the rebills your organization is charged for, newest first. Every filter is optional, and filters combine.

GET/rebills
Environment
https://sandbox.api.mothership.com/beta
curl --request GET \
  --url 'https://sandbox.api.mothership.com/beta/rebills' \
  --header "Authorization: Bearer $MOTHERSHIP_API_TOKEN" \
  --header 'Accept: application/json'
Reads your token from $MOTHERSHIP_API_TOKEN
Response
{
: {
: [
{
: "7c9e6679-7425-40de-944b-e07fc1f90ae7",
: "MSSR5016101",
: "scheduled",
: "MS5016101",
: "1234567890",
: 8500,
: 1500,
: 10000,
: "usd",
: "2026-03-29T17:00:00.000Z",
: null,
: ,1 item
: "2026-03-19T17:00:00.000Z",
: "2026-03-19T17:00:00.000Z",
: "2026-03-19T17:00:00.000Z"
}
],
: 1,
: 25,
: 1,
: false
}
}

Hover a key to see what it means. Click it to jump to the field.

Lists the rebills your organization is charged for, newest first, in results. Each one has the same fields as Retrieve a rebill.

Every filter is optional. Filters on different parameters must all match, and the values listed for one parameter are alternatives. So status=scheduled,disputed lists rebills in either status, and adding shipmentId=MS5016101 narrows those to one shipment. A parameter can also be repeated instead of separated with commas.

An unknown status is a 400 INVALID_REQUEST that names the statuses the API accepts. Rebills explains each one.

total counts the matches across every page. Keep increasing page while hasMore is true.

Authorization

Authorization: Bearer <token>

Your sandbox API token. See Authentication.

Query parameters

  • pageinteger

    The page of results to return, starting at 1. Defaults to 1.

    min 1
  • perPageinteger

    The most rebills to return on a page, from 1 to 100. Defaults to 25.

    min 1max 100
  • statusstring

    Only rebills in one of these statuses, separated by commas, such as scheduled,disputed. The statuses are scheduled, disputed, finalized, processed, waived, voided, accepted, failed.

  • disputeStatusstring

    Only rebills with a dispute in one of these statuses, separated by commas, such as info-needed. The statuses are under-review, with-carrier, info-needed, resolved-approved, resolved-waived-approved, resolved-charged, withdrawn, voided.

  • shipmentIdstring

    Only rebills for this shipment, by its reference number, such as MS5016101. A shipment that is not yours, or does not exist, matches nothing. List rebills for a shipment answers 404 for one instead.

  • createdAfterstring<date-time>

    Only rebills created at or after this ISO timestamp. A date on its own, such as 2026-06-15, means midnight UTC at the start of that day.

  • createdBeforestring<date-time>

    Only rebills created at or before this ISO timestamp. A date on its own, such as 2026-06-15, means midnight UTC at the start of that day, so pass 2026-06-15T23:59:59.999Z to include all of it.

Responses

    • dataobjectRequired
      • resultsarray of objectsRequired

        The rebills on this page, newest first

      • pageintegerRequired

        The page of results returned, starting at 1

      • perPageintegerRequired

        The most rebills a page holds

      • totalintegerRequired

        How many rebills match, across every page

      • hasMorebooleanRequired

        True if a later page has more rebills

What's next

GETRetrieve a rebill

Retrieve one rebill by its id or referenceNumber.

Rebills

What each status and line item type means.