mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-01-05 21:44:42 +01:00
e7d89cd7de
Changelog-Changed: JSON-RPC: `delinvoice` will now report specific error codes: 905 for failing to find the invoice, 906 for the invoice status not matching the parameter.
51 lines
1.2 KiB
Groff
Generated
51 lines
1.2 KiB
Groff
Generated
.TH "LIGHTNING-DELINVOICE" "7" "" "" "lightning-delinvoice"
|
|
.SH NAME
|
|
lightning-delinvoice - Command for removing an invoice
|
|
.SH SYNOPSIS
|
|
|
|
\fBdelinvoice\fR \fIlabel\fR \fIstatus\fR
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The \fBdelinvoice\fR RPC command removes an invoice with \fIstatus\fR as given
|
|
in \fBlistinvoices\fR\.
|
|
|
|
|
|
The caller should be particularly aware of the error case caused by the
|
|
\fIstatus\fR changing just before this command is invoked!
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success, an invoice description will be returned as per
|
|
\fBlightning-listinvoice\fR(7)\.
|
|
|
|
.SH ERRORS
|
|
|
|
The following errors may be reported:
|
|
|
|
.RS
|
|
.IP \[bu]
|
|
-1: Database error\.
|
|
.IP \[bu]
|
|
905: An invoice with that label does not exist\.
|
|
.IP \[bu]
|
|
906: The invoice \fIstatus\fR does not match the parameter\.
|
|
An error object will be returned as error \fIdata\fR, containing
|
|
\fIcurrent_status\fR and \fIexpected_status\fR fields\.
|
|
|
|
.RE
|
|
.SH AUTHOR
|
|
|
|
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
|
|
|
|
.SH SEE ALSO
|
|
|
|
\fBlightning-listinvoice\fR(7), \fBlightning-waitinvoice\fR(7),
|
|
\fBlightning-invoice\fR(7), \fBlightning-delexpiredinvoice\fR(7),
|
|
\fBlightning-autocleaninvoice\fR(7)
|
|
|
|
.SH RESOURCES
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
|