Skip to main content

Transactions

Base URL https://api.leadx.in/api/key/protected. Every request needs an apikey header — see Authentication.

3 endpoints.

GET /transaction-history

Get all transaction history.

Auth apikey

:::note Used by the web app pages/BillingHistory.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Responsedata is an array of Payment objects, alongside the pagination fields described in Response format. updatedBy, createdBy, subscription are populated, so they arrive as nested objects rather than ids.

GET /transaction-history/:id

Get transaction history.

Auth apikey

Path parameters

Name
idRequired

Responsedata is one Payment object.

Errors transactionHistoryNotFound_400

GET /transaction-history/:id/invoice

Download a transaction's invoice as a PDF.

Auth apikey

:::note Used by the web app pages/BillingHistory.jsx :::

Path parameters

Name
idRequired

Errors InvoiceNotGenerated_400 · transactionHistoryNotFound_400