@billkit-eu/sdk 0.7.0 → 0.7.1

package/dist/index.d.cts

@@ -344,7 +344,7 @@ interface CustomerListParams extends BaseListParams {
 }
 /** Query parameters accepted by `GET /v1/products`. */
 interface ProductsListParams extends BaseListParams {
-    /** Expandable here: `prices`, `stats`. */
+    /** Expandable here: `prices`, `stats`, `default_price`. */
     expand?: string[];
 }
 /**
@@ -398,6 +398,14 @@ 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;
 }
 /**
  * Body for `POST /v1/prices/{id}`. Every field is optional; omitted ones
@@ -840,15 +848,20 @@ 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.
  */
 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;
@@ -958,7 +971,10 @@ declare class Customers extends BaseResource {
 declare class Products extends BaseResource {
     /** Create a catalog Product, then attach one or more Prices to it. */
     create<T = unknown>(params: CreateProductParams): Promise<T>;
-    /** 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>;
     /**
      * Patch mutable Product fields, or archive it with `active: false`.
@@ -1610,7 +1626,7 @@ declare class RateLimitError extends BillKitError {
     });
 }
 
-declare const VERSION = "0.7.0";
+declare const VERSION = "0.7.1";
 
 /**
  * Verify `BillKit-Signature: t=<unix>,v1=<hex>` headers.

package/dist/index.d.ts

@@ -344,7 +344,7 @@ interface CustomerListParams extends BaseListParams {
 }
 /** Query parameters accepted by `GET /v1/products`. */
 interface ProductsListParams extends BaseListParams {
-    /** Expandable here: `prices`, `stats`. */
+    /** Expandable here: `prices`, `stats`, `default_price`. */
     expand?: string[];
 }
 /**
@@ -398,6 +398,14 @@ 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;
 }
 /**
  * Body for `POST /v1/prices/{id}`. Every field is optional; omitted ones
@@ -840,15 +848,20 @@ 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.
  */
 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;
@@ -958,7 +971,10 @@ declare class Customers extends BaseResource {
 declare class Products extends BaseResource {
     /** Create a catalog Product, then attach one or more Prices to it. */
     create<T = unknown>(params: CreateProductParams): Promise<T>;
-    /** 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>;
     /**
      * Patch mutable Product fields, or archive it with `active: false`.
@@ -1610,7 +1626,7 @@ declare class RateLimitError extends BillKitError {
     });
 }
 
-declare const VERSION = "0.7.0";
+declare const VERSION = "0.7.1";
 
 /**
  * Verify `BillKit-Signature: t=<unix>,v1=<hex>` headers.

package/dist/index.js

@@ -166,7 +166,10 @@ var Products = class extends BaseResource {
   create(params) {
     return this.post("/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(id, options = {}) {
     return this.get(`/v1/products/${p(id)}`, options);
   }
@@ -971,7 +974,7 @@ function sleep(ms) {
 }
 
 // src/version.ts
-var VERSION = "0.7.0";
+var VERSION = "0.7.1";
 
 // src/transport.ts
 var DEFAULT_BASE_URL = "https://api.billkit.eu";