Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spark.money/llms.txt

Use this file to discover all available pages before exploring further.

Queries the status of Spark invoices.

​
Method Signature

async getSparkInvoices(params: QuerySparkInvoicesParams): Promise<{
  invoiceStatuses: InvoiceResponse[];
  offset: number;
}>

interface QuerySparkInvoicesParams {
  invoices: string[];
  limit?: number;   // default: 100
  offset?: number;  // default: 0
}

​
Parameters

​
invoices
string[]
required
Array of Spark invoice strings to query. Must be non-empty.
​
limit
number
Maximum number of results to return (default: 100).
​
offset
number
Offset for pagination (default: 0).

​
Returns

​
invoiceStatuses
InvoiceResponse[]
required
Array of invoice status objects.
​
offset
number
required
The offset used for this request.

​
Example

const { invoiceStatuses } = await client.getSparkInvoices({
  invoices: ["spark1..."],
});

for (const invoice of invoiceStatuses) {
  console.log(invoice);
}