Node.js server SDK
Typed resources, automatic transient retries, cursor pagination, idempotency, and webhook verification for Node.js 18+.
Release status
billerapi@0.1.0. The reviewed next release intent is 2.0.0; use the registry version until an exact-SHA publication receipt is attached.Install and initialize
npm install billerapiResource map
| Accessor | Use it for |
|---|---|
| billerapi.billers | Catalog search and retrieval |
| billerapi.links | Link tokens, status, exchange, and link retrieval |
| billerapi.bills | List, detail, statements, create, and sync |
| billerapi.billImports | Upload, review, confirm, and cancel |
| billerapi.accountLinks | Sync and refresh status |
| billerapi.webhookEndpoints | Endpoint lifecycle and secret rotation |
| billerapi.pay | Pay tokens, payment methods, and payment attempts |
| billerapi.feedback | Structured integration feedback |
| billerapi.webhooks | Signature verification and event construction |
Let the SDK own transport behavior
Migrating from 0.1.0 to 2.0.0
The tables below are generated from the one SDK deprecation record, so this page, its markdown and the standalone migration guide cannot disagree with each other.
Every entry describes the SDK artifact `billerapi`, not the REST API. The REST API keeps accepting and emitting the legacy money and date fields under its own published compatibility window; only the SDK's TypeScript surface performs the hard cutover.
| SDK version | On npm | Bill money and dates | billers.list pagination |
|---|---|---|---|
| 0.1.0 | yes | legacy amount / currency / due_date only | page-based (page / page_size) |
| 1.0.0 | no | legacy amount / currency / due_date only | page-based (page / page_size) |
| 1.1.0 | no | canonical total_amount / due_date_iso added; legacy fields kept and marked @deprecated | page-based (page / page_size) |
| 2.0.0 | no | canonical total_amount / due_date_iso only on request and response types | cursor-only (limit / cursor) |
| Removed symbol or behavior | Deprecated in | Removed in | Replacement |
|---|---|---|---|
| Bill.amount, Bill.currency, Bill.due_date | 1.1.0 | 2.0.0 | Bill.total_amount.value, Bill.total_amount.currency, Bill.due_date_iso |
| SyncedBill.amount, SyncedBill.currency, SyncedBill.due_date | 1.1.0 | 2.0.0 | SyncedBill.total_amount.value, SyncedBill.total_amount.currency, SyncedBill.due_date_iso |
| CreateClientBillParams.amount_due, CreateClientBillParams.currency, CreateClientBillParams.due_date | 1.1.0 | 2.0.0 | CreateClientBillParams.total_amount, CreateClientBillParams.due_date_iso |
| BillImportReviewChanges.amount_due, BillImportReviewChanges.currency, BillImportReviewChanges.due_date | 1.1.0 | 2.0.0 | BillImportReviewChanges.total_amount, BillImportReviewChanges.due_date_iso |
| BillerListParams.page, BillerListParams.page_size | 1.1.0 | 2.0.0 | BillerListParams.limit, BillerListParams.cursor |
| webhooks.constructEvent | 1.0.0 | 2.0.0 | BillerAPI-Signature |
| BillerApi.request | 0.1.0 | 1.0.0 | /v1 audience-plane paths |
| webhookEndpoints.create, webhookEndpoints.list, webhookEndpoints.update | 0.1.0 | 1.0.0 | /v1/webhook-endpoints |
There is exactly one upgrade to make: 1.0.0 and 1.1.0 were reviewed but never published, so the deprecated-in column is history rather than a window you can pin to.
Prefer raw HTTP? Every SDK call maps directly to the API reference.