Billing

List invoices

GET /v1/invoices

Charges billed after the fact, such as a carrier's weight or size adjustment. These may be unpaid.

Response in data

• items • Required array of objects
  Each item · 21

  • billing_status • Required string
  • carrier • Required string

    Carrier code, as returned with each rate.

  • created_at • Required timestamp

    When it was created (ISO 8601, UTC).

  • currency_code • Required string
  • discount_amount_cents • Required integer
  • duties_cents • Required integer

    Destination duties and taxes prepaid with this label (DDP), when offered.

  • id • Required uuid
  • invoice_number • Required string
  • invoice_type • Required string
  • refund_amount_cents • Required integer
  • service • Required string
  • status • Required string
  • subtotal_cents • Required integer
  • tax_cents • Required integer

    Sales tax, in cents.

  • total_cents • Required integer

    Total, in cents.

  • invoice_for string
  • refund_reason string
  • refunded_at timestamp
  • shipment_id uuid
  • tax_type string
  • wallet_transaction_id uuid

Get an invoice

GET /v1/invoices/{id}

One invoice with its line items.

Path parameters

• id • Required string

Response in data

• billing_status • Required string
• carrier • Required string

  Carrier code, as returned with each rate.

• created_at • Required timestamp

  When it was created (ISO 8601, UTC).

• currency_code • Required string
• discount_amount_cents • Required integer
• duties_cents • Required integer

  Destination duties and taxes prepaid with this label (DDP), when offered.

• id • Required uuid
• invoice_number • Required string
• invoice_type • Required string
• refund_amount_cents • Required integer
• service • Required string
• status • Required string
• subtotal_cents • Required integer
• tax_cents • Required integer

  Sales tax, in cents.

• total_cents • Required integer

  Total, in cents.

• invoice_for string
• refund_reason string
• refunded_at timestamp
• shipment_id uuid
• tax_type string
• wallet_transaction_id uuid

Pay an invoice

POST /v1/invoices/{id}/pay

Pays an unpaid invoice from the wallet. Returns 409 (error.message is insufficient_funds) when the balance does not cover it.

Confirm with the account owner before calling it.

Path parameters

• id • Required string

Response in data

• invoice • Required object
  Fields · 21

  • billing_status • Required string
  • carrier • Required string

    Carrier code, as returned with each rate.

  • created_at • Required timestamp

    When it was created (ISO 8601, UTC).

  • currency_code • Required string
  • discount_amount_cents • Required integer
  • duties_cents • Required integer

    Destination duties and taxes prepaid with this label (DDP), when offered.

  • id • Required uuid
  • invoice_number • Required string
  • invoice_type • Required string
  • refund_amount_cents • Required integer
  • service • Required string
  • status • Required string
  • subtotal_cents • Required integer
  • tax_cents • Required integer

    Sales tax, in cents.

  • total_cents • Required integer

    Total, in cents.

  • invoice_for string
  • refund_reason string
  • refunded_at timestamp
  • shipment_id uuid
  • tax_type string
  • wallet_transaction_id uuid
• new_available_cents • Required integer
• wallet_transaction_id • Required uuid

Download an invoice

GET /v1/invoices/{id}/pdf

A short-lived download link for the invoice or receipt PDF.

Path parameters

• id • Required string

Response in data

• url • Required string

List receipts

GET /v1/receipts

Settled top-ups, label purchases and refunds.

Response in data

• items • Required array of objects
  Each item · 21

  • billing_status • Required string
  • carrier • Required string

    Carrier code, as returned with each rate.

  • created_at • Required timestamp

    When it was created (ISO 8601, UTC).

  • currency_code • Required string
  • discount_amount_cents • Required integer
  • duties_cents • Required integer

    Destination duties and taxes prepaid with this label (DDP), when offered.

  • id • Required uuid
  • invoice_number • Required string
  • invoice_type • Required string
  • refund_amount_cents • Required integer
  • service • Required string
  • status • Required string
  • subtotal_cents • Required integer
  • tax_cents • Required integer

    Sales tax, in cents.

  • total_cents • Required integer

    Total, in cents.

  • invoice_for string
  • refund_reason string
  • refunded_at timestamp
  • shipment_id uuid
  • tax_type string
  • wallet_transaction_id uuid

Get a receipt

GET /v1/receipts/{id}

One receipt with its line items.

Path parameters

• id • Required string

Response in data

• billing_status • Required string
• carrier • Required string

  Carrier code, as returned with each rate.

• created_at • Required timestamp

  When it was created (ISO 8601, UTC).

• currency_code • Required string
• discount_amount_cents • Required integer
• duties_cents • Required integer

  Destination duties and taxes prepaid with this label (DDP), when offered.

• id • Required uuid
• invoice_number • Required string
• invoice_type • Required string
• refund_amount_cents • Required integer
• service • Required string
• status • Required string
• subtotal_cents • Required integer
• tax_cents • Required integer

  Sales tax, in cents.

• total_cents • Required integer

  Total, in cents.

• invoice_for string
• refund_reason string
• refunded_at timestamp
• shipment_id uuid
• tax_type string
• wallet_transaction_id uuid