lightning-disableinvoicerequest -- Command for removing an invoice request
SYNOPSIS
(WARNING: experimental-offers only)
disableinvoicerequest invreq_id
DESCRIPTION
Command added in v22.11.
The disableinvoicerequest RPC command disables an invoice_request, so that no further invoices will be accepted (and thus, no further payments made)..
We currently don't support deletion of invoice_requests, so they are not forgotten entirely (there may be payments which refer to this invoice_request).
- invreq_id (string): A specific invoice can be disabled by providing the
invreq_id
, which is presented by lightning-invoicerequest(7).
RETURN VALUE
Note: the returned object is the same format as listinvoicerequests.
On success, an object is returned, containing:
- invreq_id (hash): The SHA256 hash of all invoice_request fields less than 160.
- active (boolean) (always false): 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.
AUTHOR
Rusty Russell <[email protected]> is mainly responsible.
SEE ALSO
lightning-invoicerequest(7), lightning-listinvoicerequests(7)
RESOURCES
Main web site: https://github.com/ElementsProject/lightning
EXAMPLES
Example 1:
Request:
lightning-cli disableinvoicerequest -k "invreq_id"="a621a0e8e8ea9aa97fd47ab9b140e413be7f4ea45377617e693eb7afe5a3dbf9"
{
"id": "example:disableinvoicerequest#1",
"method": "disableinvoicerequest",
"params": {
"invreq_id": "a621a0e8e8ea9aa97fd47ab9b140e413be7f4ea45377617e693eb7afe5a3dbf9"
}
}
Response:
{
"invreq_id": "a621a0e8e8ea9aa97fd47ab9b140e413be7f4ea45377617e693eb7afe5a3dbf9",
"active": false,
"single_use": true,
"bolt12": "lnr1qqgx5t5hcw5ru9fgkhgxj4thjq4ugzsk2fjhzat9wd6xjmn8ypnx7u3qd9h8vmmfvdj3yyrrd35kw6r5de5kueeqwd6x7un92qsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzr6jqwvfdqzcyypz6g3kyz34nfrl7lm6c3rushzxey3a55ecjgs6qp2vz8q78j336k0sgpvamrunx5t6vdaeu7nmmlh5u6f0dnscasy2alyxq79f5wnc043gxrzyqt640dmuj7c94644j5ae6wfse7tsejwqnmc575ly9t38h4hf",
"used": false
}