@peable.to/contracts 0.3.0 → 1.0.0

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

@@ -0,0 +1,237 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.billingPortalRoutes = exports.createBillingPortalSessionParams = exports.listBillingPortalConfigurationsQuery = exports.updateBillingPortalConfigurationParams = exports.createBillingPortalConfigurationParams = exports.billingPortalSessionSchema = exports.billingPortalConfigurationSchema = exports.billingPortalBusinessProfileSchema = exports.billingPortalFeaturesSchema = 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 billingPortal_1 = require("../../vocabulary/billingPortal");
+const subscriptions_1 = require("../../vocabulary/subscriptions");
+const params_2 = require("./params");
+/**
+ * The customer portal's merchant side (ADR 0018 §9): configurations (`bpc_…`)
+ * say what the Orbit-hosted portal lets a customer do; a session (`bps_…`) is
+ * a short-lived URL for ONE customer.
+ */
+/** What the hosted portal lets a customer do. */
+exports.billingPortalFeaturesSchema = (0, objects_1.defineComponent)('BillingPortalFeatures', zod_1.z
+    .object({
+    customer_update: zod_1.z
+        .object({
+        enabled: zod_1.z.boolean(),
+        allowed_updates: zod_1.z.array(zod_1.z.enum(billingPortal_1.PORTAL_CUSTOMER_UPDATES)),
+    })
+        .strict(),
+    invoice_history: zod_1.z.object({ enabled: zod_1.z.boolean() }).strict(),
+    payment_method_update: zod_1.z.object({ enabled: zod_1.z.boolean() }).strict(),
+    subscription_cancel: zod_1.z
+        .object({
+        enabled: zod_1.z.boolean(),
+        mode: zod_1.z.enum(billingPortal_1.PORTAL_CANCEL_MODES),
+        proration_behavior: zod_1.z.enum(billingPortal_1.PORTAL_CANCEL_PRORATION_BEHAVIORS),
+    })
+        .strict(),
+    subscription_update: zod_1.z
+        .object({
+        enabled: zod_1.z.boolean(),
+        default_allowed_updates: zod_1.z.array(zod_1.z.enum(billingPortal_1.PORTAL_SUBSCRIPTION_UPDATES)),
+        proration_behavior: zod_1.z.enum(subscriptions_1.PRORATION_BEHAVIORS),
+        products: zod_1.z
+            .array(zod_1.z.object({ product: zod_1.z.string(), prices: zod_1.z.array(zod_1.z.string()) }).strict())
+            .describe('The plans a customer may switch between: per product, its allowed prices.'),
+    })
+        .strict(),
+})
+    .strict());
+/** The business the portal presents. */
+exports.billingPortalBusinessProfileSchema = (0, objects_1.defineComponent)('BillingPortalBusinessProfile', zod_1.z
+    .object({
+    headline: zod_1.z.string().nullable(),
+    privacy_policy_url: zod_1.z.string().nullable(),
+    terms_of_service_url: zod_1.z.string().nullable(),
+})
+    .strict());
+exports.billingPortalConfigurationSchema = (0, objects_1.defineObject)('billing_portal.configuration', 'BillingPortalConfiguration', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('billing_portal.configuration'),
+    livemode: primitives_1.livemode,
+    active: zod_1.z.boolean(),
+    is_default: zod_1.z
+        .boolean()
+        .describe('The configuration a session uses when it names none (created on first use).'),
+    business_profile: exports.billingPortalBusinessProfileSchema,
+    default_return_url: zod_1.z.string().nullable(),
+    features: exports.billingPortalFeaturesSchema,
+    metadata: primitives_1.metadata,
+    created: primitives_1.unixSeconds,
+    updated: primitives_1.unixSeconds,
+})
+    .strict());
+/**
+ * A portal session: a short-lived URL for ONE customer. The URL is a bearer
+ * credential — hand it to that customer only, right away. It is answered once
+ * and never stored.
+ */
+exports.billingPortalSessionSchema = (0, objects_1.defineObject)('billing_portal.session', 'BillingPortalSession', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('billing_portal.session'),
+    livemode: primitives_1.livemode,
+    customer: zod_1.z.string().describe('The customer (`cus_…`) the portal is for.'),
+    configuration: zod_1.z.string().describe('The configuration (`bpc_…`) it applies.'),
+    return_url: zod_1.z.string().nullable(),
+    url: zod_1.z.string().describe('The portal, for this customer only. A bearer credential.'),
+    expires_at: primitives_1.unixSeconds.describe('The URL stops working after this instant.'),
+    created: primitives_1.unixSeconds,
+})
+    .strict());
+// ---- Requests ------------------------------------------------------------------------
+const businessProfileParams = zod_1.z
+    .object({
+    headline: (0, params_2.shortText)(60).optional(),
+    privacy_policy_url: params_2.httpUrlParam.optional(),
+    terms_of_service_url: params_2.httpUrlParam.optional(),
+})
+    .strict();
+/** Each named feature field replaces that field; the others keep their value (or default). */
+const featuresParams = zod_1.z
+    .object({
+    customer_update: zod_1.z
+        .object({
+        enabled: zod_1.z.boolean().optional(),
+        allowed_updates: zod_1.z.array(zod_1.z.enum(billingPortal_1.PORTAL_CUSTOMER_UPDATES)).max(4).optional(),
+    })
+        .strict()
+        .optional(),
+    invoice_history: zod_1.z.object({ enabled: zod_1.z.boolean() }).strict().optional(),
+    payment_method_update: zod_1.z.object({ enabled: zod_1.z.boolean() }).strict().optional(),
+    subscription_cancel: zod_1.z
+        .object({
+        enabled: zod_1.z.boolean().optional(),
+        mode: zod_1.z.enum(billingPortal_1.PORTAL_CANCEL_MODES).optional(),
+        proration_behavior: zod_1.z.enum(billingPortal_1.PORTAL_CANCEL_PRORATION_BEHAVIORS).optional(),
+    })
+        .strict()
+        .optional(),
+    subscription_update: zod_1.z
+        .object({
+        enabled: zod_1.z.boolean().optional(),
+        default_allowed_updates: zod_1.z.array(zod_1.z.enum(billingPortal_1.PORTAL_SUBSCRIPTION_UPDATES)).max(2).optional(),
+        proration_behavior: zod_1.z.enum(subscriptions_1.PRORATION_BEHAVIORS).optional(),
+        products: zod_1.z
+            .array(zod_1.z.object({ product: params_1.idParam, prices: zod_1.z.array(params_1.idParam).min(1).max(10) }).strict())
+            .max(10)
+            .optional(),
+    })
+        .strict()
+        .optional(),
+})
+    .strict();
+exports.createBillingPortalConfigurationParams = zod_1.z
+    .object({
+    business_profile: businessProfileParams.optional(),
+    default_return_url: params_2.httpUrlParam.optional(),
+    features: featuresParams,
+    metadata: params_1.metadataCreateParam.optional(),
+})
+    .strict();
+/** A field sent as `""` is cleared; `metadata` is a patch. */
+exports.updateBillingPortalConfigurationParams = zod_1.z
+    .object({
+    active: zod_1.z.boolean().optional().describe('The default configuration cannot be deactivated.'),
+    business_profile: businessProfileParams.optional(),
+    default_return_url: zod_1.z.union([params_2.httpUrlParam, zod_1.z.literal('')]).optional(),
+    features: featuresParams.optional(),
+    metadata: params_1.metadataUpdateParam.optional(),
+})
+    .strict();
+exports.listBillingPortalConfigurationsQuery = (0, params_1.listQuery)({
+    active: params_1.queryBoolean.optional(),
+    is_default: params_1.queryBoolean.optional(),
+});
+exports.createBillingPortalSessionParams = zod_1.z
+    .object({
+    customer: params_1.idParam,
+    configuration: params_1.idParam
+        .optional()
+        .describe("Default: the merchant's default configuration (created on first use)."),
+    return_url: params_2.httpUrlParam.optional(),
+})
+    .strict();
+// ---- Routes --------------------------------------------------------------------------
+const configurationId = { id: 'The portal configuration (`bpc_…`).' };
+exports.billingPortalRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'createBillingPortalConfiguration',
+        method: 'post',
+        path: '/v1/billing_portal/configurations',
+        tag: 'Customer portal',
+        summary: 'Create a portal configuration',
+        description: "Features not named take the safe defaults. The merchant's first configuration becomes the default.",
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        body: exports.createBillingPortalConfigurationParams,
+        response: exports.billingPortalConfigurationSchema,
+        sdk: 'billingPortal.configurations.create',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'listBillingPortalConfigurations',
+        method: 'get',
+        path: '/v1/billing_portal/configurations',
+        tag: 'Customer portal',
+        summary: 'List portal configurations',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listBillingPortalConfigurationsQuery,
+        response: (0, envelopes_1.listOf)(exports.billingPortalConfigurationSchema),
+        sdk: 'billingPortal.configurations.list',
+        expandable: 'billing_portal.configuration',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveBillingPortalConfiguration',
+        method: 'get',
+        path: '/v1/billing_portal/configurations/{id}',
+        tag: 'Customer portal',
+        summary: 'Retrieve a portal configuration',
+        auth: 'service',
+        scope: 'payments:read',
+        params: configurationId,
+        query: params_1.expandOnlyQuery,
+        response: exports.billingPortalConfigurationSchema,
+        sdk: 'billingPortal.configurations.retrieve',
+        expandable: 'billing_portal.configuration',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'updateBillingPortalConfiguration',
+        method: 'post',
+        path: '/v1/billing_portal/configurations/{id}',
+        tag: 'Customer portal',
+        summary: 'Update a portal configuration',
+        description: 'Each named feature field replaces that field; the others are kept.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: configurationId,
+        body: exports.updateBillingPortalConfigurationParams,
+        response: exports.billingPortalConfigurationSchema,
+        sdk: 'billingPortal.configurations.update',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'createBillingPortalSession',
+        method: 'post',
+        path: '/v1/billing_portal/sessions',
+        tag: 'Customer portal',
+        summary: 'Create a portal session',
+        description: 'A one-hour URL of the Orbit-hosted portal for one customer. The URL is a bearer credential: hand it to that customer only, right away.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        body: exports.createBillingPortalSessionParams,
+        response: exports.billingPortalSessionSchema,
+        sdk: 'billingPortal.sessions.create',
+    }),
+];

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

@@ -0,0 +1,189 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.creditNoteRoutes = exports.listCreditNotesQuery = exports.voidCreditNoteParams = exports.previewCreditNoteQuery = exports.createCreditNoteParams = exports.creditNoteSchema = exports.creditNoteLineItemSchema = 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 invoices_2 = require("./invoices");
+const params_2 = require("./params");
+/**
+ * Credit notes (`cn_…`, ADR 0018 §4): a finalized invoice credited — on an
+ * `open` one it reduces what is due; on a `paid` one it is given back
+ * (refunded through the invoice's payment, credited to the customer balance,
+ * or recorded as returned outside Orbit).
+ */
+exports.creditNoteLineItemSchema = (0, objects_1.defineComponent)('CreditNoteLineItem', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('credit_note_line_item'),
+    type: zod_1.z.enum(invoices_1.CREDIT_NOTE_LINE_TYPES),
+    invoice_line_item: zod_1.z.string().nullable().describe('The invoice line (`il_…`) it credits.'),
+    description: zod_1.z.string().nullable(),
+    quantity: zod_1.z.number().int().nullable(),
+    amount: primitives_1.amount.describe('Before tax; tax-inclusive when the invoice line is.'),
+    tax_amount: primitives_1.amount,
+})
+    .strict());
+exports.creditNoteSchema = (0, objects_1.defineObject)('credit_note', 'CreditNote', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('credit_note'),
+    livemode: primitives_1.livemode,
+    number: zod_1.z.string().describe('`<invoice number>-CN-<nn>`.'),
+    invoice: (0, objects_1.expandable)('invoice', '`in_…`, or the Invoice with `expand[]=invoice`.'),
+    customer: (0, objects_1.expandable)('customer', '`cus_…`, or the Customer with `expand[]=customer`.'),
+    status: zod_1.z.enum(invoices_1.CREDIT_NOTE_STATUSES),
+    type: zod_1.z.enum(invoices_1.CREDIT_NOTE_TYPES),
+    reason: zod_1.z.enum(invoices_1.CREDIT_NOTE_REASONS).nullable(),
+    currency: primitives_1.currency,
+    lines: (0, envelopes_1.listOf)(exports.creditNoteLineItemSchema),
+    subtotal: primitives_1.amount,
+    tax: primitives_1.amount,
+    total: primitives_1.amount.describe('What is credited, tax included.'),
+    refund_amount: primitives_1.amount.describe("Of `total`: refunded through the invoice's payment."),
+    credit_amount: primitives_1.amount.describe('Of `total`: credited to the customer balance.'),
+    out_of_band_amount: primitives_1.amount.describe('Of `total`: recorded as returned outside Orbit.'),
+    refund: zod_1.z.string().nullable().describe('The Refund (`re_…`) when part of it was refunded.'),
+    customer_balance_transaction: zod_1.z
+        .string()
+        .nullable()
+        .describe('The customer balance transaction (`cbtxn_…`) of `credit_amount`.'),
+    memo: zod_1.z.string().nullable(),
+    metadata: primitives_1.metadata,
+    voided_at: primitives_1.unixSeconds.nullable(),
+    created: primitives_1.unixSeconds,
+})
+    .strict());
+const creditNoteFields = {
+    invoice: params_1.idParam,
+    amount: params_2.amountParam
+        .optional()
+        .describe('Credit this much of the invoice, tax included, spread over its lines.'),
+    reason: zod_1.z.enum(invoices_1.CREDIT_NOTE_REASONS).optional(),
+    memo: (0, params_2.shortText)(5000).optional(),
+    refund_amount: params_2.amountParam.optional(),
+    credit_amount: params_2.amountParam.optional(),
+    out_of_band_amount: params_2.amountParam.optional(),
+};
+const creditNoteLineFields = {
+    type: zod_1.z.enum(invoices_1.CREDIT_NOTE_LINE_TYPES),
+    invoice_line_item: params_1.idParam.optional(),
+    amount: params_2.amountParam
+        .optional()
+        .describe('For an invoice line: the amount of it to credit (default all of it).'),
+    description: (0, params_2.shortText)(500).optional(),
+};
+/**
+ * Credit `lines`, or a whole `amount` (custom).
+ *
+ * On a `paid` invoice the credit must be distributed: `refund_amount` (through
+ * the invoice's payment; card only), `credit_amount` (to the customer balance)
+ * and `out_of_band_amount` must add up to the total. Omitted, all of it is
+ * refunded on a card invoice and credited to the balance otherwise. On an
+ * `open` invoice it reduces `amount_due` and none of the three apply.
+ */
+exports.createCreditNoteParams = zod_1.z
+    .object({
+    ...creditNoteFields,
+    lines: zod_1.z
+        .array(zod_1.z.object({ ...creditNoteLineFields, quantity: params_2.quantityParam.optional() }).strict())
+        .min(1)
+        .max(100)
+        .optional(),
+    metadata: params_1.metadataCreateParam.optional(),
+    expand: params_1.expandParam.optional(),
+})
+    .strict();
+/** The create's fields as a query (`lines[0][type]=…`). */
+exports.previewCreditNoteQuery = zod_1.z
+    .object({
+    ...creditNoteFields,
+    lines: zod_1.z
+        .array(zod_1.z
+        .object({ ...creditNoteLineFields, quantity: (0, params_1.queryInteger)({ min: 0 }).optional() })
+        .strict())
+        .max(100)
+        .optional(),
+})
+    .strict();
+exports.voidCreditNoteParams = invoices_2.invoiceActionParams;
+exports.listCreditNotesQuery = (0, params_1.listQuery)({
+    invoice: params_1.idParam.optional(),
+    customer: params_1.idParam.optional(),
+});
+const creditNoteId = { id: 'The credit note (`cn_…`).' };
+exports.creditNoteRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'createCreditNote',
+        method: 'post',
+        path: '/v1/credit_notes',
+        tag: 'Credit notes',
+        summary: 'Issue a credit note',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        body: exports.createCreditNoteParams,
+        response: exports.creditNoteSchema,
+        sdk: 'creditNotes.create',
+        expandable: 'credit_note',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'listCreditNotes',
+        method: 'get',
+        path: '/v1/credit_notes',
+        tag: 'Credit notes',
+        summary: 'List credit notes',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listCreditNotesQuery,
+        response: (0, envelopes_1.listOf)(exports.creditNoteSchema),
+        sdk: 'creditNotes.list',
+        expandable: 'credit_note',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'previewCreditNote',
+        method: 'get',
+        path: '/v1/credit_notes/preview',
+        tag: 'Credit notes',
+        summary: 'Preview a credit note',
+        description: 'The note `POST /v1/credit_notes` would issue with the same fields, computed and never stored (its `id` and `number` are empty).',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.previewCreditNoteQuery,
+        response: exports.creditNoteSchema,
+        sdk: 'creditNotes.preview',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveCreditNote',
+        method: 'get',
+        path: '/v1/credit_notes/{id}',
+        tag: 'Credit notes',
+        summary: 'Retrieve a credit note',
+        auth: 'service',
+        scope: 'payments:read',
+        params: creditNoteId,
+        query: params_1.expandOnlyQuery,
+        response: exports.creditNoteSchema,
+        sdk: 'creditNotes.retrieve',
+        expandable: 'credit_note',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'voidCreditNote',
+        method: 'post',
+        path: '/v1/credit_notes/{id}/void',
+        tag: 'Credit notes',
+        summary: 'Void a credit note',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: creditNoteId,
+        body: exports.voidCreditNoteParams,
+        response: exports.creditNoteSchema,
+        sdk: 'creditNotes.voidCreditNote',
+        expandable: 'credit_note',
+    }),
+];

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

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customerBalanceTransactionRoutes = exports.listCustomerBalanceTransactionsQuery = exports.createCustomerBalanceTransactionParams = exports.customerBalanceTransactionSchema = 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 params_2 = require("./params");
+/**
+ * The customer balance ledger (`cbtxn_…`, ADR 0018 §3): every movement of a
+ * customer's balance. Negative is credit the customer holds (Stripe's
+ * convention), applied to their next invoice when it finalizes.
+ */
+exports.customerBalanceTransactionSchema = (0, objects_1.defineObject)('customer_balance_transaction', 'CustomerBalanceTransaction', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('customer_balance_transaction'),
+    livemode: primitives_1.livemode,
+    customer: (0, objects_1.expandable)('customer', '`cus_…`, or the Customer with `expand[]=customer`.'),
+    type: zod_1.z.enum(invoices_1.CUSTOMER_BALANCE_TRANSACTION_TYPES),
+    amount: primitives_1.signedAmount.describe('SIGNED: negative credits the customer, positive debits.'),
+    currency: primitives_1.currency,
+    ending_balance: primitives_1.signedAmount.describe('SIGNED: the balance after this transaction.'),
+    description: zod_1.z.string().nullable(),
+    invoice: (0, objects_1.expandable)('invoice', 'The invoice it moved with (`in_…`, or the Invoice with `expand[]=invoice`).').nullable(),
+    credit_note: zod_1.z.string().nullable().describe('The credit note (`cn_…`) it came from.'),
+    metadata: primitives_1.metadata,
+    created: primitives_1.unixSeconds,
+})
+    .strict());
+/** An adjustment: a negative `amount` credits the customer, a positive one adds to what they owe. */
+exports.createCustomerBalanceTransactionParams = zod_1.z
+    .object({
+    amount: params_2.signedAmountParam.describe('SIGNED: negative credits the customer, positive debits.'),
+    currency: params_2.currencyParam,
+    description: (0, params_2.shortText)(350).optional(),
+    metadata: params_1.metadataCreateParam.optional(),
+    expand: params_1.expandParam.optional(),
+})
+    .strict();
+exports.listCustomerBalanceTransactionsQuery = (0, params_1.listQuery)({});
+const customerId = 'The customer (`cus_…`).';
+exports.customerBalanceTransactionRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'createCustomerBalanceTransaction',
+        method: 'post',
+        path: '/v1/customers/{id}/balance_transactions',
+        tag: 'Customer balance',
+        summary: "Adjust a customer's balance",
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: { id: customerId },
+        body: exports.createCustomerBalanceTransactionParams,
+        response: exports.customerBalanceTransactionSchema,
+        sdk: 'customerBalanceTransactions.create',
+        expandable: 'customer_balance_transaction',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'listCustomerBalanceTransactions',
+        method: 'get',
+        path: '/v1/customers/{id}/balance_transactions',
+        tag: 'Customer balance',
+        summary: "List a customer's balance transactions",
+        auth: 'service',
+        scope: 'payments:read',
+        params: { id: customerId },
+        query: exports.listCustomerBalanceTransactionsQuery,
+        response: (0, envelopes_1.listOf)(exports.customerBalanceTransactionSchema),
+        sdk: 'customerBalanceTransactions.list',
+        expandable: 'customer_balance_transaction',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveCustomerBalanceTransaction',
+        method: 'get',
+        path: '/v1/customers/{id}/balance_transactions/{transaction}',
+        tag: 'Customer balance',
+        summary: 'Retrieve a customer balance transaction',
+        auth: 'service',
+        scope: 'payments:read',
+        params: { id: customerId, transaction: 'The balance transaction (`cbtxn_…`).' },
+        query: params_1.expandOnlyQuery,
+        response: exports.customerBalanceTransactionSchema,
+        sdk: 'customerBalanceTransactions.retrieve',
+        expandable: 'customer_balance_transaction',
+    }),
+];

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

@@ -0,0 +1,43 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.billingEngineRoutes = void 0;
+// Contracts of this group: one module per resource, re-exported here, and
+// their routes concatenated into `billingEngineRoutes`.
+const billingPortal_1 = require("./billingPortal");
+const creditNotes_1 = require("./creditNotes");
+const customerBalanceTransactions_1 = require("./customerBalanceTransactions");
+const invoiceItems_1 = require("./invoiceItems");
+const invoices_1 = require("./invoices");
+const public_1 = require("./public");
+const subscriptions_1 = require("./subscriptions");
+__exportStar(require("./billingPortal"), exports);
+__exportStar(require("./creditNotes"), exports);
+__exportStar(require("./customerBalanceTransactions"), exports);
+__exportStar(require("./invoiceItems"), exports);
+__exportStar(require("./invoices"), exports);
+__exportStar(require("./public"), exports);
+__exportStar(require("./subscriptions"), exports);
+/** Orbit's native billing engine (ADR 0018): subscriptions, invoices, credit notes, the balance ledger and the customer portal. */
+exports.billingEngineRoutes = [
+    ...subscriptions_1.subscriptionRoutes,
+    ...invoices_1.invoiceRoutes,
+    ...invoiceItems_1.invoiceItemRoutes,
+    ...creditNotes_1.creditNoteRoutes,
+    ...customerBalanceTransactions_1.customerBalanceTransactionRoutes,
+    ...billingPortal_1.billingPortalRoutes,
+    ...public_1.publicBillingRoutes,
+];