Skip to main content
GET
/
v1
/
invoices
/
{invoiceId}
get invoice
curl --request GET \
  --url https://api.unprice.dev/v1/invoices/{invoiceId} \
  --header 'Authorization: Bearer <token>'
{
  "invoice": {
    "id": "<string>",
    "project_id": "<string>",
    "subscription_id": "<string>",
    "customer_id": "<string>",
    "statement_key": "<string>",
    "statement_start_at": 123,
    "statement_end_at": 123,
    "due_at": 123,
    "past_due_at": 123,
    "issue_date": 123,
    "sent_at": 123,
    "paid_at": 123,
    "gross_amount": 1,
    "amount_due": 1,
    "amount_paid": 1,
    "amount_included": 1
  },
  "lines": [
    {
      "entry_id": "<string>",
      "statement_key": "<string>",
      "kind": "<string>",
      "description": "<string>",
      "quantity": 123,
      "amount": 1,
      "amount_due": 1,
      "amount_paid": 1,
      "amount_included": 1,
      "collectable": true,
      "wallet_credit_id": "<string>",
      "wallet_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

invoiceId
string
required

The invoice ID

Example:

"inv_1H7KQFLr7RepUyQBKdnvY"

Response

Invoice header + projection lines

invoice
object
required
lines
object[]
required