@peable.to/contracts 0.4.0 → 1.0.0

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

@@ -0,0 +1,155 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invoiceItemRoutes = exports.listInvoiceItemsQuery = exports.updateInvoiceItemParams = exports.createInvoiceItemParams = exports.deletedInvoiceItemSchema = exports.invoiceItemSchema = void 0;
+const zod_1 = require("zod");
+const objects_1 = require("../../common/objects");
+const prices_1 = require("../catalog/prices");
+const envelopes_1 = require("../../common/envelopes");
+const objects_2 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const params_2 = require("./params");
+/**
+ * Invoice items (`ii_…`, ADR 0018 §2): a charge waiting for an invoice — a
+ * pending item is pulled into the customer's next invoice (a subscription's
+ * renewal, or a manual invoice with `pending_invoice_items_behavior=include`),
+ * or it is created directly on a draft.
+ */
+exports.invoiceItemSchema = (0, objects_2.defineObject)('invoiceitem', 'InvoiceItem', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('invoiceitem'),
+    livemode: primitives_1.livemode,
+    customer: (0, objects_2.expandable)('customer', '`cus_…`, or the Customer with `expand[]=customer`.'),
+    invoice: (0, objects_2.expandable)('invoice', 'The draft it is on (`in_…`, or the Invoice with `expand[]=invoice`); `null` while pending.').nullable(),
+    subscription: (0, objects_2.expandable)('subscription', '`sub_…`, or the Subscription with `expand[]=subscription`.').nullable(),
+    subscription_item: zod_1.z.string().nullable(),
+    price: (0, objects_1.embedded)('price', 'The Price, embedded; `null` for a fixed amount.').nullable(),
+    quantity: zod_1.z.number().int().nonnegative(),
+    unit_amount: primitives_1.amount
+        .nullable()
+        .describe('Base units per unit; `null` for a proration (an amount for a period, not per unit).'),
+    amount: primitives_1.signedAmount.describe('SIGNED (an engine-made proration credit is negative).'),
+    currency: primitives_1.currency,
+    description: zod_1.z.string().nullable(),
+    discountable: zod_1.z.boolean(),
+    period: zod_1.z.object({ start: primitives_1.unixSeconds, end: primitives_1.unixSeconds }).strict(),
+    proration: zod_1.z.boolean(),
+    metadata: primitives_1.metadata,
+    date: primitives_1.unixSeconds,
+})
+    .strict());
+exports.deletedInvoiceItemSchema = (0, objects_2.defineComponent)('DeletedInvoiceItem', (0, envelopes_1.deletedOf)('invoiceitem'));
+/**
+ * A price (`price` or `price_data`) times `quantity`, or a fixed `amount` +
+ * `currency`. Never negative — a credit is a credit note or a customer balance
+ * transaction.
+ */
+exports.createInvoiceItemParams = zod_1.z
+    .object({
+    customer: params_1.idParam,
+    invoice: params_1.idParam.optional().describe('A draft to put it on; absent, it is pending.'),
+    subscription: params_1.idParam.optional(),
+    price: params_1.idParam.optional(),
+    price_data: prices_1.priceDataParams
+        .optional()
+        .describe('A one-off per-unit price of an existing product, for an item that names no stored price.'),
+    quantity: params_2.quantityParam.optional(),
+    amount: params_2.amountParam.optional(),
+    currency: params_2.currencyParam.optional(),
+    description: (0, params_2.shortText)(500).optional(),
+    discountable: zod_1.z.boolean().optional(),
+    period: zod_1.z.object({ start: params_1.unixSecondsParam, end: params_1.unixSecondsParam }).strict().optional(),
+    metadata: params_1.metadataCreateParam.optional(),
+    expand: params_1.expandParam.optional(),
+})
+    .strict();
+/** Pending items, or items on a draft. A field sent as `""` is cleared; `metadata` is a patch. */
+exports.updateInvoiceItemParams = zod_1.z
+    .object({
+    description: zod_1.z.union([(0, params_2.shortText)(500), zod_1.z.literal('')]).optional(),
+    quantity: params_2.quantityParam.optional(),
+    discountable: zod_1.z.boolean().optional(),
+    metadata: params_1.metadataUpdateParam.optional(),
+    expand: params_1.expandParam.optional(),
+})
+    .strict();
+exports.listInvoiceItemsQuery = (0, params_1.listQuery)({
+    customer: params_1.idParam.optional(),
+    invoice: params_1.idParam.optional(),
+    pending: params_1.queryBoolean.optional().describe('Only items not on any invoice yet.'),
+});
+const invoiceItemId = { id: 'The invoice item (`ii_…`).' };
+exports.invoiceItemRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'createInvoiceItem',
+        method: 'post',
+        path: '/v1/invoiceitems',
+        tag: 'Invoice items',
+        summary: 'Create an invoice item',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        body: exports.createInvoiceItemParams,
+        response: exports.invoiceItemSchema,
+        sdk: 'invoiceItems.create',
+        expandable: 'invoiceitem',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'listInvoiceItems',
+        method: 'get',
+        path: '/v1/invoiceitems',
+        tag: 'Invoice items',
+        summary: 'List invoice items',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listInvoiceItemsQuery,
+        response: (0, envelopes_1.listOf)(exports.invoiceItemSchema),
+        sdk: 'invoiceItems.list',
+        expandable: 'invoiceitem',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveInvoiceItem',
+        method: 'get',
+        path: '/v1/invoiceitems/{id}',
+        tag: 'Invoice items',
+        summary: 'Retrieve an invoice item',
+        auth: 'service',
+        scope: 'payments:read',
+        params: invoiceItemId,
+        query: params_1.expandOnlyQuery,
+        response: exports.invoiceItemSchema,
+        sdk: 'invoiceItems.retrieve',
+        expandable: 'invoiceitem',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'updateInvoiceItem',
+        method: 'post',
+        path: '/v1/invoiceitems/{id}',
+        tag: 'Invoice items',
+        summary: 'Update an invoice item',
+        description: 'While it is pending or on a draft.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: invoiceItemId,
+        body: exports.updateInvoiceItemParams,
+        response: exports.invoiceItemSchema,
+        sdk: 'invoiceItems.update',
+        expandable: 'invoiceitem',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'deleteInvoiceItem',
+        method: 'delete',
+        path: '/v1/invoiceitems/{id}',
+        tag: 'Invoice items',
+        summary: 'Delete an invoice item',
+        description: 'While it is pending or on a draft.',
+        auth: 'service',
+        scope: 'payments:write',
+        params: invoiceItemId,
+        response: exports.deletedInvoiceItemSchema,
+        sdk: 'invoiceItems.del',
+    }),
+];

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

@@ -0,0 +1,509 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invoiceRoutes = exports.upcomingInvoiceQuery = exports.listInvoicesQuery = exports.invoiceActionParams = exports.payInvoiceParams = exports.finalizeInvoiceParams = exports.updateInvoiceParams = exports.createInvoiceParams = exports.deletedInvoiceSchema = exports.invoiceSchema = exports.invoiceLineItemSchema = exports.invoiceTaxAmountSchema = void 0;
+const zod_1 = require("zod");
+const objects_1 = require("../../common/objects");
+const envelopes_1 = require("../../common/envelopes");
+const objects_2 = 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 subscriptions_1 = require("../../vocabulary/subscriptions");
+const params_2 = require("./params");
+const subscriptions_2 = require("./subscriptions");
+/**
+ * Invoices (`in_…`) and their lines (`il_…`) — Orbit's native billing engine
+ * (ADR 0018 §2).
+ *
+ * ## Signed amounts
+ *
+ * Every amount is a base-unit STRING (ADR 0014 D1). Most are never negative;
+ * the ones documented as SIGNED may start with `-`: a proration credit line,
+ * an invoice whose credits exceed its charges, and a customer balance (where
+ * negative is credit the customer holds, Stripe's convention). A signed amount
+ * still has exactly one spelling: no `+`, no `-0`, no leading zeros.
+ */
+/** One tax amount on a line. */
+exports.invoiceTaxAmountSchema = (0, objects_2.defineComponent)('InvoiceTaxAmount', zod_1.z
+    .object({
+    amount: primitives_1.signedAmount.describe('SIGNED: a credit line carries negative tax.'),
+    inclusive: zod_1.z.boolean(),
+    tax_calculation: zod_1.z
+        .string()
+        .nullable()
+        .describe('The Peable Tax calculation (`taxcalc_…`) it came from; `null` for a derived credit.'),
+    taxability_reason: zod_1.z.string().nullable(),
+})
+    .strict());
+/** The amount a discount took off a line, or off the whole invoice. */
+const discountAmountSchema = zod_1.z
+    .object({
+    amount: primitives_1.signedAmount.describe('SIGNED: a discount on a credit line is negative.'),
+    discount: zod_1.z.string().describe('The discount it comes from.'),
+})
+    .strict();
+const periodSchema = zod_1.z.object({ start: primitives_1.unixSeconds, end: primitives_1.unixSeconds }).strict();
+exports.invoiceLineItemSchema = (0, objects_2.defineObject)('line_item', 'InvoiceLineItem', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('line_item'),
+    livemode: primitives_1.livemode,
+    invoice: zod_1.z.string().describe('The invoice (`in_…`) it is on.'),
+    type: zod_1.z.enum(invoices_1.INVOICE_LINE_TYPES),
+    amount: primitives_1.signedAmount.describe('SIGNED: before discounts; tax-inclusive when the price is.'),
+    currency: primitives_1.currency,
+    description: zod_1.z.string().nullable(),
+    discount_amounts: zod_1.z.array(discountAmountSchema),
+    discountable: zod_1.z.boolean(),
+    period: periodSchema,
+    price: (0, objects_1.embedded)('price', 'The Price, embedded; `null` for a fixed-amount item.').nullable(),
+    quantity: zod_1.z.number().int().nullable(),
+    proration: zod_1.z.boolean(),
+    subscription: zod_1.z.string().nullable(),
+    subscription_item: zod_1.z.string().nullable(),
+    invoice_item: zod_1.z.string().nullable(),
+    tax_amounts: zod_1.z.array(exports.invoiceTaxAmountSchema),
+    metadata: primitives_1.metadata,
+})
+    .strict());
+exports.invoiceSchema = (0, objects_2.defineObject)('invoice', 'Invoice', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('invoice'),
+    livemode: primitives_1.livemode,
+    number: zod_1.z
+        .string()
+        .nullable()
+        .describe('`null` while a draft; `PREFIX-0001` once finalized — gapless per merchant.'),
+    customer: (0, objects_2.expandable)('customer', '`cus_…`, or the Customer with `expand[]=customer`.'),
+    customer_email: zod_1.z.string().nullable(),
+    customer_name: zod_1.z.string().nullable(),
+    subscription: (0, objects_2.expandable)('subscription', '`sub_…`, or the Subscription with `expand[]=subscription`.').nullable(),
+    status: zod_1.z.enum(invoices_1.INVOICE_STATUSES),
+    billing_reason: zod_1.z.enum(invoices_1.INVOICE_BILLING_REASONS),
+    collection_method: zod_1.z.enum(subscriptions_1.COLLECTION_METHODS),
+    currency: primitives_1.currency,
+    description: zod_1.z.string().nullable(),
+    auto_advance: zod_1.z.boolean(),
+    automatically_finalizes_at: primitives_1.unixSeconds
+        .nullable()
+        .describe('When a draft with `auto_advance` will finalize.'),
+    lines: (0, envelopes_1.listOf)(exports.invoiceLineItemSchema).describe('Every line, on one page.'),
+    subtotal: primitives_1.signedAmount.describe('SIGNED. Sum of the lines before discounts.'),
+    subtotal_excluding_tax: primitives_1.signedAmount.describe('SIGNED. `subtotal` less the tax included in it (inclusive prices).'),
+    total_discount_amounts: zod_1.z.array(discountAmountSchema),
+    discount: subscriptions_2.discountSchema.nullable(),
+    tax: primitives_1.signedAmount
+        .nullable()
+        .describe('SIGNED; `null` on a draft whose tax is not calculated yet.'),
+    total: primitives_1.signedAmount.describe('SIGNED.'),
+    total_excluding_tax: primitives_1.signedAmount.describe('SIGNED.'),
+    starting_balance: primitives_1.signedAmount.describe("SIGNED: the customer's balance applied when it finalized."),
+    ending_balance: primitives_1.signedAmount
+        .nullable()
+        .describe("SIGNED: what the customer's balance became; `null` until finalized."),
+    amount_due: primitives_1.amount,
+    amount_paid: primitives_1.amount,
+    amount_remaining: primitives_1.amount,
+    pre_payment_credit_notes_amount: primitives_1.amount,
+    post_payment_credit_notes_amount: primitives_1.amount,
+    attempt_count: zod_1.z.number().int().nonnegative(),
+    attempted: zod_1.z.boolean(),
+    next_payment_attempt: primitives_1.unixSeconds.nullable(),
+    due_date: primitives_1.unixSeconds.nullable(),
+    days_until_due: zod_1.z.number().int().nullable(),
+    period_start: primitives_1.unixSeconds,
+    period_end: primitives_1.unixSeconds,
+    payment_intent: (0, objects_2.expandable)('payment_intent', '`pi_…`, or the PaymentIntent with `expand[]=payment_intent`.').nullable(),
+    default_payment_method: (0, objects_2.expandable)('payment_method', '`pm_…`, or the PaymentMethod with `expand[]=default_payment_method`.').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 invoice finalized with.'),
+    })
+        .strict(),
+    hosted_invoice_url: zod_1.z
+        .string()
+        .nullable()
+        .describe('The payer-facing page (anonymous, an unguessable token); `null` while a draft.'),
+    invoice_pdf: zod_1.z.string().nullable().describe('The PDF of the same; `null` while a draft.'),
+    last_finalization_error: zod_1.z
+        .object({ code: zod_1.z.string(), message: zod_1.z.string() })
+        .strict()
+        .nullable(),
+    status_transitions: zod_1.z
+        .object({
+        finalized_at: primitives_1.unixSeconds.nullable(),
+        paid_at: primitives_1.unixSeconds.nullable(),
+        voided_at: primitives_1.unixSeconds.nullable(),
+        marked_uncollectible_at: primitives_1.unixSeconds.nullable(),
+    })
+        .strict(),
+    paid_out_of_band: zod_1.z.boolean(),
+    test_clock: zod_1.z.string().nullable(),
+    metadata: primitives_1.metadata,
+    created: primitives_1.unixSeconds,
+    effective_at: primitives_1.unixSeconds.nullable(),
+})
+    .strict(), {
+    examples: [
+        {
+            id: 'in_0193b8f2c1a87d3e9f4a',
+            object: 'invoice',
+            livemode: false,
+            number: 'ACME-0001',
+            customer: 'cus_0193b8f2c1a87d3e9f4a',
+            customer_email: 'jenny@example.com',
+            customer_name: 'Jenny Rosen',
+            subscription: 'sub_0193b8f2c1a87d3e9f4a',
+            status: 'paid',
+            billing_reason: 'subscription_create',
+            collection_method: 'charge_automatically',
+            currency: 'EUR',
+            description: null,
+            auto_advance: true,
+            automatically_finalizes_at: null,
+            lines: {
+                object: 'list',
+                data: [],
+                has_more: false,
+                url: '/v1/invoices/in_0193b8f2c1a87d3e9f4a/lines',
+            },
+            subtotal: '1999',
+            subtotal_excluding_tax: '1999',
+            total_discount_amounts: [],
+            discount: null,
+            tax: '0',
+            total: '1999',
+            total_excluding_tax: '1999',
+            starting_balance: '0',
+            ending_balance: '0',
+            amount_due: '1999',
+            amount_paid: '1999',
+            amount_remaining: '0',
+            pre_payment_credit_notes_amount: '0',
+            post_payment_credit_notes_amount: '0',
+            attempt_count: 1,
+            attempted: true,
+            next_payment_attempt: null,
+            due_date: null,
+            days_until_due: null,
+            period_start: 1793750400,
+            period_end: 1793750400,
+            payment_intent: 'pi_0193b8f2c1a87d3e9f4a',
+            default_payment_method: null,
+            automatic_tax: { enabled: false, status: null, tax_calculation: null },
+            hosted_invoice_url: 'https://checkout.peable.to/invoice/inv_tok_…',
+            invoice_pdf: 'https://api.peable.to/v1/invoices/public/inv_tok_…/pdf',
+            last_finalization_error: null,
+            status_transitions: {
+                finalized_at: 1793750400,
+                paid_at: 1793750401,
+                voided_at: null,
+                marked_uncollectible_at: null,
+            },
+            paid_out_of_band: false,
+            test_clock: null,
+            metadata: {},
+            created: 1793750400,
+            effective_at: 1793750400,
+        },
+    ],
+});
+/** What `DELETE /v1/invoices/:id` (a draft) answers. */
+exports.deletedInvoiceSchema = (0, objects_2.defineComponent)('DeletedInvoice', (0, envelopes_1.deletedOf)('invoice'));
+// ---- Requests ------------------------------------------------------------------------
+exports.createInvoiceParams = zod_1.z
+    .object({
+    customer: params_1.idParam,
+    currency: params_2.currencyParam
+        .optional()
+        .describe("Default: the subscription's, else the customer's billing currency."),
+    subscription: params_1.idParam.optional(),
+    auto_advance: zod_1.z.boolean().optional(),
+    collection_method: zod_1.z.enum(subscriptions_1.COLLECTION_METHODS).optional(),
+    days_until_due: params_2.daysUntilDueParam.optional(),
+    due_date: params_1.unixSecondsParam.optional().describe('`send_invoice` only.'),
+    description: (0, params_2.shortText)(1500).optional(),
+    default_payment_method: params_1.idParam.optional(),
+    discounts: params_2.discountsParam.optional(),
+    automatic_tax: params_2.automaticTaxParam.optional(),
+    pending_invoice_items_behavior: zod_1.z
+        .enum(invoices_1.PENDING_INVOICE_ITEMS_BEHAVIORS)
+        .optional()
+        .describe("Pull the customer's pending invoice items in. Default `exclude` (Stripe's)."),
+    metadata: params_1.metadataCreateParam.optional(),
+    expand: params_1.expandParam.optional(),
+})
+    .strict();
+/** Drafts only, except `metadata` and `auto_advance`. A field sent as `""` is cleared. */
+exports.updateInvoiceParams = zod_1.z
+    .object({
+    auto_advance: zod_1.z.boolean().optional(),
+    collection_method: zod_1.z.enum(subscriptions_1.COLLECTION_METHODS).optional(),
+    days_until_due: params_2.daysUntilDueParam.optional(),
+    due_date: params_1.unixSecondsParam.optional(),
+    description: zod_1.z.union([(0, params_2.shortText)(1500), zod_1.z.literal('')]).optional(),
+    default_payment_method: zod_1.z.union([params_1.idParam, zod_1.z.literal('')]).optional(),
+    discounts: zod_1.z.union([params_2.discountsParam, zod_1.z.literal('')]).optional(),
+    automatic_tax: params_2.automaticTaxParam.optional(),
+    metadata: params_1.metadataUpdateParam.optional(),
+    expand: params_1.expandParam.optional(),
+})
+    .strict();
+exports.finalizeInvoiceParams = zod_1.z
+    .object({ auto_advance: zod_1.z.boolean().optional(), expand: params_1.expandParam.optional() })
+    .strict();
+exports.payInvoiceParams = zod_1.z
+    .object({
+    payment_method: params_1.idParam
+        .optional()
+        .describe("A saved `pm_…` of the customer; defaults to the invoice's, then the subscription's, then the customer's."),
+    paid_out_of_band: zod_1.z.boolean().optional().describe('Record a payment made outside Orbit.'),
+    off_session: zod_1.z.boolean().optional().describe('Default true: the customer is not present.'),
+    expand: params_1.expandParam.optional(),
+})
+    .strict();
+/** The body of an invoice action that takes nothing but `expand[]` (send, void, mark uncollectible). */
+exports.invoiceActionParams = zod_1.z.object({ expand: params_1.expandParam.optional() }).strict();
+exports.listInvoicesQuery = (0, params_1.listQuery)({
+    customer: params_1.idParam.optional(),
+    subscription: params_1.idParam.optional(),
+    status: zod_1.z.enum(invoices_1.INVOICE_STATUSES).optional(),
+    collection_method: zod_1.z.enum(subscriptions_1.COLLECTION_METHODS).optional(),
+    due_date: params_1.rangeParam.optional(),
+});
+/** `GET /v1/invoices/upcoming` — a preview, never stored. */
+exports.upcomingInvoiceQuery = zod_1.z
+    .object({
+    customer: params_1.idParam,
+    subscription: params_1.idParam
+        .optional()
+        .describe("Default: the customer's most recent subscription that will renew."),
+    subscription_items: zod_1.z
+        .array(zod_1.z
+        .object({
+        id: params_1.idParam.optional(),
+        price: params_1.idParam.optional(),
+        quantity: (0, params_1.queryInteger)({ min: 0 }).optional(),
+        deleted: params_1.queryBoolean.optional(),
+    })
+        .strict())
+        .max(20)
+        .optional()
+        .describe('Preview a change: the items it would have (`subscription_items[0][price]=…`).'),
+    subscription_proration_behavior: zod_1.z.enum(subscriptions_1.PRORATION_BEHAVIORS).optional(),
+    subscription_proration_date: params_1.queryUnixSeconds.optional(),
+    expand: params_1.expandParam.optional(),
+})
+    .strict();
+// ---- Routes --------------------------------------------------------------------------
+const invoiceId = { id: 'The invoice (`in_…`).' };
+exports.invoiceRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'createInvoice',
+        method: 'post',
+        path: '/v1/invoices',
+        tag: 'Invoices',
+        summary: 'Create an invoice',
+        description: 'A draft, for a customer; it finalizes on its own when `auto_advance` is set.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        body: exports.createInvoiceParams,
+        response: exports.invoiceSchema,
+        sdk: 'invoices.create',
+        expandable: 'invoice',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'listInvoices',
+        method: 'get',
+        path: '/v1/invoices',
+        tag: 'Invoices',
+        summary: 'List invoices',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listInvoicesQuery,
+        response: (0, envelopes_1.listOf)(exports.invoiceSchema),
+        sdk: 'invoices.list',
+        expandable: 'invoice',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveUpcomingInvoice',
+        method: 'get',
+        path: '/v1/invoices/upcoming',
+        tag: 'Invoices',
+        summary: 'Preview the upcoming invoice',
+        description: "The invoice a customer's subscription will renew with — or, with `subscription_items`, the one a change would produce. Computed, never stored (its `id` is empty). 404 when the customer has no subscription that will renew.",
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.upcomingInvoiceQuery,
+        response: exports.invoiceSchema,
+        sdk: 'invoices.retrieveUpcoming',
+        expandable: 'invoice',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveInvoice',
+        method: 'get',
+        path: '/v1/invoices/{id}',
+        tag: 'Invoices',
+        summary: 'Retrieve an invoice',
+        auth: 'service',
+        scope: 'payments:read',
+        params: invoiceId,
+        query: params_1.expandOnlyQuery,
+        response: exports.invoiceSchema,
+        sdk: 'invoices.retrieve',
+        expandable: 'invoice',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'updateInvoice',
+        method: 'post',
+        path: '/v1/invoices/{id}',
+        tag: 'Invoices',
+        summary: 'Update an invoice',
+        description: 'Drafts only, except `metadata` and `auto_advance`. A field sent as `""` is cleared; `metadata` is a patch.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: invoiceId,
+        body: exports.updateInvoiceParams,
+        response: exports.invoiceSchema,
+        sdk: 'invoices.update',
+        expandable: 'invoice',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'deleteInvoice',
+        method: 'delete',
+        path: '/v1/invoices/{id}',
+        tag: 'Invoices',
+        summary: 'Delete a draft invoice',
+        description: 'Only a draft can be deleted; a finalized invoice is voided instead.',
+        auth: 'service',
+        scope: 'payments:write',
+        params: invoiceId,
+        response: exports.deletedInvoiceSchema,
+        sdk: 'invoices.del',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'finalizeInvoice',
+        method: 'post',
+        path: '/v1/invoices/{id}/finalize',
+        tag: 'Invoices',
+        summary: 'Finalize a draft invoice',
+        description: 'It gets its number, its tax and its payer-facing page.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: invoiceId,
+        body: exports.finalizeInvoiceParams,
+        response: exports.invoiceSchema,
+        sdk: 'invoices.finalizeInvoice',
+        expandable: 'invoice',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'payInvoice',
+        method: 'post',
+        path: '/v1/invoices/{id}/pay',
+        tag: 'Invoices',
+        summary: 'Pay an invoice',
+        description: 'Charge a saved card off-session, or record a payment made outside Orbit (`paid_out_of_band`). A decline is a `card_error` carrying the invoice as it now is.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: invoiceId,
+        body: exports.payInvoiceParams,
+        response: exports.invoiceSchema,
+        sdk: 'invoices.pay',
+        expandable: 'invoice',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'sendInvoice',
+        method: 'post',
+        path: '/v1/invoices/{id}/send',
+        tag: 'Invoices',
+        summary: 'Send an invoice to its customer',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: invoiceId,
+        body: exports.invoiceActionParams,
+        response: exports.invoiceSchema,
+        sdk: 'invoices.sendInvoice',
+        expandable: 'invoice',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'voidInvoice',
+        method: 'post',
+        path: '/v1/invoices/{id}/void',
+        tag: 'Invoices',
+        summary: 'Void an invoice',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: invoiceId,
+        body: exports.invoiceActionParams,
+        response: exports.invoiceSchema,
+        sdk: 'invoices.voidInvoice',
+        expandable: 'invoice',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'markInvoiceUncollectible',
+        method: 'post',
+        path: '/v1/invoices/{id}/mark_uncollectible',
+        tag: 'Invoices',
+        summary: 'Mark an invoice uncollectible',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: invoiceId,
+        body: exports.invoiceActionParams,
+        response: exports.invoiceSchema,
+        sdk: 'invoices.markUncollectible',
+        expandable: 'invoice',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'listInvoiceLineItems',
+        method: 'get',
+        path: '/v1/invoices/{id}/lines',
+        tag: 'Invoices',
+        summary: "List an invoice's lines",
+        description: 'Every line, on one page.',
+        auth: 'service',
+        scope: 'payments:read',
+        params: invoiceId,
+        response: (0, envelopes_1.listOf)(exports.invoiceLineItemSchema),
+        sdk: 'invoices.listLineItems',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveInvoicePdf',
+        method: 'get',
+        path: '/v1/invoices/{id}/pdf',
+        tag: 'Invoices',
+        summary: "Download an invoice's PDF",
+        auth: 'service',
+        scope: 'payments:read',
+        params: invoiceId,
+        response: { kind: 'binary', contentType: 'application/pdf' },
+        sdk: 'invoices.retrievePdf',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'searchInvoices',
+        method: 'get',
+        path: '/v1/invoices/search',
+        tag: 'Invoices',
+        summary: 'Search invoices',
+        description: "Stripe's query language over the invoice's fields and `metadata['key']`.",
+        auth: 'service',
+        scope: 'payments:read',
+        query: params_1.searchQuery,
+        response: (0, envelopes_1.searchResultOf)(exports.invoiceSchema),
+        sdk: 'invoices.search',
+        expandable: 'invoice',
+    }),
+];