@boelabs/billete-sdk 0.4.0 → 0.6.0

package/README.md

@@ -109,12 +109,14 @@ Todos los métodos devuelven promesas con el recurso tipado. Los recursos con li
 | --- | --- |
 | `customers` | — |
 | `customerSessions` | `create` |
+| `portalSessions` | `create` (enlace al portal del cliente, válido 60 minutos) |
 | `products` | `retire`, `retireVariant` |
 | `plans` | — |
 | `features` | `check`, `isEnabled`, `listForCustomer`, `consume`, `release`, `set` |
 | `coupons` | — |
 | `checkouts` | `expire` |
 | `paymentLinks` | `retire` |
+| `invoices` | `void` (cobros: renovaciones y cobros sueltos, con página de pago en `url`) |
 | `subscriptions` | `cancel`, `resume` |
 | `payments` | `refund`, `listRefunds` |
 | `payouts` | — |
@@ -231,8 +233,18 @@ const { data: subscriptions } = await billete.customer.subscriptions();
 const tokens = await billete.customer.feature("tokens");
 ```
 
+Para no construir esa pantalla, envía a tu cliente al portal alojado:
+
+```ts
+const portal = await billete.portalSessions.create({
+  customer: "user_123",
+  returnUrl: "https://tuapp.com/cuenta",
+});
+// Redirige a portal.url: allí ve sus suscripciones y cobros, cambia su ciclo o cancela.
+```
+
 `customerSession` también acepta una función, útil cuando el token se renueva. Sin sesión, el
-cliente puede leer y pagar checkouts y links de pago, y consultar tasas y monedas.
+cliente puede leer y pagar checkouts, cobros y links de pago, y consultar tasas y monedas.
 
 ## Webhooks
 

package/dist/client.d.ts

@@ -1,15 +1,16 @@
-import { $ as SubscriptionRenewal, A as Payment, At as ENVIRONMENTS, B as Product, C as FEATURE_TYPES, Ct as MobilePrefix, D as FeatureUsageResult, Dt as isLandlinePhone, E as FeatureType, Et as Timestamp, F as PaymentStatus, G as Refund, H as ProductVariant, I as Payout, J as RiskLevel, K as ResetFrequency, L as Plan, M as PaymentFailure, Mt as TokenKind, N as PaymentLink, Nt as tokenEnvironment, O as PAYMENT_STATUSES, Ot as isMobilePhone, P as PaymentSettlement, Pt as tokenPrefix, Q as Subscription, R as PlanFeatureValues, S as ExchangeRate, St as Metadata, T as FeatureReset, Tt as TaxBehavior, U as RESET_FREQUENCIES, V as ProductCategory, W as RISK_LEVELS, X as SUBSCRIPTION_STATUSES, Y as SUBMIT_LABELS, Z as SubmitLabel, _ as Customer, _t as GracePeriodDays, a as Actor, at as ApiErrorBody, b as CustomerSession, bt as MAX_QUANTITY, c as BalanceAmount, ct as PAYMENT_FAILURE_CODES, d as CheckoutItem, dt as AddressInput, et as SubscriptionStatus, f as CheckoutPurpose, ft as BILLING_MONTHS, g as CustomField, gt as GRACE_PERIOD_DAYS, h as CurrencyAvailability, ht as Currency, i as WebhookEvent, it as API_ERROR_TYPES, j as PaymentAttempt, jt as Environment, k as PRODUCT_CATEGORIES, kt as nationalPhone, l as CHECKOUT_PURPOSES, lt as PaymentFailureCode, m as Coupon, mt as CURRENCIES, n as EventDataMap, nt as WebhookEndpoint, o as AfterCompletion, ot as ApiErrorEnvelope, p as CollectSettings, pt as BillingMonths, q as Retirement, r as EventType, rt as Weekday, s as Balance, st as ApiErrorType, t as EVENT_TYPES, tt as USAGE_FEATURE_TYPES, u as Checkout, ut as Address, v as CustomerDetails, vt as List, w as Feature, wt as TAX_BEHAVIORS, x as Event, xt as MOBILE_PREFIXES, y as CustomerFeature, yt as ListQuery, z as PlanPrice } from "./events-oZ08-Zz2.js";
-import { A as ProductCheckoutCreate, B as WebhookEndpointCreate, C as PaymentLinkUpdate, D as PlanLinkCreate, E as PlanFeaturesInput, F as RetireInput, G as PaymentTestScenario, H as CheckoutPaymentMethod, I as SubscriptionCancel, K as PublicCheckout, L as SubscriptionCreate, M as ProductLinkCreate, N as ProductUpdate, O as PlanPriceInput, P as RefundCreate, R as SubscriptionUpdate, S as PaymentLinkCreate, T as PlanCreate, U as PaymentInstructions, V as WebhookEndpointUpdate, W as PaymentMethodField, _ as CustomerUpdate, a as CheckoutCreate, b as FeatureUpdate, c as ClientCheckoutUpdate, d as CouponCreate, f as CouponUpdate, g as CustomerSessionCreate, h as CustomerInput, i as AfterCompletionInput, j as ProductCreate, k as PlanUpdate, l as ClientLinkCheckout, m as CustomerCreate, n as RequestOptions, o as CheckoutItemInput, p as CustomFieldInput, q as PublicPaymentLink, r as TransportOptions, s as ClientCheckoutPay, t as BilleteError, u as CollectInput, v as EventSelector, w as PlanCheckoutCreate, x as KEY_PATTERN, y as FeatureCreate, z as VariantInput } from "./errors-gwEcSkzi.js";
+import { $ as RISK_LEVELS, A as INVOICE_REASONS, At as MOBILE_PREFIXES, B as PaymentFailure, Bt as Environment, C as Event, Ct as CURRENCIES, D as FeatureReset, Dt as List, E as Feature, Et as GracePeriodDays, F as LineItem, Ft as Timestamp, G as Plan, H as PaymentSettlement, Ht as tokenEnvironment, I as PAYMENT_STATUSES, It as isLandlinePhone, J as PortalSession, K as PlanFeatureValues, L as PRODUCT_CATEGORIES, Lt as isMobilePhone, M as Invoice, Mt as MobilePrefix, N as InvoiceReason, Nt as TAX_BEHAVIORS, O as FeatureType, Ot as ListQuery, P as InvoiceStatus, Pt as TaxBehavior, Q as RESET_FREQUENCIES, R as Payment, Rt as nationalPhone, S as CustomerSession, St as BillingMonths, T as FEATURE_TYPES, Tt as GRACE_PERIOD_DAYS, U as PaymentStatus, Ut as tokenPrefix, V as PaymentLink, Vt as TokenKind, W as Payout, X as ProductCategory, Y as Product, Z as ProductVariant, _ as CurrencyAvailability, _t as PAYMENT_FAILURE_CODES, a as Actor, at as SUBSCRIPTION_STATUSES, b as CustomerDetails, bt as AddressInput, c as BalanceAmount, ct as SubscriptionRenewal, d as CancellationFeedback, dt as WebhookEndpoint, et as Refund, f as Checkout, ft as Weekday, g as Coupon, gt as ApiErrorType, h as CollectSettings, ht as ApiErrorEnvelope, i as WebhookEvent, it as SUBMIT_LABELS, j as INVOICE_STATUSES, jt as Metadata, k as FeatureUsageResult, kt as MAX_QUANTITY, l as CANCELLATION_FEEDBACK, lt as SubscriptionStatus, m as CheckoutPurpose, mt as ApiErrorBody, n as EventDataMap, nt as Retirement, o as AfterCompletion, ot as SubmitLabel, p as CheckoutItem, pt as API_ERROR_TYPES, q as PlanPrice, r as EventType, rt as RiskLevel, s as Balance, st as Subscription, t as EVENT_TYPES, tt as ResetFrequency, u as CHECKOUT_PURPOSES, ut as USAGE_FEATURE_TYPES, v as CustomField, vt as PaymentFailureCode, w as ExchangeRate, wt as Currency, x as CustomerFeature, xt as BILLING_MONTHS, y as Customer, yt as Address, z as PaymentAttempt, zt as ENVIRONMENTS } from "./events-DjO9ARae.js";
+import { $ as PaymentTestScenario, A as PlanCreate, B as RefundCreate, C as FeatureUpdate, D as PaymentLinkCreate, E as KEY_PATTERN, F as PortalSessionCreate, G as VariantInput, H as SubscriptionCancel, I as ProductCheckoutCreate, J as CustomerSubscription, K as WebhookEndpointCreate, L as ProductCreate, M as PlanLinkCreate, N as PlanPriceInput, O as PaymentLinkUpdate, P as PlanUpdate, Q as PaymentNextAction, R as ProductLinkCreate, S as FeatureCreate, T as InvoiceLineInput, U as SubscriptionCreate, V as RetireInput, W as SubscriptionUpdate, X as PaymentMethodField, Y as PaymentInstructions, Z as PaymentMethodOption, _ as CustomerCreate, a as CheckoutCreate, at as PublicPortal, b as CustomerUpdate, c as ClientCheckoutUpdate, d as ClientSubscriptionCancel, et as PortalFeatures, f as ClientSubscriptionUpdate, g as CustomFieldInput, h as CouponUpdate, i as AfterCompletionInput, it as PublicPaymentState, j as PlanFeaturesInput, k as PlanCheckoutCreate, l as ClientInvoicePay, m as CouponCreate, n as RequestOptions, nt as PublicInvoice, o as CheckoutItemInput, p as CollectInput, q as WebhookEndpointUpdate, r as TransportOptions, rt as PublicPaymentLink, s as ClientCheckoutPay, t as BilleteError, tt as PublicCheckout, u as ClientLinkCheckout, v as CustomerInput, w as InvoiceCreate, x as EventSelector, y as CustomerSessionCreate, z as ProductUpdate } from "./errors-BzzXE5C2.js";
 //#region src/create-client.d.ts
 interface ClientOptions extends TransportOptions {
   /**
    * Token from `billete.customerSessions.create()` on your server. Needed only for the
-   * `customer` methods; paying checkouts works without it.
+   * `customer` methods; paying checkouts and Cobros works without it.
    */
   customerSession?: string | (() => string | undefined);
 }
 /**
- * Browser client. It never holds a secret key: checkouts are addressed by their unguessable ID
+ * Browser client. It never holds a secret key: checkouts and Cobros are addressed by their
+ * unguessable ID
  * and customer data requires a short-lived customer session minted by your server.
  *
  * ```ts
@@ -24,10 +25,17 @@ export declare function createClient(options?: ClientOptions): {
     /** Changes quantity, variant, billing cycle or coupon on a payment link checkout. */
     update: (id: string, changes: ClientCheckoutUpdate, options?: RequestOptions) => Promise<PublicCheckout>;
     /** Methods that can pay this checkout, with the converted amount and transfer details. */
-    paymentMethods: (id: string, options?: RequestOptions) => Promise<List<CheckoutPaymentMethod>>;
+    paymentMethods: (id: string, options?: RequestOptions) => Promise<List<PaymentMethodOption>>;
     /** Submits the payment; the returned checkout carries the payment status and any failure. */
     pay: (id: string, input: ClientCheckoutPay, options?: RequestOptions) => Promise<PublicCheckout>;
   };
+  invoices: {
+    retrieve: (id: string, options?: RequestOptions) => Promise<PublicInvoice>;
+    /** Methods that can pay this Cobro, with the converted amount and transfer details. */
+    paymentMethods: (id: string, options?: RequestOptions) => Promise<List<PaymentMethodOption>>;
+    /** Submits the payment; the returned Cobro carries the payment status and any failure. */
+    pay: (id: string, input: ClientInvoicePay, options?: RequestOptions) => Promise<PublicInvoice>;
+  };
   paymentLinks: {
     retrieve: (id: string, options?: RequestOptions) => Promise<PublicPaymentLink>;
     createCheckout: (id: string, selection?: ClientLinkCheckout, options?: RequestOptions) => Promise<PublicCheckout>;
@@ -42,12 +50,21 @@ export declare function createClient(options?: ClientOptions): {
   /** The customer behind the session token. */
   customer: {
     retrieve: (options?: RequestOptions) => Promise<Customer>;
-    /** Subscriptions with their `renewal` block: due date, grace period and payment link. */
-    subscriptions: (options?: RequestOptions) => Promise<List<Subscription>>;
+    /** Subscriptions with their `renewal` block: due date, grace period and the Cobro to pay. */
+    subscriptions: (options?: RequestOptions) => Promise<List<CustomerSubscription>>;
+    /** Everything the customer portal shows: subscriptions, Cobros and what the business allows. */
+    portal: (options?: RequestOptions) => Promise<PublicPortal>;
+    /** Cancels at the end of the paid period; `resumeSubscription` undoes it until then. */
+    cancelSubscription: (id: string, input?: ClientSubscriptionCancel, options?: RequestOptions) => Promise<CustomerSubscription>;
+    resumeSubscription: (id: string, options?: RequestOptions) => Promise<CustomerSubscription>;
+    /** Switches the billing cycle from the next renewal. */
+    updateSubscription: (id: string, input: ClientSubscriptionUpdate, options?: RequestOptions) => Promise<CustomerSubscription>;
+    /** Withdraws the mandate: renewals are then paid by hand from their Cobro. */
+    stopAutoCharge: (id: string, options?: RequestOptions) => Promise<CustomerSubscription>;
     features: (options?: RequestOptions) => Promise<List<CustomerFeature>>;
     feature: (key: string, options?: RequestOptions) => Promise<CustomerFeature>;
   };
 };
 type BilleteClient = ReturnType<typeof createClient>;
 //#endregion
-export { type API_ERROR_TYPES, type Actor, type Address, type AddressInput, type AfterCompletion, type AfterCompletionInput, type ApiErrorBody, type ApiErrorEnvelope, type ApiErrorType, type BILLING_MONTHS, type Balance, type BalanceAmount, type BilleteClient, BilleteError, type BillingMonths, type CHECKOUT_PURPOSES, type CURRENCIES, type Checkout, type CheckoutCreate, type CheckoutItem, type CheckoutItemInput, type CheckoutPaymentMethod, type CheckoutPurpose, type ClientCheckoutPay, type ClientCheckoutUpdate, type ClientLinkCheckout, type ClientOptions, type CollectInput, type CollectSettings, type Coupon, type CouponCreate, type CouponUpdate, type Currency, type CurrencyAvailability, type CustomField, type CustomFieldInput, type Customer, type CustomerCreate, type CustomerDetails, type CustomerFeature, type CustomerInput, type CustomerSession, type CustomerSessionCreate, type CustomerUpdate, type ENVIRONMENTS, type EVENT_TYPES, type Environment, type Event, type EventDataMap, type EventSelector, type EventType, type ExchangeRate, type FEATURE_TYPES, type Feature, type FeatureCreate, type FeatureReset, type FeatureType, type FeatureUpdate, type FeatureUsageResult, type GRACE_PERIOD_DAYS, type GracePeriodDays, type KEY_PATTERN, type List, type ListQuery, type MAX_QUANTITY, type MOBILE_PREFIXES, type Metadata, type MobilePrefix, type PAYMENT_FAILURE_CODES, type PAYMENT_STATUSES, type PRODUCT_CATEGORIES, type Payment, type PaymentAttempt, type PaymentFailure, type PaymentFailureCode, type PaymentInstructions, type PaymentLink, type PaymentLinkCreate, type PaymentLinkUpdate, type PaymentMethodField, type PaymentSettlement, type PaymentStatus, type PaymentTestScenario, type Payout, type Plan, type PlanCheckoutCreate, type PlanCreate, type PlanFeatureValues, type PlanFeaturesInput, type PlanLinkCreate, type PlanPrice, type PlanPriceInput, type PlanUpdate, type Product, type ProductCategory, type ProductCheckoutCreate, type ProductCreate, type ProductLinkCreate, type ProductUpdate, type ProductVariant, type PublicCheckout, type PublicPaymentLink, type RESET_FREQUENCIES, type RISK_LEVELS, type Refund, type RefundCreate, type RequestOptions, type ResetFrequency, type RetireInput, type Retirement, type RiskLevel, type SUBMIT_LABELS, type SUBSCRIPTION_STATUSES, type SubmitLabel, type Subscription, type SubscriptionCancel, type SubscriptionCreate, type SubscriptionRenewal, type SubscriptionStatus, type SubscriptionUpdate, type TAX_BEHAVIORS, type TaxBehavior, type Timestamp, type TokenKind, type USAGE_FEATURE_TYPES, type VariantInput, type WebhookEndpoint, type WebhookEndpointCreate, type WebhookEndpointUpdate, type WebhookEvent, type Weekday, type isLandlinePhone, type isMobilePhone, type nationalPhone, type tokenEnvironment, type tokenPrefix };
+export { type API_ERROR_TYPES, type Actor, type Address, type AddressInput, type AfterCompletion, type AfterCompletionInput, type ApiErrorBody, type ApiErrorEnvelope, type ApiErrorType, type BILLING_MONTHS, type Balance, type BalanceAmount, type BilleteClient, BilleteError, type BillingMonths, type CANCELLATION_FEEDBACK, type CHECKOUT_PURPOSES, type CURRENCIES, type CancellationFeedback, type Checkout, type CheckoutCreate, type CheckoutItem, type CheckoutItemInput, type CheckoutPurpose, type ClientCheckoutPay, type ClientCheckoutUpdate, type ClientInvoicePay, type ClientLinkCheckout, type ClientOptions, type ClientSubscriptionCancel, type ClientSubscriptionUpdate, type CollectInput, type CollectSettings, type Coupon, type CouponCreate, type CouponUpdate, type Currency, type CurrencyAvailability, type CustomField, type CustomFieldInput, type Customer, type CustomerCreate, type CustomerDetails, type CustomerFeature, type CustomerInput, type CustomerSession, type CustomerSessionCreate, type CustomerSubscription, type CustomerUpdate, type ENVIRONMENTS, type EVENT_TYPES, type Environment, type Event, type EventDataMap, type EventSelector, type EventType, type ExchangeRate, type FEATURE_TYPES, type Feature, type FeatureCreate, type FeatureReset, type FeatureType, type FeatureUpdate, type FeatureUsageResult, type GRACE_PERIOD_DAYS, type GracePeriodDays, type INVOICE_REASONS, type INVOICE_STATUSES, type Invoice, type InvoiceCreate, type InvoiceLineInput, type InvoiceReason, type InvoiceStatus, type KEY_PATTERN, type LineItem, type List, type ListQuery, type MAX_QUANTITY, type MOBILE_PREFIXES, type Metadata, type MobilePrefix, type PAYMENT_FAILURE_CODES, type PAYMENT_STATUSES, type PRODUCT_CATEGORIES, type Payment, type PaymentAttempt, type PaymentFailure, type PaymentFailureCode, type PaymentInstructions, type PaymentLink, type PaymentLinkCreate, type PaymentLinkUpdate, type PaymentMethodField, type PaymentMethodOption, type PaymentNextAction, type PaymentSettlement, type PaymentStatus, type PaymentTestScenario, type Payout, type Plan, type PlanCheckoutCreate, type PlanCreate, type PlanFeatureValues, type PlanFeaturesInput, type PlanLinkCreate, type PlanPrice, type PlanPriceInput, type PlanUpdate, type PortalFeatures, type PortalSession, type PortalSessionCreate, type Product, type ProductCategory, type ProductCheckoutCreate, type ProductCreate, type ProductLinkCreate, type ProductUpdate, type ProductVariant, type PublicCheckout, type PublicInvoice, type PublicPaymentLink, type PublicPaymentState, type PublicPortal, type RESET_FREQUENCIES, type RISK_LEVELS, type Refund, type RefundCreate, type RequestOptions, type ResetFrequency, type RetireInput, type Retirement, type RiskLevel, type SUBMIT_LABELS, type SUBSCRIPTION_STATUSES, type SubmitLabel, type Subscription, type SubscriptionCancel, type SubscriptionCreate, type SubscriptionRenewal, type SubscriptionStatus, type SubscriptionUpdate, type TAX_BEHAVIORS, type TaxBehavior, type Timestamp, type TokenKind, type USAGE_FEATURE_TYPES, type VariantInput, type WebhookEndpoint, type WebhookEndpointCreate, type WebhookEndpointUpdate, type WebhookEvent, type Weekday, type isLandlinePhone, type isMobilePhone, type nationalPhone, type tokenEnvironment, type tokenPrefix };

package/dist/client.js

@@ -1,7 +1,8 @@
-import { n as segment, r as BilleteError, t as createTransport } from "./http-B5DzcQK9.js";
+import { n as segment, r as BilleteError, t as createTransport } from "./http-Q-RXDFbe.js";
 //#region src/create-client.ts
 /**
-* Browser client. It never holds a secret key: checkouts are addressed by their unguessable ID
+* Browser client. It never holds a secret key: checkouts and Cobros are addressed by their
+* unguessable ID
 * and customer data requires a short-lived customer session minted by your server.
 *
 * ```ts
@@ -17,6 +18,7 @@ function createClient(options = {}) {
 		token: typeof session === "function" ? session : () => session
 	});
 	const checkoutPath = (id) => `/v1/client/checkouts/${segment(id)}`;
+	const invoicePath = (id) => `/v1/client/invoices/${segment(id)}`;
 	return {
 		checkouts: {
 			retrieve: (id, options) => http.request({
@@ -45,6 +47,26 @@ function createClient(options = {}) {
 				options
 			})
 		},
+		invoices: {
+			retrieve: (id, options) => http.request({
+				method: "GET",
+				path: invoicePath(id),
+				options
+			}),
+			/** Methods that can pay this Cobro, with the converted amount and transfer details. */
+			paymentMethods: (id, options) => http.request({
+				method: "GET",
+				path: `${invoicePath(id)}/payment-methods`,
+				options
+			}),
+			/** Submits the payment; the returned Cobro carries the payment status and any failure. */
+			pay: (id, input, options) => http.request({
+				method: "POST",
+				path: `${invoicePath(id)}/pay`,
+				body: input,
+				options
+			})
+		},
 		paymentLinks: {
 			retrieve: (id, options) => http.request({
 				method: "GET",
@@ -77,12 +99,43 @@ list: (options) => http.request({
 				path: "/v1/client/customer",
 				options
 			}),
-			/** Subscriptions with their `renewal` block: due date, grace period and payment link. */
+			/** Subscriptions with their `renewal` block: due date, grace period and the Cobro to pay. */
 			subscriptions: (options) => http.request({
 				method: "GET",
 				path: "/v1/client/customer/subscriptions",
 				options
 			}),
+			/** Everything the customer portal shows: subscriptions, Cobros and what the business allows. */
+			portal: (options) => http.request({
+				method: "GET",
+				path: "/v1/client/customer/portal",
+				options
+			}),
+			/** Cancels at the end of the paid period; `resumeSubscription` undoes it until then. */
+			cancelSubscription: (id, input = {}, options) => http.request({
+				method: "POST",
+				path: `/v1/client/customer/subscriptions/${segment(id)}/cancel`,
+				body: input,
+				options
+			}),
+			resumeSubscription: (id, options) => http.request({
+				method: "POST",
+				path: `/v1/client/customer/subscriptions/${segment(id)}/resume`,
+				options
+			}),
+			/** Switches the billing cycle from the next renewal. */
+			updateSubscription: (id, input, options) => http.request({
+				method: "PATCH",
+				path: `/v1/client/customer/subscriptions/${segment(id)}`,
+				body: input,
+				options
+			}),
+			/** Withdraws the mandate: renewals are then paid by hand from their Cobro. */
+			stopAutoCharge: (id, options) => http.request({
+				method: "POST",
+				path: `/v1/client/customer/subscriptions/${segment(id)}/stop-auto-charge`,
+				options
+			}),
 			features: (options) => http.request({
 				method: "GET",
 				path: "/v1/client/customer/features",

package/dist/{errors-gwEcSkzi.d.ts → errors-BzzXE5C2.d.ts}

@@ -1,5 +1,91 @@
-import { Et as Timestamp, F as PaymentStatus, M as PaymentFailure, St as Metadata, T as FeatureReset, Tt as TaxBehavior, V as ProductCategory, Z as SubmitLabel, _t as GracePeriodDays, at as ApiErrorBody, d as CheckoutItem, dt as AddressInput, f as CheckoutPurpose, g as CustomField, ht as Currency, jt as Environment, o as AfterCompletion, p as CollectSettings, pt as BillingMonths, r as EventType, st as ApiErrorType, v as CustomerDetails, z as PlanPrice } from "./events-oZ08-Zz2.js";
+import { B as PaymentFailure, Bt as Environment, D as FeatureReset, Et as GracePeriodDays, F as LineItem, Ft as Timestamp, N as InvoiceReason, P as InvoiceStatus, Pt as TaxBehavior, St as BillingMonths, U as PaymentStatus, X as ProductCategory, b as CustomerDetails, bt as AddressInput, d as CancellationFeedback, gt as ApiErrorType, h as CollectSettings, jt as Metadata, m as CheckoutPurpose, mt as ApiErrorBody, o as AfterCompletion, ot as SubmitLabel, p as CheckoutItem, q as PlanPrice, r as EventType, st as Subscription, v as CustomField, wt as Currency } from "./events-DjO9ARae.js";
 //#region ../contracts/src/client.d.ts
+/**
+ * A subscription as its customer sees it, in the browser: without the business's `metadata`, with
+ * its plan's name and the cycles the customer may switch to.
+ */
+interface CustomerSubscription extends Omit<Subscription, "metadata"> {
+  plan: {
+    name: string;
+    cycles: PlanPrice[];
+  };
+}
+/** What the business lets its customers do from the portal. */
+interface PortalFeatures {
+  /** Paid and closed Cobros are listed; open ones always are, so they can be paid. */
+  invoiceHistory: boolean;
+  /** Cancel at the end of the period, and resume before it. */
+  cancel: boolean;
+  /** Ask why when canceling. */
+  cancellationReasons: boolean;
+  /** Switch between the plan's billing cycles, from the next renewal. */
+  switchCycle: boolean;
+  /** Turn off automatic charging and pay each renewal by hand. */
+  stopAutoCharge: boolean;
+}
+/** What the customer portal shows: the customer's subscriptions and Cobros at one business. */
+interface PublicPortal {
+  object: "portal";
+  environment: Environment;
+  merchant: {
+    name: string;
+    supportEmail: string | null;
+    supportPhone: string | null;
+  };
+  customer: {
+    email: string;
+    name: string | null;
+  };
+  /** The business's message at the top of the portal. */
+  headline: string | null;
+  features: PortalFeatures;
+  returnUrl: string | null;
+  expiresAt: Timestamp;
+  subscriptions: CustomerSubscription[];
+  /** The latest Cobros, newest first; open ones are paid on their page (`url`). */
+  invoices: PublicInvoice[];
+}
+/** Where a payment stands, as a payment page shows it. */
+interface PublicPaymentState {
+  id: string;
+  status: PaymentStatus;
+  method: string | null;
+  failure: PaymentFailure | null;
+  /** What the payer must do to finish a pending payment; `null` when it only awaits the provider. */
+  nextAction: PaymentNextAction | null;
+}
+/** Browser-safe view of a Cobro: what its page needs to show and pay it. */
+interface PublicInvoice {
+  id: string;
+  object: "invoice";
+  environment: Environment;
+  number: string;
+  /** The Cobro's page. */
+  url: string;
+  status: InvoiceStatus;
+  reason: InvoiceReason;
+  merchant: {
+    name: string;
+    supportEmail: string | null;
+    supportPhone: string | null;
+  };
+  email: string;
+  description: string | null;
+  lines: LineItem[];
+  currency: Currency;
+  subtotal: number;
+  discount: number;
+  tax: number;
+  total: number;
+  taxBehavior: TaxBehavior;
+  couponCode: string | null;
+  periodStart: Timestamp | null;
+  periodEnd: Timestamp | null;
+  dueAt: Timestamp | null;
+  paidAt: Timestamp | null;
+  createdAt: Timestamp;
+  payment: PublicPaymentState | null;
+}
 /** Browser-safe view of a checkout: everything needed to render and pay it, nothing internal. */
 interface PublicCheckout {
   id: string;
@@ -27,6 +113,16 @@ interface PublicCheckout {
   adjustableQuantity: boolean;
   /** Most units the customer can choose right now: the link's limit, capped by stock. */
   maxQuantity: number;
+  /**
+   * Variants the customer may switch between for a product checkout. `maxQuantity` is the most
+   * units of that variant one purchase can take right now; `0` means it is sold out.
+   */
+  variants: Array<{
+    id: string;
+    name: string;
+    amount: number;
+    maxQuantity: number;
+  }> | null;
   /** Billing cycles the customer may switch between for a plan checkout. */
   cycles: Array<{
     months: BillingMonths;
@@ -39,13 +135,28 @@ interface PublicCheckout {
   afterCompletion: AfterCompletion;
   successUrl: string | null;
   expiresAt: Timestamp;
-  payment: {
-    id: string;
-    status: PaymentStatus;
-    method: string | null;
-    failure: PaymentFailure | null;
-  } | null;
+  payment: PublicPaymentState | null;
 }
+/**
+ * The step a provider asks of the payer after starting a charge: leave for its page and come back
+ * (`redirect`), or send the funds to what is shown, often as a QR code (`display`).
+ */
+type PaymentNextAction = {
+  type: "redirect";
+  url: string;
+} | {
+  type: "display";
+  /** What the value is: "Dirección USDT (TRC20)", "Código de pago". */
+  label: string;
+  /** Where to send the funds: a wallet address, a payment code. */
+  value: string;
+  /** Encoded in a QR code for the payer's app to scan, when the provider offers one. */
+  qr: string | null;
+  amount: number;
+  currency: Currency;
+  /** After this the payer must not send funds: the attempt fails if nothing arrived. */
+  expiresAt: Timestamp | null;
+};
 interface PaymentMethodField {
   key: string;
   label: string;
@@ -76,7 +187,7 @@ interface PaymentTestScenario {
   description: string;
   fields: Record<string, string>;
 }
-interface CheckoutPaymentMethod {
+interface PaymentMethodOption {
   id: string;
   name: string;
   description: string | null;
@@ -281,6 +392,13 @@ interface SubscriptionUpdate {
 interface SubscriptionCancel {
   /** `false` ends the subscription immediately. */
   atPeriodEnd?: boolean;
+  feedback?: CancellationFeedback;
+  comment?: string;
+}
+/** Canceling from the portal always waits for the period's end. */
+interface ClientSubscriptionCancel {
+  feedback?: CancellationFeedback;
+  comment?: string;
 }
 /** Exactly one of `percentOff` and `amountOff`; `amountOff` needs a `currency`. */
 interface CouponCreate {
@@ -375,6 +493,28 @@ interface PlanCheckoutCreate extends CheckoutFields {
   months: BillingMonths;
 }
 type CheckoutCreate = ProductCheckoutCreate | PlanCheckoutCreate;
+interface InvoiceLineInput {
+  description: string;
+  quantity?: number;
+  /** Per unit, in minor units. */
+  unitAmount: number;
+}
+/** A one-off Cobro for a customer, payable from its page (`url`). */
+interface InvoiceCreate {
+  customer: CustomerInput;
+  currency: Currency;
+  lines: InvoiceLineInput[];
+  /** Defaults to the business's tax behavior for new prices (`inclusive`). */
+  taxBehavior?: TaxBehavior;
+  /** Days to pay it; without it the Cobro has no due date. */
+  daysUntilDue?: number;
+  description?: string;
+  metadata?: Metadata;
+}
+interface ClientInvoicePay {
+  method: string;
+  fields?: Record<string, string>;
+}
 interface ClientLinkCheckout {
   variant?: string;
   quantity?: number;
@@ -401,6 +541,15 @@ interface CustomerSessionCreate {
   customer: string;
   expiresInMinutes?: number;
 }
+interface PortalSessionCreate {
+  /** A `cus_…` ID or your own `externalId`. */
+  customer: string;
+  returnUrl?: string;
+}
+/** The cycle a customer switches to from the portal; it applies from the next renewal. */
+interface ClientSubscriptionUpdate {
+  months: BillingMonths;
+}
 interface ClientCheckoutUpdate {
   quantity?: number;
   variant?: string;
@@ -449,4 +598,4 @@ declare class BilleteError extends Error {
   }, status: number);
 }
 //#endregion
-export { ProductCheckoutCreate as A, WebhookEndpointCreate as B, PaymentLinkUpdate as C, PlanLinkCreate as D, PlanFeaturesInput as E, RetireInput as F, PaymentTestScenario as G, CheckoutPaymentMethod as H, SubscriptionCancel as I, PublicCheckout as K, SubscriptionCreate as L, ProductLinkCreate as M, ProductUpdate as N, PlanPriceInput as O, RefundCreate as P, SubscriptionUpdate as R, PaymentLinkCreate as S, PlanCreate as T, PaymentInstructions as U, WebhookEndpointUpdate as V, PaymentMethodField as W, CustomerUpdate as _, CheckoutCreate as a, FeatureUpdate as b, ClientCheckoutUpdate as c, CouponCreate as d, CouponUpdate as f, CustomerSessionCreate as g, CustomerInput as h, AfterCompletionInput as i, ProductCreate as j, PlanUpdate as k, ClientLinkCheckout as l, CustomerCreate as m, RequestOptions as n, CheckoutItemInput as o, CustomFieldInput as p, PublicPaymentLink as q, TransportOptions as r, ClientCheckoutPay as s, BilleteError as t, CollectInput as u, EventSelector as v, PlanCheckoutCreate as w, KEY_PATTERN as x, FeatureCreate as y, VariantInput as z };
+export { PaymentTestScenario as $, PlanCreate as A, RefundCreate as B, FeatureUpdate as C, PaymentLinkCreate as D, KEY_PATTERN as E, PortalSessionCreate as F, VariantInput as G, SubscriptionCancel as H, ProductCheckoutCreate as I, CustomerSubscription as J, WebhookEndpointCreate as K, ProductCreate as L, PlanLinkCreate as M, PlanPriceInput as N, PaymentLinkUpdate as O, PlanUpdate as P, PaymentNextAction as Q, ProductLinkCreate as R, FeatureCreate as S, InvoiceLineInput as T, SubscriptionCreate as U, RetireInput as V, SubscriptionUpdate as W, PaymentMethodField as X, PaymentInstructions as Y, PaymentMethodOption as Z, CustomerCreate as _, CheckoutCreate as a, PublicPortal as at, CustomerUpdate as b, ClientCheckoutUpdate as c, ClientSubscriptionCancel as d, PortalFeatures as et, ClientSubscriptionUpdate as f, CustomFieldInput as g, CouponUpdate as h, AfterCompletionInput as i, PublicPaymentState as it, PlanFeaturesInput as j, PlanCheckoutCreate as k, ClientInvoicePay as l, CouponCreate as m, RequestOptions as n, PublicInvoice as nt, CheckoutItemInput as o, CollectInput as p, WebhookEndpointUpdate as q, TransportOptions as r, PublicPaymentLink as rt, ClientCheckoutPay as s, BilleteError as t, PublicCheckout as tt, ClientLinkCheckout as u, CustomerInput as v, InvoiceCreate as w, EventSelector as x, CustomerSessionCreate as y, ProductUpdate as z };

package/dist/{events-oZ08-Zz2.d.ts → events-DjO9ARae.d.ts}

@@ -108,7 +108,9 @@ interface ApiErrorEnvelope {
   error: ApiErrorBody;
 }
 /** Normalized payment failure codes, independent of the provider that produced them. */
-declare const PAYMENT_FAILURE_CODES: readonly ["insufficient_funds", "payment_not_found", "amount_mismatch", "invalid_details", "declined", "provider_unavailable"];
+declare const PAYMENT_FAILURE_CODES: readonly ["insufficient_funds", "payment_not_found", "amount_mismatch", "invalid_details", "declined", "provider_unavailable",
+/** The payer did not complete the payment in time (an address or code to pay expired). */
+"expired"];
 type PaymentFailureCode = (typeof PAYMENT_FAILURE_CODES)[number];
 //#endregion
 //#region ../contracts/src/resources.d.ts
@@ -277,9 +279,13 @@ interface SubscriptionRenewal {
   daysRemaining: number;
   amount: number;
   currency: Currency;
-  checkoutId: string | null;
-  checkoutUrl: string | null;
+  /** The Cobro to pay the renewal with, once it is open. */
+  invoiceId: string | null;
+  invoiceUrl: string | null;
 }
+/** Why a customer canceled, as they chose it (Stripe's `cancellation_details.feedback`). */
+declare const CANCELLATION_FEEDBACK: readonly ["too_expensive", "missing_features", "switched_service", "unused", "customer_service", "too_complex", "low_quality", "other"];
+type CancellationFeedback = (typeof CANCELLATION_FEEDBACK)[number];
 interface Subscription extends Resource<"subscription"> {
   customerId: string;
   planId: string;
@@ -292,6 +298,11 @@ interface Subscription extends Resource<"subscription"> {
   trialEndsAt: Timestamp | null;
   cancelAtPeriodEnd: boolean;
   canceledAt: Timestamp | null;
+  /** What the customer said when canceling; `null` when they said nothing. */
+  cancellationDetails: {
+    feedback: CancellationFeedback | null;
+    comment: string | null;
+  } | null;
   endedAt: Timestamp | null;
   /** A plan or cycle change that takes effect on the next renewal. */
   pendingChange: {
@@ -299,6 +310,14 @@ interface Subscription extends Resource<"subscription"> {
     months: BillingMonths;
   } | null;
   renewal: SubscriptionRenewal | null;
+  /**
+   * The mandate renewals are charged with, when the first payment's method allows it; `null`
+   * when the customer pays each renewal by hand.
+   */
+  autoCharge: {
+    method: string;
+    label: string;
+  } | null;
   metadata: Metadata;
   updatedAt: Timestamp;
 }
@@ -361,8 +380,10 @@ interface PaymentLink extends Resource<"payment_link">, Retirement {
   metadata: Metadata;
   updatedAt: Timestamp;
 }
-interface CheckoutItem {
-  type: "product" | "plan";
+/** One line of a checkout or a Cobro: what is paid, how many and for how much. */
+interface LineItem {
+  /** `custom`: a line of a one-off Cobro, described by the business. */
+  type: "product" | "plan" | "custom";
   productId: string | null;
   variantId: string | null;
   planId: string | null;
@@ -372,12 +393,16 @@ interface CheckoutItem {
   unitAmount: number;
   amount: number;
 }
+/** A checkout sells catalog items only. */
+interface CheckoutItem extends LineItem {
+  type: "product" | "plan";
+}
 interface CustomerDetails {
   name: string | null;
   phone: string | null;
   address: Address | null;
 }
-declare const CHECKOUT_PURPOSES: readonly ["product", "plan", "renewal"];
+declare const CHECKOUT_PURPOSES: readonly ["product", "plan"];
 type CheckoutPurpose = (typeof CHECKOUT_PURPOSES)[number];
 interface Checkout extends Resource<"checkout"> {
   url: string;
@@ -400,6 +425,8 @@ interface Checkout extends Resource<"checkout"> {
   subscriptionId: string | null;
   paymentLinkId: string | null;
   paymentId: string | null;
+  /** The Cobro issued when it was paid, as the record of the sale. */
+  invoiceId: string | null;
   collect: CollectSettings;
   customFields: CustomField[];
   customFieldValues: Record<string, string | number>;
@@ -409,6 +436,46 @@ interface Checkout extends Resource<"checkout"> {
   completedAt: Timestamp | null;
   metadata: Metadata;
 }
+declare const INVOICE_STATUSES: readonly ["open", "paid", "void", "uncollectible"];
+type InvoiceStatus = (typeof INVOICE_STATUSES)[number];
+/** `checkout`: the record of a paid checkout. `subscription_cycle`: a renewal. `manual`: one-off. */
+declare const INVOICE_REASONS: readonly ["checkout", "subscription_cycle", "manual"];
+type InvoiceReason = (typeof INVOICE_REASONS)[number];
+/**
+ * A Cobro: what a customer owes and how it was paid, with its own payment page (`url`).
+ * Subscriptions issue one per renewal; businesses issue one-off ones; every paid checkout leaves
+ * one as the record of the sale. Not a fiscal invoice.
+ */
+interface Invoice extends Resource<"invoice"> {
+  /** Sequential per business and environment. */
+  number: string;
+  url: string;
+  reason: InvoiceReason;
+  /** `open` until paid. `void`: withdrawn. `uncollectible`: its deadline passed unpaid. */
+  status: InvoiceStatus;
+  customerId: string;
+  email: string;
+  subscriptionId: string | null;
+  checkoutId: string | null;
+  paymentId: string | null;
+  description: string | null;
+  lines: LineItem[];
+  currency: Currency;
+  subtotal: number;
+  discount: number;
+  tax: number;
+  total: number;
+  taxBehavior: TaxBehavior;
+  couponCode: string | null;
+  /** The subscription period a renewal pays for. */
+  periodStart: Timestamp | null;
+  periodEnd: Timestamp | null;
+  /** When it should be paid; past it a renewal enters its grace period. */
+  dueAt: Timestamp | null;
+  paidAt: Timestamp | null;
+  voidedAt: Timestamp | null;
+  metadata: Metadata;
+}
 declare const RISK_LEVELS: readonly ["normal", "elevated", "high"];
 type RiskLevel = (typeof RISK_LEVELS)[number];
 interface PaymentFailure {
@@ -439,7 +506,10 @@ interface PaymentSettlement {
   net: number;
 }
 interface Payment extends Resource<"payment"> {
-  checkoutId: string;
+  /** The checkout it paid, for purchases; `null` when it paid a Cobro directly. */
+  checkoutId: string | null;
+  /** Its Cobro: the one it paid, or the record a checkout issued when it completed. */
+  invoiceId: string | null;
   customerId: string;
   subscriptionId: string | null;
   status: PaymentStatus;
@@ -527,6 +597,15 @@ interface CustomerSession {
   customerId: string;
   expiresAt: Timestamp;
 }
+/** A link to the customer portal: send the customer to `url` before `expiresAt`. */
+interface PortalSession {
+  object: "portal_session";
+  url: string;
+  customerId: string;
+  /** Where the portal's "Volver" button leads; `null` hides it. */
+  returnUrl: string | null;
+  expiresAt: Timestamp;
+}
 //#endregion
 //#region ../contracts/src/events.d.ts
 interface EventDataMap {
@@ -541,6 +620,13 @@ interface EventDataMap {
   "payment.failed": Payment;
   "payment.refunded": Payment;
   "refund.created": Refund;
+  /** The provider could not return the funds; the amount is back in the balance. */
+  "refund.failed": Refund;
+  "invoice.created": Invoice;
+  "invoice.paid": Invoice;
+  "invoice.voided": Invoice;
+  /** Its deadline passed unpaid (a renewal whose grace period ended). */
+  "invoice.uncollectible": Invoice;
   "subscription.created": Subscription;
   "subscription.updated": Subscription;
   /** The renewal checkout is open; reminders start going out to the customer. */
@@ -553,7 +639,7 @@ interface EventDataMap {
   "subscription.expired": Subscription;
 }
 type EventType = keyof EventDataMap;
-declare const EVENT_TYPES: readonly ["product.retired", "product.updated", "payment_link.retired", "customer.created", "customer.updated", "checkout.completed", "checkout.expired", "payment.succeeded", "payment.failed", "payment.refunded", "refund.created", "subscription.created", "subscription.updated", "subscription.renewal_due", "subscription.renewed", "subscription.past_due", "subscription.canceled", "subscription.expired"];
+declare const EVENT_TYPES: readonly ["product.retired", "product.updated", "payment_link.retired", "customer.created", "customer.updated", "checkout.completed", "checkout.expired", "payment.succeeded", "payment.failed", "payment.refunded", "refund.created", "refund.failed", "invoice.created", "invoice.paid", "invoice.voided", "invoice.uncollectible", "subscription.created", "subscription.updated", "subscription.renewal_due", "subscription.renewed", "subscription.past_due", "subscription.canceled", "subscription.expired"];
 /** A delivered webhook, discriminated by `type` so `data` narrows automatically. */
 type WebhookEvent = { [TType in EventType]: {
   id: string;
@@ -564,4 +650,4 @@ type WebhookEvent = { [TType in EventType]: {
   data: EventDataMap[TType];
 }; }[EventType];
 //#endregion
-export { SubscriptionRenewal as $, Payment as A, ENVIRONMENTS as At, Product as B, FEATURE_TYPES as C, MobilePrefix as Ct, FeatureUsageResult as D, isLandlinePhone as Dt, FeatureType as E, Timestamp as Et, PaymentStatus as F, Refund as G, ProductVariant as H, Payout as I, RiskLevel as J, ResetFrequency as K, Plan as L, PaymentFailure as M, TokenKind as Mt, PaymentLink as N, tokenEnvironment as Nt, PAYMENT_STATUSES as O, isMobilePhone as Ot, PaymentSettlement as P, tokenPrefix as Pt, Subscription as Q, PlanFeatureValues as R, ExchangeRate as S, Metadata as St, FeatureReset as T, TaxBehavior as Tt, RESET_FREQUENCIES as U, ProductCategory as V, RISK_LEVELS as W, SUBSCRIPTION_STATUSES as X, SUBMIT_LABELS as Y, SubmitLabel as Z, Customer as _, GracePeriodDays as _t, Actor as a, ApiErrorBody as at, CustomerSession as b, MAX_QUANTITY as bt, BalanceAmount as c, PAYMENT_FAILURE_CODES as ct, CheckoutItem as d, AddressInput as dt, SubscriptionStatus as et, CheckoutPurpose as f, BILLING_MONTHS as ft, CustomField as g, GRACE_PERIOD_DAYS as gt, CurrencyAvailability as h, Currency as ht, WebhookEvent as i, API_ERROR_TYPES as it, PaymentAttempt as j, Environment as jt, PRODUCT_CATEGORIES as k, nationalPhone as kt, CHECKOUT_PURPOSES as l, PaymentFailureCode as lt, Coupon as m, CURRENCIES as mt, EventDataMap as n, WebhookEndpoint as nt, AfterCompletion as o, ApiErrorEnvelope as ot, CollectSettings as p, BillingMonths as pt, Retirement as q, EventType as r, Weekday as rt, Balance as s, ApiErrorType as st, EVENT_TYPES as t, USAGE_FEATURE_TYPES as tt, Checkout as u, Address as ut, CustomerDetails as v, List as vt, Feature as w, TAX_BEHAVIORS as wt, Event as x, MOBILE_PREFIXES as xt, CustomerFeature as y, ListQuery as yt, PlanPrice as z };
+export { RISK_LEVELS as $, INVOICE_REASONS as A, MOBILE_PREFIXES as At, PaymentFailure as B, Environment as Bt, Event as C, CURRENCIES as Ct, FeatureReset as D, List as Dt, Feature as E, GracePeriodDays as Et, LineItem as F, Timestamp as Ft, Plan as G, PaymentSettlement as H, tokenEnvironment as Ht, PAYMENT_STATUSES as I, isLandlinePhone as It, PortalSession as J, PlanFeatureValues as K, PRODUCT_CATEGORIES as L, isMobilePhone as Lt, Invoice as M, MobilePrefix as Mt, InvoiceReason as N, TAX_BEHAVIORS as Nt, FeatureType as O, ListQuery as Ot, InvoiceStatus as P, TaxBehavior as Pt, RESET_FREQUENCIES as Q, Payment as R, nationalPhone as Rt, CustomerSession as S, BillingMonths as St, FEATURE_TYPES as T, GRACE_PERIOD_DAYS as Tt, PaymentStatus as U, tokenPrefix as Ut, PaymentLink as V, TokenKind as Vt, Payout as W, ProductCategory as X, Product as Y, ProductVariant as Z, CurrencyAvailability as _, PAYMENT_FAILURE_CODES as _t, Actor as a, SUBSCRIPTION_STATUSES as at, CustomerDetails as b, AddressInput as bt, BalanceAmount as c, SubscriptionRenewal as ct, CancellationFeedback as d, WebhookEndpoint as dt, Refund as et, Checkout as f, Weekday as ft, Coupon as g, ApiErrorType as gt, CollectSettings as h, ApiErrorEnvelope as ht, WebhookEvent as i, SUBMIT_LABELS as it, INVOICE_STATUSES as j, Metadata as jt, FeatureUsageResult as k, MAX_QUANTITY as kt, CANCELLATION_FEEDBACK as l, SubscriptionStatus as lt, CheckoutPurpose as m, ApiErrorBody as mt, EventDataMap as n, Retirement as nt, AfterCompletion as o, SubmitLabel as ot, CheckoutItem as p, API_ERROR_TYPES as pt, PlanPrice as q, EventType as r, RiskLevel as rt, Balance as s, Subscription as st, EVENT_TYPES as t, ResetFrequency as tt, CHECKOUT_PURPOSES as u, USAGE_FEATURE_TYPES as ut, CustomField as v, PaymentFailureCode as vt, ExchangeRate as w, Currency as wt, CustomerFeature as x, BILLING_MONTHS as xt, Customer as y, Address as yt, PaymentAttempt as z, ENVIRONMENTS as zt };

package/dist/{http-B5DzcQK9.js → http-Q-RXDFbe.js}

@@ -18,7 +18,7 @@ var BilleteError = class extends Error {
 };
 //#endregion
 //#region src/http.ts
-const SDK_VERSION = "0.4.0";
+const SDK_VERSION = "0.6.0";
 const DEFAULT_BASE_URL = "https://api.billete.run";
 const RETRYABLE_STATUS = /* @__PURE__ */ new Set([
 	429,

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { $ as SubscriptionRenewal, A as Payment, At as ENVIRONMENTS, B as Product, C as FEATURE_TYPES, Ct as MobilePrefix, D as FeatureUsageResult, Dt as isLandlinePhone, E as FeatureType, Et as Timestamp, F as PaymentStatus, G as Refund, H as ProductVariant, I as Payout, J as RiskLevel, K as ResetFrequency, L as Plan, M as PaymentFailure, Mt as TokenKind, N as PaymentLink, Nt as tokenEnvironment, O as PAYMENT_STATUSES, Ot as isMobilePhone, P as PaymentSettlement, Pt as tokenPrefix, Q as Subscription, R as PlanFeatureValues, S as ExchangeRate, St as Metadata, T as FeatureReset, Tt as TaxBehavior, U as RESET_FREQUENCIES, V as ProductCategory, W as RISK_LEVELS, X as SUBSCRIPTION_STATUSES, Y as SUBMIT_LABELS, Z as SubmitLabel, _ as Customer, _t as GracePeriodDays, a as Actor, at as ApiErrorBody, b as CustomerSession, bt as MAX_QUANTITY, c as BalanceAmount, ct as PAYMENT_FAILURE_CODES, d as CheckoutItem, dt as AddressInput, et as SubscriptionStatus, f as CheckoutPurpose, ft as BILLING_MONTHS, g as CustomField, gt as GRACE_PERIOD_DAYS, h as CurrencyAvailability, ht as Currency, i as WebhookEvent, it as API_ERROR_TYPES, j as PaymentAttempt, jt as Environment, k as PRODUCT_CATEGORIES, kt as nationalPhone, l as CHECKOUT_PURPOSES, lt as PaymentFailureCode, m as Coupon, mt as CURRENCIES, n as EventDataMap, nt as WebhookEndpoint, o as AfterCompletion, ot as ApiErrorEnvelope, p as CollectSettings, pt as BillingMonths, q as Retirement, r as EventType, rt as Weekday, s as Balance, st as ApiErrorType, t as EVENT_TYPES, tt as USAGE_FEATURE_TYPES, u as Checkout, ut as Address, v as CustomerDetails, vt as List, w as Feature, wt as TAX_BEHAVIORS, x as Event, xt as MOBILE_PREFIXES, y as CustomerFeature, yt as ListQuery, z as PlanPrice } from "./events-oZ08-Zz2.js";
-import { A as ProductCheckoutCreate, B as WebhookEndpointCreate, C as PaymentLinkUpdate, D as PlanLinkCreate, E as PlanFeaturesInput, F as RetireInput, G as PaymentTestScenario, H as CheckoutPaymentMethod, I as SubscriptionCancel, K as PublicCheckout, L as SubscriptionCreate, M as ProductLinkCreate, N as ProductUpdate, O as PlanPriceInput, P as RefundCreate, R as SubscriptionUpdate, S as PaymentLinkCreate, T as PlanCreate, U as PaymentInstructions, V as WebhookEndpointUpdate, W as PaymentMethodField, _ as CustomerUpdate, a as CheckoutCreate, b as FeatureUpdate, c as ClientCheckoutUpdate, d as CouponCreate, f as CouponUpdate, g as CustomerSessionCreate, h as CustomerInput, i as AfterCompletionInput, j as ProductCreate, k as PlanUpdate, l as ClientLinkCheckout, m as CustomerCreate, n as RequestOptions, o as CheckoutItemInput, p as CustomFieldInput, q as PublicPaymentLink, r as TransportOptions, s as ClientCheckoutPay, t as BilleteError, u as CollectInput, v as EventSelector, w as PlanCheckoutCreate, x as KEY_PATTERN, y as FeatureCreate, z as VariantInput } from "./errors-gwEcSkzi.js";
+import { $ as RISK_LEVELS, A as INVOICE_REASONS, At as MOBILE_PREFIXES, B as PaymentFailure, Bt as Environment, C as Event, Ct as CURRENCIES, D as FeatureReset, Dt as List, E as Feature, Et as GracePeriodDays, F as LineItem, Ft as Timestamp, G as Plan, H as PaymentSettlement, Ht as tokenEnvironment, I as PAYMENT_STATUSES, It as isLandlinePhone, J as PortalSession, K as PlanFeatureValues, L as PRODUCT_CATEGORIES, Lt as isMobilePhone, M as Invoice, Mt as MobilePrefix, N as InvoiceReason, Nt as TAX_BEHAVIORS, O as FeatureType, Ot as ListQuery, P as InvoiceStatus, Pt as TaxBehavior, Q as RESET_FREQUENCIES, R as Payment, Rt as nationalPhone, S as CustomerSession, St as BillingMonths, T as FEATURE_TYPES, Tt as GRACE_PERIOD_DAYS, U as PaymentStatus, Ut as tokenPrefix, V as PaymentLink, Vt as TokenKind, W as Payout, X as ProductCategory, Y as Product, Z as ProductVariant, _ as CurrencyAvailability, _t as PAYMENT_FAILURE_CODES, a as Actor, at as SUBSCRIPTION_STATUSES, b as CustomerDetails, bt as AddressInput, c as BalanceAmount, ct as SubscriptionRenewal, d as CancellationFeedback, dt as WebhookEndpoint, et as Refund, f as Checkout, ft as Weekday, g as Coupon, gt as ApiErrorType, h as CollectSettings, ht as ApiErrorEnvelope, i as WebhookEvent, it as SUBMIT_LABELS, j as INVOICE_STATUSES, jt as Metadata, k as FeatureUsageResult, kt as MAX_QUANTITY, l as CANCELLATION_FEEDBACK, lt as SubscriptionStatus, m as CheckoutPurpose, mt as ApiErrorBody, n as EventDataMap, nt as Retirement, o as AfterCompletion, ot as SubmitLabel, p as CheckoutItem, pt as API_ERROR_TYPES, q as PlanPrice, r as EventType, rt as RiskLevel, s as Balance, st as Subscription, t as EVENT_TYPES, tt as ResetFrequency, u as CHECKOUT_PURPOSES, ut as USAGE_FEATURE_TYPES, v as CustomField, vt as PaymentFailureCode, w as ExchangeRate, wt as Currency, x as CustomerFeature, xt as BILLING_MONTHS, y as Customer, yt as Address, z as PaymentAttempt, zt as ENVIRONMENTS } from "./events-DjO9ARae.js";
+import { $ as PaymentTestScenario, A as PlanCreate, B as RefundCreate, C as FeatureUpdate, D as PaymentLinkCreate, E as KEY_PATTERN, F as PortalSessionCreate, G as VariantInput, H as SubscriptionCancel, I as ProductCheckoutCreate, J as CustomerSubscription, K as WebhookEndpointCreate, L as ProductCreate, M as PlanLinkCreate, N as PlanPriceInput, O as PaymentLinkUpdate, P as PlanUpdate, Q as PaymentNextAction, R as ProductLinkCreate, S as FeatureCreate, T as InvoiceLineInput, U as SubscriptionCreate, V as RetireInput, W as SubscriptionUpdate, X as PaymentMethodField, Y as PaymentInstructions, Z as PaymentMethodOption, _ as CustomerCreate, a as CheckoutCreate, at as PublicPortal, b as CustomerUpdate, c as ClientCheckoutUpdate, d as ClientSubscriptionCancel, et as PortalFeatures, f as ClientSubscriptionUpdate, g as CustomFieldInput, h as CouponUpdate, i as AfterCompletionInput, it as PublicPaymentState, j as PlanFeaturesInput, k as PlanCheckoutCreate, l as ClientInvoicePay, m as CouponCreate, n as RequestOptions, nt as PublicInvoice, o as CheckoutItemInput, p as CollectInput, q as WebhookEndpointUpdate, r as TransportOptions, rt as PublicPaymentLink, s as ClientCheckoutPay, t as BilleteError, tt as PublicCheckout, u as ClientLinkCheckout, v as CustomerInput, w as InvoiceCreate, x as EventSelector, y as CustomerSessionCreate, z as ProductUpdate } from "./errors-BzzXE5C2.js";
 import { WebhookVerificationError, verifyWebhook } from "./webhooks.js";
 //#region src/server.d.ts
 type Filters<T> = ListQuery & T;
@@ -39,6 +39,9 @@ export declare function createBillete(options: BilleteOptions): {
     /** Short-lived token for the client SDK to read one customer's billing state. */
     create: (input: CustomerSessionCreate, options?: RequestOptions) => Promise<CustomerSession>;
   };
+  portalSessions: {
+    create: (input: PortalSessionCreate, options?: RequestOptions) => Promise<PortalSession>;
+  };
   products: {
     create: (input: ProductCreate, options?: RequestOptions) => Promise<Product>;
     retrieve: (id: string, options?: RequestOptions) => Promise<Product>;
@@ -118,6 +121,22 @@ export declare function createBillete(options: BilleteOptions): {
     }>) => AsyncGenerator<PaymentLink, any, any>;
     retire: (id: string, input?: RetireInput, options?: RequestOptions) => Promise<PaymentLink>;
   };
+  invoices: {
+    create: (input: InvoiceCreate, options?: RequestOptions) => Promise<Invoice>;
+    retrieve: (id: string, options?: RequestOptions) => Promise<Invoice>;
+    list: (query?: Filters<{
+      customer?: string;
+      subscription?: string;
+      status?: InvoiceStatus;
+    }>, options?: RequestOptions) => Promise<List<Invoice>>;
+    iterate: (query?: Filters<{
+      customer?: string;
+      subscription?: string;
+      status?: InvoiceStatus;
+    }>) => AsyncGenerator<Invoice, any, any>;
+    /** Withdraws an open one-off Cobro; a renewal's is withdrawn by canceling its subscription. */
+    void: (id: string, options?: RequestOptions) => Promise<Invoice>;
+  };
   subscriptions: {
     create: (input: SubscriptionCreate, options?: RequestOptions) => Promise<Subscription>;
     retrieve: (id: string, options?: RequestOptions) => Promise<Subscription>;
@@ -194,4 +213,4 @@ export declare function createBillete(options: BilleteOptions): {
 /** The server client: what `createBillete` returns. */
 type Billete = ReturnType<typeof createBillete>;
 //#endregion
-export { type API_ERROR_TYPES, type Actor, type Address, type AddressInput, type AfterCompletion, type AfterCompletionInput, type ApiErrorBody, type ApiErrorEnvelope, type ApiErrorType, type BILLING_MONTHS, type Balance, type BalanceAmount, type Billete, BilleteError, type BilleteOptions, type BillingMonths, type CHECKOUT_PURPOSES, type CURRENCIES, type Checkout, type CheckoutCreate, type CheckoutItem, type CheckoutItemInput, type CheckoutPaymentMethod, type CheckoutPurpose, type ClientCheckoutPay, type ClientCheckoutUpdate, type ClientLinkCheckout, type CollectInput, type CollectSettings, type Coupon, type CouponCreate, type CouponUpdate, type Currency, type CurrencyAvailability, type CustomField, type CustomFieldInput, type Customer, type CustomerCreate, type CustomerDetails, type CustomerFeature, type CustomerInput, type CustomerSession, type CustomerSessionCreate, type CustomerUpdate, type ENVIRONMENTS, type EVENT_TYPES, type Environment, type Event, type EventDataMap, type EventSelector, type EventType, type ExchangeRate, type FEATURE_TYPES, type Feature, type FeatureCreate, type FeatureReset, type FeatureType, type FeatureUpdate, type FeatureUsageResult, type GRACE_PERIOD_DAYS, type GracePeriodDays, type KEY_PATTERN, type List, type ListQuery, type MAX_QUANTITY, type MOBILE_PREFIXES, type Metadata, type MobilePrefix, type PAYMENT_FAILURE_CODES, type PAYMENT_STATUSES, type PRODUCT_CATEGORIES, type Payment, type PaymentAttempt, type PaymentFailure, type PaymentFailureCode, type PaymentInstructions, type PaymentLink, type PaymentLinkCreate, type PaymentLinkUpdate, type PaymentMethodField, type PaymentSettlement, type PaymentStatus, type PaymentTestScenario, type Payout, type Plan, type PlanCheckoutCreate, type PlanCreate, type PlanFeatureValues, type PlanFeaturesInput, type PlanLinkCreate, type PlanPrice, type PlanPriceInput, type PlanUpdate, type Product, type ProductCategory, type ProductCheckoutCreate, type ProductCreate, type ProductLinkCreate, type ProductUpdate, type ProductVariant, type PublicCheckout, type PublicPaymentLink, type RESET_FREQUENCIES, type RISK_LEVELS, type Refund, type RefundCreate, type RequestOptions, type ResetFrequency, type RetireInput, type Retirement, type RiskLevel, type SUBMIT_LABELS, type SUBSCRIPTION_STATUSES, type SubmitLabel, type Subscription, type SubscriptionCancel, type SubscriptionCreate, type SubscriptionRenewal, type SubscriptionStatus, type SubscriptionUpdate, type TAX_BEHAVIORS, type TaxBehavior, type Timestamp, type TokenKind, type TransportOptions, type USAGE_FEATURE_TYPES, type VariantInput, type WebhookEndpoint, type WebhookEndpointCreate, type WebhookEndpointUpdate, type WebhookEvent, WebhookVerificationError, type Weekday, type isLandlinePhone, type isMobilePhone, type nationalPhone, type tokenEnvironment, type tokenPrefix, verifyWebhook };
+export { type API_ERROR_TYPES, type Actor, type Address, type AddressInput, type AfterCompletion, type AfterCompletionInput, type ApiErrorBody, type ApiErrorEnvelope, type ApiErrorType, type BILLING_MONTHS, type Balance, type BalanceAmount, type Billete, BilleteError, type BilleteOptions, type BillingMonths, type CANCELLATION_FEEDBACK, type CHECKOUT_PURPOSES, type CURRENCIES, type CancellationFeedback, type Checkout, type CheckoutCreate, type CheckoutItem, type CheckoutItemInput, type CheckoutPurpose, type ClientCheckoutPay, type ClientCheckoutUpdate, type ClientInvoicePay, type ClientLinkCheckout, type ClientSubscriptionCancel, type ClientSubscriptionUpdate, type CollectInput, type CollectSettings, type Coupon, type CouponCreate, type CouponUpdate, type Currency, type CurrencyAvailability, type CustomField, type CustomFieldInput, type Customer, type CustomerCreate, type CustomerDetails, type CustomerFeature, type CustomerInput, type CustomerSession, type CustomerSessionCreate, type CustomerSubscription, type CustomerUpdate, type ENVIRONMENTS, type EVENT_TYPES, type Environment, type Event, type EventDataMap, type EventSelector, type EventType, type ExchangeRate, type FEATURE_TYPES, type Feature, type FeatureCreate, type FeatureReset, type FeatureType, type FeatureUpdate, type FeatureUsageResult, type GRACE_PERIOD_DAYS, type GracePeriodDays, type INVOICE_REASONS, type INVOICE_STATUSES, type Invoice, type InvoiceCreate, type InvoiceLineInput, type InvoiceReason, type InvoiceStatus, type KEY_PATTERN, type LineItem, type List, type ListQuery, type MAX_QUANTITY, type MOBILE_PREFIXES, type Metadata, type MobilePrefix, type PAYMENT_FAILURE_CODES, type PAYMENT_STATUSES, type PRODUCT_CATEGORIES, type Payment, type PaymentAttempt, type PaymentFailure, type PaymentFailureCode, type PaymentInstructions, type PaymentLink, type PaymentLinkCreate, type PaymentLinkUpdate, type PaymentMethodField, type PaymentMethodOption, type PaymentNextAction, type PaymentSettlement, type PaymentStatus, type PaymentTestScenario, type Payout, type Plan, type PlanCheckoutCreate, type PlanCreate, type PlanFeatureValues, type PlanFeaturesInput, type PlanLinkCreate, type PlanPrice, type PlanPriceInput, type PlanUpdate, type PortalFeatures, type PortalSession, type PortalSessionCreate, type Product, type ProductCategory, type ProductCheckoutCreate, type ProductCreate, type ProductLinkCreate, type ProductUpdate, type ProductVariant, type PublicCheckout, type PublicInvoice, type PublicPaymentLink, type PublicPaymentState, type PublicPortal, type RESET_FREQUENCIES, type RISK_LEVELS, type Refund, type RefundCreate, type RequestOptions, type ResetFrequency, type RetireInput, type Retirement, type RiskLevel, type SUBMIT_LABELS, type SUBSCRIPTION_STATUSES, type SubmitLabel, type Subscription, type SubscriptionCancel, type SubscriptionCreate, type SubscriptionRenewal, type SubscriptionStatus, type SubscriptionUpdate, type TAX_BEHAVIORS, type TaxBehavior, type Timestamp, type TokenKind, type TransportOptions, type USAGE_FEATURE_TYPES, type VariantInput, type WebhookEndpoint, type WebhookEndpointCreate, type WebhookEndpointUpdate, type WebhookEvent, WebhookVerificationError, type Weekday, type isLandlinePhone, type isMobilePhone, type nationalPhone, type tokenEnvironment, type tokenPrefix, verifyWebhook };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { n as segment, r as BilleteError, t as createTransport } from "./http-B5DzcQK9.js";
+import { n as segment, r as BilleteError, t as createTransport } from "./http-Q-RXDFbe.js";
 import { WebhookVerificationError, verifyWebhook } from "./webhooks.js";
 //#region ../contracts/src/environment.ts
 /**
@@ -88,6 +88,13 @@ create: (input, options) => http.request({
 		body: input,
 		options
 	}) };
+	/** Links to the hosted customer portal, where a customer manages subscriptions and Cobros. */
+	const portalSessions = { create: (input, options) => http.request({
+		method: "POST",
+		path: "/v1/portal-sessions",
+		body: input,
+		options
+	}) };
 	const products = {
 		...collection(http, "/v1/products"),
 		retire: (id, input = {}, options) => http.request({
@@ -172,6 +179,20 @@ create: (input, options) => http.request({
 			options
 		})
 	};
+	const invoiceCrud = collection(http, "/v1/invoices");
+	/** Cobros: what a customer owes and pays from its page (`url`), one-off or per renewal. */
+	const invoices = {
+		create: invoiceCrud.create,
+		retrieve: invoiceCrud.retrieve,
+		list: invoiceCrud.list,
+		iterate: invoiceCrud.iterate,
+		/** Withdraws an open one-off Cobro; a renewal's is withdrawn by canceling its subscription. */
+		void: (id, options) => http.request({
+			method: "POST",
+			path: `/v1/invoices/${segment(id)}/void`,
+			options
+		})
+	};
 	const subscriptions = {
 		...collection(http, "/v1/subscriptions"),
 		/** Cancels at period end by default; pass `{ atPeriodEnd: false }` to end it now. */
@@ -227,12 +248,14 @@ create: (input, options) => http.request({
 	return {
 		customers,
 		customerSessions,
+		portalSessions,
 		products,
 		plans,
 		features,
 		coupons,
 		checkouts,
 		paymentLinks,
+		invoices,
 		subscriptions,
 		payments,
 		balance,

package/dist/webhooks.d.ts

@@ -1,4 +1,4 @@
-import { i as WebhookEvent } from "./events-oZ08-Zz2.js";
+import { i as WebhookEvent } from "./events-DjO9ARae.js";
 //#region src/webhooks.d.ts
 export declare class WebhookVerificationError extends Error {
   constructor(message: string);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boelabs/billete-sdk",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Billete SDK: server client, browser client and webhook verification",
   "keywords": [
     "billete",