LIGHTNING-LISTINVOICEREQUESTS(7)

✨ NAME ✨

okay bestie, this is lightning-listinvoicerequests(7) — the manual page for the listinvoicerequests command, aka the command for querying invoice_request status. It's giving "I need to know what's up with my invoice requests" and honestly? Same. 💅

🛰️ SYNOPSIS 🛰️

listinvoicerequests [invreq_id] [active_only]

💖 DESCRIPTION 💖

🌸 Command added in v22.11.

The listinvoicerequests RPC command gets the status of a specific invoice_request, if it exists, or the status of all invoice_requests if given no argument. iconic, tbh.

• invreq_id (string, optional) — a specific invoice can be queried by providing the invreq_id, which is presented by lightning-invoicerequest(7), or can be calculated from a bolt12 invoice. iykyk
• active_only (boolean, optional) — if it is True then only active invoice requests are returned. The default is False. default check: noted ✅

🎁 RETURN VALUE 🎁

On success, an object containing invoicerequests is returned. It is an array of objects, where each object contains:

• invreq_id (hash) — The SHA256 hash of all invoice_request fields less than 160.
• active (boolean) — Whether the invoice_request is currently active.
• single_use (boolean) — Whether the invoice_request will become inactive after we pay an invoice for it.
• bolt12 (string) — The bolt12 string starting with lnr.
• used (boolean) — Whether the invoice_request has already been used.
• label (string, optional) — The label provided when creating the invoice_request.

like, every field is right there — no mystery, no cap 💜

👑 AUTHOR 👑

Rusty Russell rusty@rustcorp.com.au is mainly responsible. main character credit where it's due 🫶

🔗 SEE ALSO 🔗

• lightning-invoicerequests(7)
• lightning-disableinvoicerequest(7)

🌈 RESOURCES 🌈

Main web site: https://github.com/ElementsProject/lightning

🧪 EXAMPLES 🧪

🎀 Example 1 🎀

Request:

$ lightning-cli listinvoicerequests "invreqid03030303030303030303030303030303030303030303030303030303"

{
  "id": "example:listinvoicerequests#1",
  "method": "listinvoicerequests",
  "params": [
    "invreqid03030303030303030303030303030303030303030303030303030303"
  ]
}

Response:

{
  "invoicerequests": [
    {
      "invreq_id": "invreqid02020202020202020202020202020202020202020202020202020202",
      "active": false,
      "single_use": true,
      "bolt12": "lno1qgsq000bolt240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000",
      "used": false
    }
  ]
}

🎀 Example 2 🎀

Request:

$ lightning-cli listinvoicerequests

{
  "id": "example:listinvoicerequests#2",
  "method": "listinvoicerequests",
  "params": {}
}

Response:

{
  "invoicerequests": [
    {
      "invreq_id": "invreqid02020202020202020202020202020202020202020202020202020202",
      "active": false,
      "single_use": true,
      "bolt12": "lno1qgsq000bolt240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000",
      "used": false
    },
    {
      "invreq_id": "invreqid01010101010101010101010101010101010101010101010101010101",
      "active": false,
      "single_use": true,
      "bolt12": "lno1qgsq000bolt210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000",
      "used": true
    }
  ]
}

---

okay that's the whole vibe 💖 this page ships with Core Lightning v26.06.9 and it's the LIGHTNING-LISTINVOICEREQUESTS(7) manual — go query those invoice requests, bestie! 🫶✨