@peable.to/contracts 6.0.0 → 6.2.0

package/dist/cjs/resources/billingEngine/index.js

@@ -23,6 +23,7 @@ const customerBalanceTransactions_1 = require("./customerBalanceTransactions");
 const invoiceItems_1 = require("./invoiceItems");
 const invoices_1 = require("./invoices");
 const public_1 = require("./public");
+const quotes_1 = require("./quotes");
 const subscriptions_1 = require("./subscriptions");
 __exportStar(require("./billingPortal"), exports);
 __exportStar(require("./creditNotes"), exports);
@@ -30,13 +31,15 @@ __exportStar(require("./customerBalanceTransactions"), exports);
 __exportStar(require("./invoiceItems"), exports);
 __exportStar(require("./invoices"), exports);
 __exportStar(require("./public"), exports);
+__exportStar(require("./quotes"), exports);
 __exportStar(require("./subscriptions"), exports);
-/** Orbit's native billing engine (ADR 0018): subscriptions, invoices, credit notes, the balance ledger and the customer portal. */
+/** Orbit's native billing engine (ADR 0018): subscriptions, invoices, credit notes, quotes, the balance ledger and the customer portal. */
 exports.billingEngineRoutes = [
     ...subscriptions_1.subscriptionRoutes,
     ...invoices_1.invoiceRoutes,
     ...invoiceItems_1.invoiceItemRoutes,
     ...creditNotes_1.creditNoteRoutes,
+    ...quotes_1.quoteRoutes,
     ...customerBalanceTransactions_1.customerBalanceTransactionRoutes,
     ...billingPortal_1.billingPortalRoutes,
     ...public_1.publicBillingRoutes,

package/dist/cjs/resources/billingEngine/quotes.js

@@ -0,0 +1,342 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.quoteRoutes = exports.listQuoteLineItemsQuery = exports.listQuotesQuery = exports.quoteActionParams = exports.finalizeQuoteParams = exports.updateQuoteParams = exports.createQuoteParams = exports.quoteSchema = void 0;
+const zod_1 = require("zod");
+const envelopes_1 = require("../../common/envelopes");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const invoices_1 = require("../../vocabulary/invoices");
+const quotes_1 = require("../../vocabulary/quotes");
+const subscriptions_1 = require("../../vocabulary/subscriptions");
+const shared_1 = require("../checkout/shared");
+const params_2 = require("./params");
+const subscriptions_2 = require("./subscriptions");
+/**
+ * Quotes (`qt_…`) — Stripe's Quotes on Orbit's native billing engine (ADR 0018
+ * §5). A quote prices catalog Prices for one customer: a `draft` is edited,
+ * `finalize` numbers it and fixes its discount and Peable Tax (failing closed,
+ * never zero), and `accept` turns it into native billing objects — an invoice
+ * for one-time lines, a subscription with its first invoice for recurring ones
+ * (one-time lines then ride on that first invoice). Its lines are Stripe's
+ * `item`, the same object a Checkout Session's lines are.
+ */
+const totalDetailsSchema = zod_1.z
+    .object({
+    amount_discount: primitives_1.amount,
+    amount_shipping: primitives_1.amount.describe('Always `0`: a quote ships nothing.'),
+    amount_tax: primitives_1.amount
+        .nullable()
+        .describe('Every tax, inclusive and exclusive; `null` on a draft whose tax is not known yet.'),
+})
+    .strict();
+exports.quoteSchema = (0, objects_1.defineObject)('quote', 'Quote', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('quote'),
+    livemode: primitives_1.livemode,
+    number: zod_1.z
+        .string()
+        .nullable()
+        .describe('`null` while a draft; `QT-PREFIX-0001` once finalized — per merchant.'),
+    status: zod_1.z.enum(quotes_1.QUOTE_STATUSES),
+    customer: (0, objects_1.expandable)('customer', '`cus_…`, or the Customer with `expand[]=customer`.'),
+    currency: primitives_1.currency,
+    collection_method: zod_1.z.enum(subscriptions_1.COLLECTION_METHODS),
+    invoice_settings: zod_1.z
+        .object({
+        days_until_due: zod_1.z
+            .number()
+            .int()
+            .nullable()
+            .describe("`send_invoice` only; the billing settings' default when `null`."),
+    })
+        .strict(),
+    subscription_data: zod_1.z
+        .object({
+        description: zod_1.z.string().nullable(),
+        trial_period_days: zod_1.z.number().int().nullable(),
+        metadata: primitives_1.metadata,
+    })
+        .strict()
+        .describe('What the subscription an accepted quote with recurring lines starts with.'),
+    discount: subscriptions_2.discountSchema.nullable(),
+    automatic_tax: zod_1.z
+        .object({
+        enabled: zod_1.z.boolean(),
+        status: zod_1.z.enum(invoices_1.AUTOMATIC_TAX_STATUSES).nullable(),
+        tax_calculation: zod_1.z
+            .string()
+            .nullable()
+            .describe('The Peable Tax calculation (`taxcalc_…`) the quote finalized with.'),
+    })
+        .strict(),
+    amount_subtotal: primitives_1.amount.describe('Every line before discount and tax (one period of a recurring line).'),
+    amount_total: primitives_1.amount.describe('`amount_subtotal - amount_discount + exclusive tax`.'),
+    total_details: totalDetailsSchema,
+    expires_at: primitives_1.unixSeconds.describe('An open quote is cancelled at this instant.'),
+    header: zod_1.z.string().nullable(),
+    description: zod_1.z.string().nullable(),
+    footer: zod_1.z.string().nullable(),
+    invoice: (0, objects_1.expandable)('invoice', "The invoice accepting made (`in_…`, expandable): the one-time invoice, or the subscription's first.").nullable(),
+    subscription: (0, objects_1.expandable)('subscription', 'The subscription accepting made (`sub_…`, expandable); `null` without recurring lines.').nullable(),
+    status_transitions: zod_1.z
+        .object({
+        finalized_at: primitives_1.unixSeconds.nullable(),
+        accepted_at: primitives_1.unixSeconds.nullable(),
+        canceled_at: primitives_1.unixSeconds.nullable(),
+    })
+        .strict(),
+    test_clock: zod_1.z.string().nullable(),
+    metadata: primitives_1.metadata,
+    created: primitives_1.unixSeconds,
+})
+    .strict(), {
+    examples: [
+        {
+            id: 'qt_0193b8f2c1a87d3e9f4a',
+            object: 'quote',
+            livemode: false,
+            number: 'QT-ACME-0001',
+            status: 'open',
+            customer: 'cus_0193b8f2c1a87d3e9f4a',
+            currency: 'EUR',
+            collection_method: 'send_invoice',
+            invoice_settings: { days_until_due: 30 },
+            subscription_data: { description: null, trial_period_days: null, metadata: {} },
+            discount: null,
+            automatic_tax: { enabled: false, status: null, tax_calculation: null },
+            amount_subtotal: '120000',
+            amount_total: '120000',
+            total_details: { amount_discount: '0', amount_shipping: '0', amount_tax: '0' },
+            expires_at: 1796342400,
+            header: 'Annual support',
+            description: null,
+            footer: null,
+            invoice: null,
+            subscription: null,
+            status_transitions: { finalized_at: 1793750400, accepted_at: null, canceled_at: null },
+            test_clock: null,
+            metadata: {},
+            created: 1793750400,
+        },
+    ],
+});
+// ---- Requests ------------------------------------------------------------------------
+const quoteLineItemParams = zod_1.z
+    .object({
+    price: params_1.idParam.describe('An active, licensed catalog Price (`price_…`), one-time or recurring.'),
+    quantity: zod_1.z
+        .number()
+        .int()
+        .min(1)
+        .max(quotes_1.QUOTE_LIMITS.quantityMax)
+        .optional()
+        .describe('Default 1.'),
+})
+    .strict();
+const lineItemsParam = zod_1.z
+    .array(quoteLineItemParams)
+    .min(1)
+    .max(quotes_1.QUOTE_LIMITS.lineItemsMax)
+    .describe('Each price once, in one currency; every recurring price on one interval. Replaces every line on an update.');
+const invoiceSettingsParam = zod_1.z.object({ days_until_due: params_2.daysUntilDueParam.optional() }).strict();
+const subscriptionDataParam = zod_1.z
+    .object({
+    description: (0, params_2.shortText)(500).optional(),
+    trial_period_days: zod_1.z.number().int().min(1).max(quotes_1.QUOTE_LIMITS.trialPeriodDaysMax).optional(),
+    metadata: params_1.metadataCreateParam.optional(),
+})
+    .strict();
+exports.createQuoteParams = zod_1.z
+    .object({
+    customer: params_1.idParam,
+    line_items: lineItemsParam,
+    collection_method: zod_1.z
+        .enum(subscriptions_1.COLLECTION_METHODS)
+        .optional()
+        .describe('Default `charge_automatically`; a FairCoin (`FAIR`) quote is always `send_invoice`.'),
+    invoice_settings: invoiceSettingsParam.optional(),
+    subscription_data: subscriptionDataParam.optional(),
+    discounts: params_2.discountsParam.optional().describe('At most one: a coupon or a promotion code.'),
+    automatic_tax: params_2.automaticTaxParam.optional(),
+    expires_at: params_1.unixSecondsParam
+        .optional()
+        .describe("Default: 30 days from now (the customer's test clock time when it has one)."),
+    header: (0, params_2.shortText)(quotes_1.QUOTE_LIMITS.headerMax).optional(),
+    description: (0, params_2.shortText)(quotes_1.QUOTE_LIMITS.descriptionMax).optional(),
+    footer: (0, params_2.shortText)(quotes_1.QUOTE_LIMITS.footerMax).optional(),
+    metadata: params_1.metadataCreateParam.optional(),
+    expand: params_1.expandParam.optional(),
+})
+    .strict();
+/** Drafts only, except `metadata`. A field sent as `""` is cleared. */
+exports.updateQuoteParams = zod_1.z
+    .object({
+    line_items: lineItemsParam.optional(),
+    collection_method: zod_1.z.enum(subscriptions_1.COLLECTION_METHODS).optional(),
+    invoice_settings: invoiceSettingsParam.optional(),
+    subscription_data: subscriptionDataParam.optional(),
+    discounts: zod_1.z.union([params_2.discountsParam, zod_1.z.literal('')]).optional(),
+    automatic_tax: params_2.automaticTaxParam.optional(),
+    expires_at: params_1.unixSecondsParam.optional(),
+    header: zod_1.z.union([(0, params_2.shortText)(quotes_1.QUOTE_LIMITS.headerMax), zod_1.z.literal('')]).optional(),
+    description: zod_1.z.union([(0, params_2.shortText)(quotes_1.QUOTE_LIMITS.descriptionMax), zod_1.z.literal('')]).optional(),
+    footer: zod_1.z.union([(0, params_2.shortText)(quotes_1.QUOTE_LIMITS.footerMax), zod_1.z.literal('')]).optional(),
+    metadata: params_1.metadataUpdateParam.optional(),
+    expand: params_1.expandParam.optional(),
+})
+    .strict();
+exports.finalizeQuoteParams = zod_1.z
+    .object({
+    expires_at: params_1.unixSecondsParam.optional().describe('A new expiry, set as it finalizes.'),
+    expand: params_1.expandParam.optional(),
+})
+    .strict();
+/** The body of `accept` and `cancel`: nothing but `expand[]`. */
+exports.quoteActionParams = zod_1.z.object({ expand: params_1.expandParam.optional() }).strict();
+exports.listQuotesQuery = (0, params_1.listQuery)({
+    customer: params_1.idParam.optional(),
+    status: zod_1.z.enum(quotes_1.QUOTE_STATUSES).optional(),
+});
+/** A quote's lines, in their order; `created` does not apply to them. */
+exports.listQuoteLineItemsQuery = (0, params_1.listQuery)({});
+// ---- Routes --------------------------------------------------------------------------
+const quoteId = { id: 'The quote (`qt_…`).' };
+exports.quoteRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'createQuote',
+        method: 'post',
+        path: '/v1/quotes',
+        tag: 'Quotes',
+        summary: 'Create a quote',
+        description: "A draft for one customer, priced from catalog Prices with the catalog's own pricing. Its tax is computed when it finalizes.",
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        body: exports.createQuoteParams,
+        response: exports.quoteSchema,
+        sdk: 'quotes.create',
+        expandable: 'quote',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'listQuotes',
+        method: 'get',
+        path: '/v1/quotes',
+        tag: 'Quotes',
+        summary: 'List quotes',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listQuotesQuery,
+        response: (0, envelopes_1.listOf)(exports.quoteSchema),
+        sdk: 'quotes.list',
+        expandable: 'quote',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveQuote',
+        method: 'get',
+        path: '/v1/quotes/{id}',
+        tag: 'Quotes',
+        summary: 'Retrieve a quote',
+        auth: 'service',
+        scope: 'payments:read',
+        params: quoteId,
+        query: params_1.expandOnlyQuery,
+        response: exports.quoteSchema,
+        sdk: 'quotes.retrieve',
+        expandable: 'quote',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'updateQuote',
+        method: 'post',
+        path: '/v1/quotes/{id}',
+        tag: 'Quotes',
+        summary: 'Update a quote',
+        description: 'Drafts only, except `metadata`. `line_items` replaces every line; a field sent as `""` is cleared; `metadata` is a patch.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: quoteId,
+        body: exports.updateQuoteParams,
+        response: exports.quoteSchema,
+        sdk: 'quotes.update',
+        expandable: 'quote',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'finalizeQuote',
+        method: 'post',
+        path: '/v1/quotes/{id}/finalize',
+        tag: 'Quotes',
+        summary: 'Finalize a draft quote',
+        description: 'It gets its number, its discount and its Peable Tax. Tax fails closed: a quote whose tax cannot be computed stays a draft (`automatic_tax.status` says why).',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: quoteId,
+        body: exports.finalizeQuoteParams,
+        response: exports.quoteSchema,
+        sdk: 'quotes.finalizeQuote',
+        expandable: 'quote',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'acceptQuote',
+        method: 'post',
+        path: '/v1/quotes/{id}/accept',
+        tag: 'Quotes',
+        summary: 'Accept an open quote',
+        description: 'The customer said yes. One-time lines become an invoice; recurring lines a subscription whose first invoice also carries the one-time lines. The invoice is finalized (tax before finalize) and collected as the engine collects any other: charged when `charge_automatically` and the customer has a card, otherwise paid on its hosted page — where FairCoin is always offered.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: quoteId,
+        body: exports.quoteActionParams,
+        response: exports.quoteSchema,
+        sdk: 'quotes.accept',
+        expandable: 'quote',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'cancelQuote',
+        method: 'post',
+        path: '/v1/quotes/{id}/cancel',
+        tag: 'Quotes',
+        summary: 'Cancel a quote',
+        description: 'A draft or an open quote; an accepted one cannot be cancelled.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: quoteId,
+        body: exports.quoteActionParams,
+        response: exports.quoteSchema,
+        sdk: 'quotes.cancel',
+        expandable: 'quote',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'listQuoteLineItems',
+        method: 'get',
+        path: '/v1/quotes/{id}/line_items',
+        tag: 'Quotes',
+        summary: "List a quote's line items",
+        description: "In their order (at most twenty); the cursor is a line's own `li_…`.",
+        auth: 'service',
+        scope: 'payments:read',
+        params: quoteId,
+        query: exports.listQuoteLineItemsQuery,
+        response: (0, envelopes_1.listOf)(shared_1.checkoutLineItemSchema),
+        sdk: 'quotes.listLineItems',
+        expandable: 'item',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveQuotePdf',
+        method: 'get',
+        path: '/v1/quotes/{id}/pdf',
+        tag: 'Quotes',
+        summary: "Download a quote's PDF",
+        description: 'A draft renders marked as a draft, without a number.',
+        auth: 'service',
+        scope: 'payments:read',
+        params: quoteId,
+        response: { kind: 'binary', contentType: 'application/pdf' },
+        sdk: 'quotes.pdf',
+    }),
+];

package/dist/cjs/resources/checkout/checkoutSessions.js

@@ -22,6 +22,10 @@ const shared_1 = require("./shared");
 const sessionFields = {
     id: zod_1.z.string(),
     object: zod_1.z.literal('checkout_session'),
+    contact_collection: zod_1.z
+        .enum(checkout_1.CHECKOUT_CONTACT_COLLECTIONS)
+        .optional()
+        .describe('Contact policy fixed by the merchant at creation. Absent means email. merchant_account delegates contact and notifications to the merchant account channel; it does not assert a Peable-verified identity.'),
     livemode: primitives_1.livemode,
     mode: zod_1.z.enum(checkout_1.CHECKOUT_SESSION_MODES),
     status: zod_1.z.enum(checkout_1.CHECKOUT_SESSION_STATUSES),
@@ -291,6 +295,10 @@ exports.createCheckoutSessionParams = zod_1.z
         .optional()
         .describe('`cus_…`; mutually exclusive with `customer_email`.'),
     customer_email: shared_1.checkoutEmailParam.optional(),
+    contact_collection: zod_1.z
+        .enum(checkout_1.CHECKOUT_CONTACT_COLLECTIONS)
+        .optional()
+        .describe('Defaults to email. merchant_account delegates contact and payment notifications to the merchant, which must have its own authenticated account channel. This is not identity verification by Peable. Payers cannot change this policy.'),
     customer_creation: zod_1.z
         .enum(checkout_1.CHECKOUT_CUSTOMER_CREATIONS)
         .optional()

package/dist/cjs/resources/events/events.js

@@ -274,6 +274,10 @@ exports.WEBHOOK_EVENT_DESCRIPTIONS = {
     'billing_portal.configuration.created': 'A customer portal configuration was created.',
     'billing_portal.configuration.updated': 'A customer portal configuration was updated.',
     'billing_portal.session.created': 'A customer portal session was created.',
+    'quote.created': 'A draft Quote was created.',
+    'quote.finalized': 'A Quote was finalized: numbered, priced and taxed, waiting for its customer.',
+    'quote.accepted': 'A Quote was accepted: its `invoice` (and, for recurring lines, its `subscription`) exists.',
+    'quote.canceled': 'A Quote was cancelled, or expired while open.',
     'tax.assessment.created': 'A tax compliance assessment was run. Nothing was registered, filed or collected.',
     'tax.review_item.created': 'A tax assessment finding opened a review item.',
     'tax.review_item.updated': 'A tax review item was decided, or found again.',

package/dist/cjs/vocabulary/checkout.js

@@ -4,7 +4,7 @@
 // the wallet import them without the schemas (`@peable.to/contracts/vocabulary`,
 // re-exported by `@peable.to/shared-types`).
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PAYMENT_LINK_LIMITS = exports.CHECKOUT_SESSION_ID_TEMPLATE = exports.CHECKOUT_LIMITS = exports.CHECKOUT_TAX_ID_TYPES = exports.CHECKOUT_CUSTOM_FIELD_TYPES = exports.CHECKOUT_BILLING_ADDRESS_COLLECTIONS = exports.CHECKOUT_CUSTOMER_CREATIONS = exports.CHECKOUT_SUBMIT_TYPES = exports.CHECKOUT_RTL_LOCALES = exports.CHECKOUT_LOCALES = exports.CHECKOUT_UI_MODES = exports.CHECKOUT_PAYMENT_STATUSES = exports.CHECKOUT_SESSION_STATUSES = exports.CHECKOUT_SESSION_MODES = exports.FAIRCOIN_UNAVAILABLE_REASONS = void 0;
+exports.CHECKOUT_CONTACT_COLLECTIONS = exports.PAYMENT_LINK_LIMITS = exports.CHECKOUT_SESSION_ID_TEMPLATE = exports.CHECKOUT_LIMITS = exports.CHECKOUT_TAX_ID_TYPES = exports.CHECKOUT_CUSTOM_FIELD_TYPES = exports.CHECKOUT_BILLING_ADDRESS_COLLECTIONS = exports.CHECKOUT_CUSTOMER_CREATIONS = exports.CHECKOUT_SUBMIT_TYPES = exports.CHECKOUT_RTL_LOCALES = exports.CHECKOUT_LOCALES = exports.CHECKOUT_UI_MODES = exports.CHECKOUT_PAYMENT_STATUSES = exports.CHECKOUT_SESSION_STATUSES = exports.CHECKOUT_SESSION_MODES = exports.FAIRCOIN_UNAVAILABLE_REASONS = void 0;
 exports.checkoutLocaleDirection = checkoutLocaleDirection;
 /**
  * Why FairCoin cannot be paid with on an order right now (ADR 0021). It is
@@ -102,3 +102,5 @@ exports.PAYMENT_LINK_LIMITS = Object.freeze({
     lineItemsMax: 20,
     customMessageMax: 500,
 });
+/** Who owns contact collection for a service-created checkout session. */
+exports.CHECKOUT_CONTACT_COLLECTIONS = ['email', 'merchant_account'];

package/dist/cjs/vocabulary/errors.js

@@ -117,6 +117,9 @@ exports.ERROR_CODE_DESCRIPTIONS = {
     invoice_not_editable: 'The invoice is finalized and can no longer be edited.',
     invoice_unexpected_state: 'The invoice is in a status that does not allow this operation.',
     invoice_no_customer_line_items: 'The invoice has no line items to finalize.',
+    quote_not_editable: 'Only a draft quote can be edited.',
+    quote_unexpected_state: "The quote's status does not allow this.",
+    quote_expired: 'The quote expired.',
     invoice_payment_intent_requires_action: "The invoice's payment needs the customer to act (a card challenge).",
     subscription_unexpected_state: 'The subscription is in a status that does not allow this operation.',
     customer_currency_mismatch: "The currency differs from the customer's billing currency.",

package/dist/cjs/vocabulary/events.js

@@ -123,6 +123,10 @@ exports.WEBHOOK_EVENT_OBJECTS = {
     'billing_portal.configuration.created': 'billing_portal.configuration',
     'billing_portal.configuration.updated': 'billing_portal.configuration',
     'billing_portal.session.created': 'billing_portal.session',
+    'quote.created': 'quote',
+    'quote.finalized': 'quote',
+    'quote.accepted': 'quote',
+    'quote.canceled': 'quote',
     'tax.assessment.created': 'tax.assessment',
     'tax.review_item.created': 'tax.review_item',
     'tax.review_item.updated': 'tax.review_item',

package/dist/cjs/vocabulary/index.js

@@ -29,6 +29,7 @@ __exportStar(require("./lists"), exports);
 __exportStar(require("./money"), exports);
 __exportStar(require("./tax"), exports);
 __exportStar(require("./subscriptions"), exports);
+__exportStar(require("./quotes"), exports);
 __exportStar(require("./reporting"), exports);
 __exportStar(require("./payments"), exports);
 __exportStar(require("./version"), exports);

package/dist/cjs/vocabulary/invoices.js

@@ -13,6 +13,9 @@ exports.INVOICE_BILLING_REASONS = [
     'subscription_update',
     'subscription_cancel',
     'upcoming',
+    // A one-time quote's invoice (Stripe's name); a recurring quote's first
+    // invoice is its subscription's `subscription_create`.
+    'quote_accept',
 ];
 /**
  * `automatic_tax.status` — Peable Tax (ADR 0011) is computed before an invoice

package/dist/cjs/vocabulary/quotes.js

@@ -0,0 +1,31 @@
+"use strict";
+// Quotes (`qt_…`, ADR 0018 §5) — the closed value sets their schemas are built
+// from. Zod-free: `@peable.to/shared-types` re-exports them at runtime.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QUOTE_LIMITS = exports.QUOTE_STATUSES = void 0;
+/**
+ * Where a quote stands — Stripe's four.
+ *
+ *  - `draft`    — being written; the only status a quote can be edited in.
+ *  - `open`     — finalized: numbered, priced and taxed, waiting for the
+ *                 customer's answer until `expires_at`.
+ *  - `accepted` — terminal: the native billing engine made its invoice (one-time
+ *                 lines) or its subscription and first invoice (recurring lines).
+ *  - `canceled` — terminal: cancelled by the merchant, or expired while open.
+ */
+exports.QUOTE_STATUSES = ['draft', 'open', 'accepted', 'canceled'];
+/** Bounds a quote is checked against. */
+exports.QUOTE_LIMITS = {
+    /** Lines on one quote — a subscription's item limit. */
+    lineItemsMax: 20,
+    quantityMax: 1000000,
+    /** `header` and `footer`; `description` is 1500 like an invoice's. */
+    headerMax: 50,
+    footerMax: 500,
+    descriptionMax: 1500,
+    /** A quote expires 30 days after it is created unless `expires_at` says otherwise (Stripe's default). */
+    defaultExpiryDays: 30,
+    /** `expires_at` at most this far ahead. */
+    expiryMaxDays: 365,
+    trialPeriodDaysMax: 730,
+};

package/dist/esm/resources/billingEngine/index.js

@@ -6,6 +6,7 @@ import { customerBalanceTransactionRoutes } from './customerBalanceTransactions.
 import { invoiceItemRoutes } from './invoiceItems.js';
 import { invoiceRoutes } from './invoices.js';
 import { publicBillingRoutes } from './public.js';
+import { quoteRoutes } from './quotes.js';
 import { subscriptionRoutes } from './subscriptions.js';
 export * from './billingPortal.js';
 export * from './creditNotes.js';
@@ -13,13 +14,15 @@ export * from './customerBalanceTransactions.js';
 export * from './invoiceItems.js';
 export * from './invoices.js';
 export * from './public.js';
+export * from './quotes.js';
 export * from './subscriptions.js';
-/** Orbit's native billing engine (ADR 0018): subscriptions, invoices, credit notes, the balance ledger and the customer portal. */
+/** Orbit's native billing engine (ADR 0018): subscriptions, invoices, credit notes, quotes, the balance ledger and the customer portal. */
 export const billingEngineRoutes = [
     ...subscriptionRoutes,
     ...invoiceRoutes,
     ...invoiceItemRoutes,
     ...creditNoteRoutes,
+    ...quoteRoutes,
     ...customerBalanceTransactionRoutes,
     ...billingPortalRoutes,
     ...publicBillingRoutes,