@billkit-eu/sdk 0.7.1 → 0.8.0

package/CHANGELOG.md

@@ -8,6 +8,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 Versioning is independent of the Python SDK; the two ship on their own cadence,
 so the numbers will diverge after this first release.
 
+## [Unreleased]
+
+## [0.8.0] - 2026-09-26
+
+### Added
+- `oneShotPayments.list(params)` and `oneShotPayments.iter(options)` for `GET /v1/checkout/one_shot`, newest first, filtered by `customer_id` and `status`. New exported type `OneShotPaymentsListParams`.
+- `payments.retrieve` documents the `refund_eligibility` expansion: `{ object, eligible, amount_cents, currency, days_remaining, window_ends_at, reason }`, whether a refund of the remaining balance would succeed now. It is retrieve-only; `payments.list` refuses it.
+
+### Changed
+- An explicit `null` now clears `UpdateProductParams.description`, `UpdateCustomerParams.name`, `UpdateWebhookEndpointParams.description`, `UpdateCouponParams.max_redemptions` and `redeem_by`, and `UpdateTaxRateParams.display_name`. The types accept `null`, and it is sent as a JSON null rather than pruned; omitting the field still leaves it alone.
+  **Upgrade note:** a `null` you pass through from your own data now clears the field. `customers.update(id, { name: user.name })` with `user.name` sometimes `null` used to leave the name alone and now erases it; pass `undefined` (or omit the key) when you mean "leave it".
+
 ## [0.7.1] - 2026-09-25
 
 ### Added
@@ -264,7 +276,8 @@ First public release.
   back a one-shot paid with giropay before the shutdown works;
   `OneShotPayment.method` is a plain `string`.
 
-[Unreleased]: https://github.com/billkit-eu/billkit-node/compare/v0.7.1...HEAD
+[Unreleased]: https://github.com/billkit-eu/billkit-node/compare/v0.8.0...HEAD
+[0.8.0]: https://github.com/billkit-eu/billkit-node/compare/v0.7.1...v0.8.0
 [0.7.1]: https://github.com/billkit-eu/billkit-node/compare/v0.7.0...v0.7.1
 [0.7.0]: https://github.com/billkit-eu/billkit-node/compare/v0.6.0...v0.7.0
 [0.6.0]: https://github.com/billkit-eu/billkit-node/compare/v0.5.0...v0.6.0

package/README.md

@@ -96,7 +96,7 @@ The client exposes one accessor per resource family. Each mirrors the verbs from
 | `client.products` | `create`, `retrieve`, `update` (archive with `active: false`), `list`, `iter` |
 | `client.prices` | `create`, `retrieve`, `update` (archive with `active: false`, restore with `active: true`), `list`, `iter` |
 | `client.checkoutSessions` | `create`, `retrieve` |
-| `client.oneShotPayments` | `create`, `retrieve` |
+| `client.oneShotPayments` | `create`, `retrieve`, `list`, `iter` (filter by `customer_id`, `status`) |
 | `client.subscriptions` | `retrieve`, `list`, `iter` (filter by `customer_id`, `status`, `renewal_state`), `cancel`, `pause`, `resume`, `reactivate`, `previewUpdate`, `update`, `reauthorizePaymentMethod`, `createUsageRecord`, `listUsageRecords`, `iterUsageRecords`, `retrieveUsageSummary` |
 | `client.refunds` | `create`, `retrieve`, `list`, `iter` |
 | `client.disputes` | `retrieve`, `list`, `iter` |
@@ -108,9 +108,13 @@ The client exposes one accessor per resource family. Each mirrors the verbs from
 | `client.invoices` | `retrieve`, `retrievePdf`, `list`, `iter`, `void` |
 | `client.creditNotes` | `retrieve`, `retrievePdf`, `list`, `iter` (filter by `invoice_id`, `customer_id`) |
 | `client.auditLogs` | `retrieve`, `list`, `iter` (filter by `action`, `resource_type`, `resource_id`, `actor_id`) |
-| `client.payments` | `retrieve`, `list`, `iter` |
+| `client.payments` | `retrieve` (`expand: ["refund_eligibility"]` says whether a refund would succeed now), `list`, `iter` |
 | `client.billingPortalSessions` | `create`, `revoke` |
 
+### Clearing an optional field
+
+On an update, an explicit `null` clears a field and omitting it leaves the stored value alone. Only `undefined` is pruned from a request body, so `null` reaches the API as a JSON null. This applies to `products.update` (`description`, `default_price_id`), `customers.update` (`name`), `webhookEndpoints.update` (`description`), `coupons.update` (`max_redemptions` removes the cap, `redeem_by` removes the expiry) and `taxRates.update` (`display_name`).
+
 ### Retiring something, and deleting something
 
 `delete()` exists on `customers` and `webhookEndpoints`, and it resolves to `{ id, object, deleted: true }` rather than the object: it has left the API, so there is nothing to hand back. A deleted endpoint takes its delivery rows with it, because those are readable only through the endpoint that owns them; the events stay in `client.events`, which is the record of what you were sent.

package/dist/index.cjs

@@ -265,6 +265,16 @@ var OneShotPayments = class extends BaseResource {
   retrieve(id) {
     return this.get(`/v1/checkout/one_shot/${p(id)}`);
   }
+  /** List one-off charges, newest first. Filter by `customer_id` and `status`. */
+  list(params = {}) {
+    return this.get("/v1/checkout/one_shot", params);
+  }
+  iter(options = {}) {
+    return paginate((page) => this.get("/v1/checkout/one_shot", page), {
+      pageSize: options.pageSize,
+      filters: { customer_id: options.customer_id, status: options.status }
+    });
+  }
 };
 var Subscriptions = class extends BaseResource {
   /** Expandable: `customer`, `price`, `refund_eligibility`. */
@@ -777,7 +787,20 @@ var AuditLogs = class extends BaseResource {
   }
 };
 var Payments = class extends BaseResource {
-  /** Expandable: `customer`, `subscription`. */
+  /**
+   * Expandable: `customer`, `subscription`, `refund_eligibility`. The last
+   * is retrieve-only (`list` refuses it with a `400`) and attaches
+   * `refund_eligibility: { object: "refund_eligibility", eligible,
+   * amount_cents, currency, days_remaining, window_ends_at, reason }`:
+   * whether `refunds.create` for the remaining balance would succeed now,
+   * applying the refund window and the price's refund policy, which
+   * `amount_refundable_cents` does not. When `eligible` is false, `reason`
+   * is one of `not_paid`, `unrefundable_type`, `window_expired`,
+   * `fully_refunded`, `disputed`, `operation_pending` or
+   * `plan_change_pending` (a plan change is settling: the full balance
+   * cannot be refunded yet, a partial refund still can); treat any other
+   * value as "not refundable".
+   */
   retrieve(id, options = {}) {
     return this.get(`/v1/payments/${p(id)}`, options);
   }
@@ -976,7 +999,7 @@ function sleep(ms) {
 }
 
 // src/version.ts
-var VERSION = "0.7.1";
+var VERSION = "0.8.0";
 
 // src/transport.ts
 var DEFAULT_BASE_URL = "https://api.billkit.eu";