Skip to content
/
Get Billing & Void Status

Get Billing & Void Status

Request

Retrieve the carrier billing state and void state of a previously purchased label, looked up by tracking number.

Security
BearerAuth or ApiTokenAuth
Query
tracking_codestringrequired

Tracking number of the shipment to look up.

Example:tracking_code=1ZXXXXXXXXXXXXX
curl -i -X GET \
  'https://ps-api.shipsaving.com/api/shipments/status?tracking_code=1ZXXXXXXXXXXXXX' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Shipment status retrieved successfully

Bodyapplication/json
tracking_codestring

Tracking number of the matched shipment, echoed from the stored shipment record.

Example:"1ZXXXXXXXXXXXX"
bill_statusstring

Carrier billing state.

  • pending — not yet reconciled; the state of a newly purchased label
  • ready — queued for reconciliation
  • completed — reconciled; bill_rate is final
Example:"completed"
bill_ratenumber or null, (double)

Amount actually billed by the carrier, in USD, always to two decimal places.

Example:22.68
void_statusstring or null

Void state of the label.

Example:""
adjust_timestring or null, (date-time)

Timestamp of the most recent billing adjustment on this shipment, as an ISO-8601 UTC instant with second precision. null when the shipment has never been adjusted.

Example:"2026-07-29T07:00:05Z"
Response
{
  "tracking_code": "1ZXXXXXXXXXXXXX",
  "bill_status": "completed",
  "bill_rate": 22.68,
  "void_status": "",
  "adjust_time": "2026-07-29T07:00:05Z"
}