@billkit-eu/sdk 0.7.1 → 0.8.0

package/dist/index.d.cts

@@ -260,6 +260,20 @@ interface PaymentsListParams extends BaseListParams {
     /** Expandable here: `customer`, `subscription`. */
     expand?: string[];
 }
+/**
+ * `oneShotPayments.list` params. `payments.list` lists subscription
+ * payments only; one-off charges are listed here, newest first.
+ * Failed, expired and still-open charges are included, so check `status`
+ * before counting a row as revenue.
+ */
+interface OneShotPaymentsListParams extends BaseListParams {
+    customer_id?: string;
+    /**
+     * One of `open`, `pending`, `authorized`, `paid`, `failed`, `expired`,
+     * `canceled`, `refunded`. Anything else is a `400` on `status`.
+     */
+    status?: string;
+}
 /**
  * `invoices.list` params. The three id filters each narrow to one row's
  * worth of invoices: `payment_id` answers "which invoice did this charge
@@ -328,7 +342,8 @@ interface CreateCustomerParams extends IdempotencyOptions {
 }
 interface UpdateCustomerParams extends IdempotencyOptions {
     email?: string;
-    name?: string;
+    /** An explicit `null` **clears** it and is sent as a JSON null rather than pruned (only `undefined` is dropped); omit the field to leave it alone. */
+    name?: string | null;
     country_code?: string;
     metadata?: Record<string, string>;
 }
@@ -391,7 +406,8 @@ interface CreateProductParams extends IdempotencyOptions {
 }
 interface UpdateProductParams extends IdempotencyOptions {
     name?: string;
-    description?: string;
+    /** An explicit `null` **clears** it and is sent as a JSON null rather than pruned (only `undefined` is dropped); omit the field to leave it alone. */
+    description?: string | null;
     marketing_features?: string[];
     metadata?: Record<string, string>;
     /** Set false to stop selling a product without deleting history. */
@@ -744,7 +760,8 @@ interface CreateWebhookEndpointParams extends IdempotencyOptions {
 interface UpdateWebhookEndpointParams extends IdempotencyOptions {
     url?: string;
     enabled_events?: string[];
-    description?: string;
+    /** An explicit `null` **clears** it and is sent as a JSON null rather than pruned (only `undefined` is dropped); omit the field to leave it alone. */
+    description?: string | null;
     status?: string;
 }
 interface EventsListParams extends BaseListParams {
@@ -786,8 +803,10 @@ interface CreateCouponParams extends IdempotencyOptions {
 }
 interface UpdateCouponParams extends IdempotencyOptions {
     active?: boolean;
-    max_redemptions?: number;
-    redeem_by?: number;
+    /** `null` removes the redemption cap. An explicit `null` **clears** it and is sent as a JSON null rather than pruned (only `undefined` is dropped); omit the field to leave it alone. */
+    max_redemptions?: number | null;
+    /** Epoch seconds. `null` removes the expiry. An explicit `null` **clears** it and is sent as a JSON null rather than pruned (only `undefined` is dropped); omit the field to leave it alone. */
+    redeem_by?: number | null;
     applies_to_price_ids?: string[];
     min_amount_cents?: number;
 }
@@ -814,7 +833,8 @@ interface CreateTaxRateParams extends IdempotencyOptions {
 }
 interface UpdateTaxRateParams extends IdempotencyOptions {
     rate_basis_points?: number;
-    display_name?: string;
+    /** An explicit `null` **clears** it and is sent as a JSON null rather than pruned (only `undefined` is dropped); omit the field to leave it alone. */
+    display_name?: string | null;
     inclusive?: boolean;
     active?: boolean;
 }
@@ -1048,6 +1068,13 @@ declare class OneShotPayments extends BaseResource {
     /** Create a one-off charge; returns the object with a `redirect_url`. */
     create<T = unknown>(params: CreateOneShotPaymentParams): Promise<T>;
     retrieve<T = unknown>(id: string): Promise<T>;
+    /** List one-off charges, newest first. Filter by `customer_id` and `status`. */
+    list<T = unknown>(params?: OneShotPaymentsListParams): Promise<ListResponseEnvelope<T>>;
+    iter<T = unknown>(options?: {
+        pageSize?: number;
+        customer_id?: string;
+        status?: string;
+    }): AsyncIterableIterator<T>;
 }
 declare class Subscriptions extends BaseResource {
     /** Expandable: `customer`, `price`, `refund_eligibility`. */
@@ -1469,7 +1496,20 @@ declare class AuditLogs extends BaseResource {
  * refunds and disputes are separate flows.
  */
 declare class Payments 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<T = unknown>(id: string, options?: ExpandOptions): Promise<T>;
     /**
      * Fetch the provider's own record of this charge, live.
@@ -1626,7 +1666,7 @@ declare class RateLimitError extends BillKitError {
     });
 }
 
-declare const VERSION = "0.7.1";
+declare const VERSION = "0.8.0";
 
 /**
  * Verify `BillKit-Signature: t=<unix>,v1=<hex>` headers.
@@ -1658,4 +1698,4 @@ interface VerifyWebhookOptions {
 }
 declare function verifyWebhookSignature<T = unknown>(options: VerifyWebhookOptions): Promise<T>;
 
-export { APIConnectionError, APIError, type AuditLogsListParams, AuthenticationError, type BaseListParams, BillKit, BillKitError, type BillKitLogger, type BillKitOptions, ConflictError, type CreateApiKeyParams, type CreateBillingPortalSessionParams, type CreateCheckoutSessionParams, type CreateCouponParams, type CreateCustomerParams, type CreateOneShotPaymentParams, type CreatePriceParams, type CreateProductParams, type CreateRefundParams, type CreateTaxRateParams, type CreateUsageRecordParams, type CreateWebhookEndpointParams, type CreditNotesListParams, type CustomerListParams, DEFAULT_RETRY_POLICY, DEFAULT_WEBHOOK_TOLERANCE_SECONDS, type DisputesListParams, type EventsListParams, type ExpandOptions, type IdempotencyOptions, InvalidRequestError, type InvoicesListParams, type ListParams, type ListResponseEnvelope, type LogContext, NOOP_LOGGER, type PaginateOptions, type PaymentsListParams, PermissionError, type PriceTier, type PricesListParams, type ProductsListParams, RateLimitError, ResourceMissingError, type RetryPolicy, type RotateProviderCredentialParams, ServerError, type SetCustomerVatNumberParams, type SetPortalBrandingParams, type SetTenantBillingProfileParams, type SubscriptionsListParams, type UpdateCouponParams, type UpdateCustomerParams, type UpdatePriceParams, type UpdateProductParams, type UpdateTaxRateParams, type UpdateWebhookEndpointParams, type UsageRecordsListParams, VERSION, type ValidateCouponParams, type VerifyWebhookOptions, type VoidInvoiceParams, WebhookVerificationError, paginate, verifyWebhookSignature };
+export { APIConnectionError, APIError, type AuditLogsListParams, AuthenticationError, type BaseListParams, BillKit, BillKitError, type BillKitLogger, type BillKitOptions, ConflictError, type CreateApiKeyParams, type CreateBillingPortalSessionParams, type CreateCheckoutSessionParams, type CreateCouponParams, type CreateCustomerParams, type CreateOneShotPaymentParams, type CreatePriceParams, type CreateProductParams, type CreateRefundParams, type CreateTaxRateParams, type CreateUsageRecordParams, type CreateWebhookEndpointParams, type CreditNotesListParams, type CustomerListParams, DEFAULT_RETRY_POLICY, DEFAULT_WEBHOOK_TOLERANCE_SECONDS, type DisputesListParams, type EventsListParams, type ExpandOptions, type IdempotencyOptions, InvalidRequestError, type InvoicesListParams, type ListParams, type ListResponseEnvelope, type LogContext, NOOP_LOGGER, type OneShotPaymentsListParams, type PaginateOptions, type PaymentsListParams, PermissionError, type PriceTier, type PricesListParams, type ProductsListParams, RateLimitError, ResourceMissingError, type RetryPolicy, type RotateProviderCredentialParams, ServerError, type SetCustomerVatNumberParams, type SetPortalBrandingParams, type SetTenantBillingProfileParams, type SubscriptionsListParams, type UpdateCouponParams, type UpdateCustomerParams, type UpdatePriceParams, type UpdateProductParams, type UpdateTaxRateParams, type UpdateWebhookEndpointParams, type UsageRecordsListParams, VERSION, type ValidateCouponParams, type VerifyWebhookOptions, type VoidInvoiceParams, WebhookVerificationError, paginate, verifyWebhookSignature };

package/dist/index.d.ts

@@ -260,6 +260,20 @@ interface PaymentsListParams extends BaseListParams {
     /** Expandable here: `customer`, `subscription`. */
     expand?: string[];
 }
+/**
+ * `oneShotPayments.list` params. `payments.list` lists subscription
+ * payments only; one-off charges are listed here, newest first.
+ * Failed, expired and still-open charges are included, so check `status`
+ * before counting a row as revenue.
+ */
+interface OneShotPaymentsListParams extends BaseListParams {
+    customer_id?: string;
+    /**
+     * One of `open`, `pending`, `authorized`, `paid`, `failed`, `expired`,
+     * `canceled`, `refunded`. Anything else is a `400` on `status`.
+     */
+    status?: string;
+}
 /**
  * `invoices.list` params. The three id filters each narrow to one row's
  * worth of invoices: `payment_id` answers "which invoice did this charge
@@ -328,7 +342,8 @@ interface CreateCustomerParams extends IdempotencyOptions {
 }
 interface UpdateCustomerParams extends IdempotencyOptions {
     email?: string;
-    name?: string;
+    /** An explicit `null` **clears** it and is sent as a JSON null rather than pruned (only `undefined` is dropped); omit the field to leave it alone. */
+    name?: string | null;
     country_code?: string;
     metadata?: Record<string, string>;
 }
@@ -391,7 +406,8 @@ interface CreateProductParams extends IdempotencyOptions {
 }
 interface UpdateProductParams extends IdempotencyOptions {
     name?: string;
-    description?: string;
+    /** An explicit `null` **clears** it and is sent as a JSON null rather than pruned (only `undefined` is dropped); omit the field to leave it alone. */
+    description?: string | null;
     marketing_features?: string[];
     metadata?: Record<string, string>;
     /** Set false to stop selling a product without deleting history. */
@@ -744,7 +760,8 @@ interface CreateWebhookEndpointParams extends IdempotencyOptions {
 interface UpdateWebhookEndpointParams extends IdempotencyOptions {
     url?: string;
     enabled_events?: string[];
-    description?: string;
+    /** An explicit `null` **clears** it and is sent as a JSON null rather than pruned (only `undefined` is dropped); omit the field to leave it alone. */
+    description?: string | null;
     status?: string;
 }
 interface EventsListParams extends BaseListParams {
@@ -786,8 +803,10 @@ interface CreateCouponParams extends IdempotencyOptions {
 }
 interface UpdateCouponParams extends IdempotencyOptions {
     active?: boolean;
-    max_redemptions?: number;
-    redeem_by?: number;
+    /** `null` removes the redemption cap. An explicit `null` **clears** it and is sent as a JSON null rather than pruned (only `undefined` is dropped); omit the field to leave it alone. */
+    max_redemptions?: number | null;
+    /** Epoch seconds. `null` removes the expiry. An explicit `null` **clears** it and is sent as a JSON null rather than pruned (only `undefined` is dropped); omit the field to leave it alone. */
+    redeem_by?: number | null;
     applies_to_price_ids?: string[];
     min_amount_cents?: number;
 }
@@ -814,7 +833,8 @@ interface CreateTaxRateParams extends IdempotencyOptions {
 }
 interface UpdateTaxRateParams extends IdempotencyOptions {
     rate_basis_points?: number;
-    display_name?: string;
+    /** An explicit `null` **clears** it and is sent as a JSON null rather than pruned (only `undefined` is dropped); omit the field to leave it alone. */
+    display_name?: string | null;
     inclusive?: boolean;
     active?: boolean;
 }
@@ -1048,6 +1068,13 @@ declare class OneShotPayments extends BaseResource {
     /** Create a one-off charge; returns the object with a `redirect_url`. */
     create<T = unknown>(params: CreateOneShotPaymentParams): Promise<T>;
     retrieve<T = unknown>(id: string): Promise<T>;
+    /** List one-off charges, newest first. Filter by `customer_id` and `status`. */
+    list<T = unknown>(params?: OneShotPaymentsListParams): Promise<ListResponseEnvelope<T>>;
+    iter<T = unknown>(options?: {
+        pageSize?: number;
+        customer_id?: string;
+        status?: string;
+    }): AsyncIterableIterator<T>;
 }
 declare class Subscriptions extends BaseResource {
     /** Expandable: `customer`, `price`, `refund_eligibility`. */
@@ -1469,7 +1496,20 @@ declare class AuditLogs extends BaseResource {
  * refunds and disputes are separate flows.
  */
 declare class Payments 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<T = unknown>(id: string, options?: ExpandOptions): Promise<T>;
     /**
      * Fetch the provider's own record of this charge, live.
@@ -1626,7 +1666,7 @@ declare class RateLimitError extends BillKitError {
     });
 }
 
-declare const VERSION = "0.7.1";
+declare const VERSION = "0.8.0";
 
 /**
  * Verify `BillKit-Signature: t=<unix>,v1=<hex>` headers.
@@ -1658,4 +1698,4 @@ interface VerifyWebhookOptions {
 }
 declare function verifyWebhookSignature<T = unknown>(options: VerifyWebhookOptions): Promise<T>;
 
-export { APIConnectionError, APIError, type AuditLogsListParams, AuthenticationError, type BaseListParams, BillKit, BillKitError, type BillKitLogger, type BillKitOptions, ConflictError, type CreateApiKeyParams, type CreateBillingPortalSessionParams, type CreateCheckoutSessionParams, type CreateCouponParams, type CreateCustomerParams, type CreateOneShotPaymentParams, type CreatePriceParams, type CreateProductParams, type CreateRefundParams, type CreateTaxRateParams, type CreateUsageRecordParams, type CreateWebhookEndpointParams, type CreditNotesListParams, type CustomerListParams, DEFAULT_RETRY_POLICY, DEFAULT_WEBHOOK_TOLERANCE_SECONDS, type DisputesListParams, type EventsListParams, type ExpandOptions, type IdempotencyOptions, InvalidRequestError, type InvoicesListParams, type ListParams, type ListResponseEnvelope, type LogContext, NOOP_LOGGER, type PaginateOptions, type PaymentsListParams, PermissionError, type PriceTier, type PricesListParams, type ProductsListParams, RateLimitError, ResourceMissingError, type RetryPolicy, type RotateProviderCredentialParams, ServerError, type SetCustomerVatNumberParams, type SetPortalBrandingParams, type SetTenantBillingProfileParams, type SubscriptionsListParams, type UpdateCouponParams, type UpdateCustomerParams, type UpdatePriceParams, type UpdateProductParams, type UpdateTaxRateParams, type UpdateWebhookEndpointParams, type UsageRecordsListParams, VERSION, type ValidateCouponParams, type VerifyWebhookOptions, type VoidInvoiceParams, WebhookVerificationError, paginate, verifyWebhookSignature };
+export { APIConnectionError, APIError, type AuditLogsListParams, AuthenticationError, type BaseListParams, BillKit, BillKitError, type BillKitLogger, type BillKitOptions, ConflictError, type CreateApiKeyParams, type CreateBillingPortalSessionParams, type CreateCheckoutSessionParams, type CreateCouponParams, type CreateCustomerParams, type CreateOneShotPaymentParams, type CreatePriceParams, type CreateProductParams, type CreateRefundParams, type CreateTaxRateParams, type CreateUsageRecordParams, type CreateWebhookEndpointParams, type CreditNotesListParams, type CustomerListParams, DEFAULT_RETRY_POLICY, DEFAULT_WEBHOOK_TOLERANCE_SECONDS, type DisputesListParams, type EventsListParams, type ExpandOptions, type IdempotencyOptions, InvalidRequestError, type InvoicesListParams, type ListParams, type ListResponseEnvelope, type LogContext, NOOP_LOGGER, type OneShotPaymentsListParams, type PaginateOptions, type PaymentsListParams, PermissionError, type PriceTier, type PricesListParams, type ProductsListParams, RateLimitError, ResourceMissingError, type RetryPolicy, type RotateProviderCredentialParams, ServerError, type SetCustomerVatNumberParams, type SetPortalBrandingParams, type SetTenantBillingProfileParams, type SubscriptionsListParams, type UpdateCouponParams, type UpdateCustomerParams, type UpdatePriceParams, type UpdateProductParams, type UpdateTaxRateParams, type UpdateWebhookEndpointParams, type UsageRecordsListParams, VERSION, type ValidateCouponParams, type VerifyWebhookOptions, type VoidInvoiceParams, WebhookVerificationError, paginate, verifyWebhookSignature };

package/dist/index.js

@@ -263,6 +263,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`. */
@@ -775,7 +785,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);
   }
@@ -974,7 +997,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";