Invoices
Delete invoices
Deletes all invoices matching a filter. Returns the number deleted. Deleting an invoice can affect the wallet balance.
delete/v1/invoices
Request
- The document declares no server URL.
- Auth: HTTP bearer
Query parameters
limitinteger nullable
Total amount of results to return
offsetinteger nullable
Offset where to start returning results
idsstring[] nullable
List of IDs
wallet_idstring uuid nullable
Wallet ID. Automatically populated with your ID
status'Pending' | 'Settled' | 'Expired'
Lifecycle status of an invoice.
Status
ledger'Lightning' | 'Internal' | 'Onchain'
The ledger a transaction settles on.
Ledger
order_by'CreatedAt' | 'PaymentTime' | 'UpdatedAt'
Field to order invoices by.
Order by
order_direction'Asc' | 'Desc'
Direction of result ordering for list endpoints.
Direction of the ordering of results
Response
Success
Changes
No operation changes recorded.