@billkit-eu/sdk 0.7.0 → 0.7.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@billkit-eu/sdk",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "Official Node.js SDK for BillKit: a Stripe-Billing-shape multi-tenant SaaS API on Mollie.",
   "type": "module",
   "main": "./dist/index.cjs",

package/src/resources.ts

@@ -170,7 +170,7 @@ export interface CustomerListParams extends BaseListParams {
 
 /** Query parameters accepted by `GET /v1/products`. */
 export interface ProductsListParams extends BaseListParams {
-  /** Expandable here: `prices`, `stats`. */
+  /** Expandable here: `prices`, `stats`, `default_price`. */
   expand?: string[];
 }
 
@@ -228,6 +228,14 @@ export interface UpdateProductParams extends IdempotencyOptions {
   active?: boolean;
   /** See {@link CreateProductParams.allow_promotion_codes}. */
   allow_promotion_codes?: boolean;
+  /**
+   * The price the billing portal offers on that price's interval. Must be
+   * an active price of this product; anything else is a 400 on
+   * `default_price_id`. An explicit `null` **clears** the default and is
+   * sent as a JSON null rather than pruned (only `undefined` is dropped);
+   * omit the field to leave the default alone.
+   */
+  default_price_id?: string | null;
 }
 
 /**
@@ -711,15 +719,20 @@ export interface CreditNotesListParams extends BaseListParams {
  * VAT is decided against and that an invoice prints.
  *
  * `country_code` is required on every call: there is nothing to leave
- * alone about a jurisdiction. Every other field is partial-update: omit
- * it to leave the stored value alone, or pass an explicit `null` to
- * clear it, because ceasing to be VAT registered (or moving office) is a
- * real event.
+ * alone about a jurisdiction. The address fields and
+ * `registration_number` are partial-update: omit one to leave the stored
+ * value alone, or pass an explicit `null` to clear it, because moving
+ * office is a real event.
+ *
+ * `vat_id` can be set once. After that, a different value or `null` is
+ * refused with a 400 (`param: "vat_id"`, reason `vat_id_locked`) and the
+ * call writes nothing; re-sending the stored number is accepted. BillKit
+ * invoices you reverse-charged against it, so support changes it.
  */
 export interface SetTenantBillingProfileParams extends IdempotencyOptions {
   /** ISO-3166-1 alpha-2, e.g. `"NL"`. */
   country_code: string;
-  /** Your own EU VAT registration, or `null` to clear it. */
+  /** Your own EU VAT registration. Set once; support changes or clears it. */
   vat_id?: string | null;
   address_line1?: string | null;
   address_line2?: string | null;
@@ -963,7 +976,10 @@ export class Products extends BaseResource {
     return this.post<T, CreateProductParams>("/v1/products", params);
   }
 
-  /** Expandable: `prices` (every price on the product), `stats`. */
+  /**
+   * Expandable: `prices` (every price on the product), `stats`, and
+   * `default_price` (the price `default_price_id` names).
+   */
   retrieve<T = unknown>(id: string, options: ExpandOptions = {}): Promise<T> {
     return this.get<T>(`/v1/products/${p(id)}`, options);
   }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = "0.7.0";
+export const VERSION = "0.7.1";