2019-08-31 14:30:56 +02:00
lightning-listinvoices -- Command for querying invoice status
=============================================================
2019-08-10 01:54:18 +02:00
SYNOPSIS
--------
2023-07-22 11:59:15 +02:00
**listinvoices** [*label*] [*invstring*] [*payment\_hash*] [*offer\_id*] [*index* [*start*] [*limit*]]
2019-08-10 01:54:18 +02:00
DESCRIPTION
-----------
The **listinvoices** RPC command gets the status of a specific invoice,
if it exists, or the status of all invoices if given no argument.
2021-01-05 18:58:13 +01:00
A specific invoice can be queried by providing either the `label`
provided when creating the invoice, the `invstring` string representing
2021-07-02 02:11:35 +02:00
the invoice, the `payment_hash` of the invoice, or the local `offer_id`
this invoice was issued for. Only one of the query parameters can be used at once.
2021-01-05 18:58:13 +01:00
2023-07-22 09:51:47 +02:00
`index` controls ordering, by `created` (default) or `updated` . If
`index` is specified, `start` may be specified to start from that
2023-07-22 11:59:15 +02:00
value, which is generally returned from lightning-wait(7), and `limit`
can be used to specify the maximum number of entries to return.
2023-07-22 09:51:47 +02:00
2019-08-10 01:54:18 +02:00
RETURN VALUE
------------
2021-06-16 03:07:17 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object containing **invoices** is returned. It is an array of objects, where each object contains:
2022-09-05 23:33:09 +02:00
2021-06-16 03:07:17 +02:00
- **label** (string): unique label supplied at invoice creation
2023-01-30 07:24:16 +01:00
- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment
2021-06-16 03:07:17 +02:00
- **status** (string): Whether it's paid, unpaid or unpayable (one of "unpaid", "paid", "expired")
2022-09-05 23:45:06 +02:00
- **expires\_at** (u64): UNIX timestamp of when it will become / became unpayable
2023-07-22 12:59:17 +02:00
- **created\_index** (u64): 1-based index indicating order this invoice was created in *(added v23.08)*
2022-03-24 00:57:28 +01:00
- **description** (string, optional): description used in the invoice
2022-09-05 23:45:06 +02:00
- **amount\_msat** (msat, optional): the amount required to pay this invoice
2021-06-16 03:07:17 +02:00
- **bolt11** (string, optional): the BOLT11 string (always present unless *bolt12* is)
- **bolt12** (string, optional): the BOLT12 string (always present unless *bolt11* is)
2023-01-30 07:24:17 +01:00
- **local\_offer\_id** (hash, optional): the *id* of our offer which created this invoice (**experimental-offers** only).
2022-11-11 03:03:13 +01:00
- **invreq\_payer\_note** (string, optional): the optional *invreq\_payer\_note* from invoice\_request which created this invoice (**experimental-offers** only).
2023-07-22 12:59:17 +02:00
- **updated\_index** (u64, optional): 1-based index indicating order this invoice was changed (only present if it has changed since creation) *(added v23.08)*
2021-06-16 03:07:17 +02:00
If **status** is "paid":
2022-09-05 23:33:09 +02:00
2022-09-05 23:45:06 +02:00
- **pay\_index** (u64): Unique incrementing index for this payment
2022-11-11 03:03:13 +01:00
- **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount\_msat* , since clients may overpay)
2022-09-05 23:45:06 +02:00
- **paid\_at** (u64): UNIX timestamp of when it was paid
2023-01-30 07:24:16 +01:00
- **payment\_preimage** (secret): proof of payment
2021-09-03 12:07:59 +02:00
2021-06-16 03:07:17 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
2019-08-10 01:54:18 +02:00
AUTHOR
------
Rusty Russell < < rusty @ rustcorp . com . au > > is mainly responsible.
SEE ALSO
--------
lightning-waitinvoice(7), lightning-delinvoice(7), lightning-invoice(7).
RESOURCES
---------
Main web site: < https: / / github . com / ElementsProject / lightning >
2020-08-25 03:33:16 +02:00
2023-07-22 12:59:17 +02:00
[comment]: # ( SHA256STAMP:e698b0e345ed4912b7699b43f2571a4cc3bb4ae909efeb631b02dd94a87e765c)
