---
title: "Retrieve an invoice by its public id"
method: GET
path: "/invoices/{id}"
tags: ["Invoices"]
---

# Retrieve an invoice by its public id

`GET /invoices/{id}`

## Request

- Base URL: `https://shieldz.cash/api/v1`
- URL: `https://shieldz.cash/api/v1/invoices/{id}`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Response `200`

OK

- Invoice
  - `id` string
  - `object` 'invoice'
  - `amount_usd_cents` integer
  - `memo` string, nullable
  - `settlement` Settlement
    - `chain` string
    - `asset` string
    - `address` string
  - `status` 'pending' | 'paid' | 'expired' | 'failed'
  - `pay_url` string, uri
  - `expires_at` integer: Unix milliseconds.
  - `paid_at` integer, nullable
  - `mode` 'live' | 'test'
  - `metadata` unknown
  - `line_items` LineItem[], nullable
    - `price` string, nullable: The catalog price (price_…); null for inline price_data.
    - `product` string, nullable: The catalog product (prod_…); null for inline price_data.
    - `name` string: Product name at the time of purchase.
    - `quantity` integer
    - `unit_amount_usd_cents` integer: Price per unit charged, in USD cents.
    - `amount_usd_cents` integer: unit_amount_usd_cents × quantity.
  - `payment_link` string, nullable: The payment link this invoice came from.
  - `shipping` object, nullable: Shipping address from the payment link page. Only returned to the shop (its API key or dashboard).
    - `name` string
    - `line1` string
    - `line2` string
    - `city` string
    - `state` string
    - `postal_code` string
    - `country` string
  - `client_reference_id` string, nullable

## Other responses

- `404`: Error

---

[API](https://skmtc.dev/shieldz/apis/shieldz-api.md) · [All operations](https://skmtc.dev/shieldz/apis/shieldz-api/llms.txt) · [OpenAPI document](https://skmtc.dev/shieldz/apis/shieldz-api/revisions/0d7156bee439?raw)