NAME

lightning-disableinvoicerequest -- Command for removing an invoice request

SYNOPSIS

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 <rusty@rustcorp.com.au> 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"="invreqid02020202020202020202020202020202020202020202020202020202"

{


  "id": "example:disableinvoicerequest#1",


  "method": "disableinvoicerequest",


  "params": {


    "invreq_id": "invreqid02020202020202020202020202020202020202020202020202020202"


  }
}

Response:

{


  "invreq_id": "invreqid02020202020202020202020202020202020202020202020202020202",


  "active": false,


  "single_use": true,


  "bolt12": "lno1qgsq000bolt240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000",


  "used": false
}