founder-schema 0.10.0 → 0.12.0

package/dist/domains/billing/billing.d.ts

@@ -0,0 +1,1179 @@
+/**
+ * founder-schema: buying, paying, invoices, refunds and coupons (0.12.0)
+ *
+ *   POST /api/v1/billing/quote               quoteBodySchema -> quoteSchema
+ *   POST /api/v1/billing/orders              createOrderBodySchema -> createOrderResponseSchema
+ *   GET  /api/v1/billing/orders/:orderId     orderStateSchema (polled while "processing")
+ *   POST /api/v1/billing/orders/:orderId/confirm  confirmOrderBodySchema -> orderStateSchema
+ *   GET  /api/v1/billing/payments            paymentPageSchema (mine)
+ *   GET  /api/v1/billing/payments/:orderId   paymentDetailSchema (mine, with the invoice)
+ *
+ *   Staff (by the ability: support reads; managers refund and run coupons):
+ *   GET  /api/v1/staff/payments              staffPaymentsQuerySchema -> staffPaymentPageSchema
+ *   GET  /api/v1/staff/payments/:orderId     staffPaymentDetailSchema
+ *   POST /api/v1/staff/payments/:orderId/refund   refundPaymentBodySchema -> staffPaymentDetailSchema
+ *   GET  /api/v1/staff/coupons               couponListSchema
+ *   POST /api/v1/staff/coupons               createCouponBodySchema -> couponSchema
+ *   PATCH /api/v1/staff/coupons/:couponId    updateCouponBodySchema -> couponSchema
+ *   PUT  /api/v1/members/:memberId/membership    setMembershipBodySchema -> memberDetailSchema
+ *
+ * THE ONE RULE: THE SERVER PRICES, THE CLIENT CHOOSES. A request names what it
+ * wants (an item) and maybe a coupon CODE; it never names an amount. Every
+ * amount here is the server's, in integer paise, GST included.
+ *
+ * TWO PATHS IN, ONE GRANT. A payment reaches the server from the browser the
+ * moment checkout returns (`confirm`) and from the gateway's webhook. Either
+ * grants; the second is a no-op. So a member who closes the tab is still
+ * granted, and `confirm` failing never means "not paid": the web says
+ * "processing" and polls the order.
+ *
+ * GST: the company is registered, every captured payment gets a tax invoice,
+ * every refund a credit note. Where the buyer is decides the tax: in the
+ * supplier's state CGST + SGST, elsewhere IGST. So checkout asks for the state.
+ *
+ * @module founder-schema/domains/billing
+ */
+import { z } from 'zod';
+export { type BillingDetails, billingDetailsSchema, GST_RATE_PERCENT, GST_STATE_CODE_VALUES, GST_STATES, type GstStateCode, gstinChecksumValid, gstinSchema, gstStateCodeSchema, gstStateName, } from './gst.js';
+/** ⚠ Stored on every order: append only. */
+export declare const PURCHASE_KIND_VALUES: readonly ["membership", "plan", "upgrade"];
+export declare const purchaseKindSchema: z.ZodEnum<{
+    membership: "membership";
+    plan: "plan";
+    upgrade: "upgrade";
+}>;
+export type PurchaseKind = z.infer<typeof purchaseKindSchema>;
+/**
+ * The thing asked for.
+ *
+ *   membership  Rs 99, once
+ *   plan        a month or a year of Premium or Business, appended
+ *   upgrade     the Premium time left, turned into Business, for the difference
+ */
+export declare const purchaseItemSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"membership">;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"plan">;
+    tier: z.ZodEnum<{
+        premium: "premium";
+        business: "business";
+    }>;
+    period: z.ZodEnum<{
+        month: "month";
+        year: "year";
+    }>;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"upgrade">;
+}, z.core.$strip>], "kind">;
+export type PurchaseItem = z.infer<typeof purchaseItemSchema>;
+/** A coupon code as typed: letters, digits, hyphens; compared upper-case. */
+export declare const couponCodeSchema: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+/**
+ * The tax inside a total. `taxable + cgst + sgst + igst = total`; either
+ * CGST + SGST (buyer in the supplier's state) or IGST, never both.
+ */
+export declare const taxSplitSchema: z.ZodObject<{
+    ratePercent: z.ZodNumber;
+    taxable: z.ZodNumber;
+    cgst: z.ZodNumber;
+    sgst: z.ZodNumber;
+    igst: z.ZodNumber;
+    total: z.ZodNumber;
+}, z.core.$strip>;
+export type TaxSplit = z.infer<typeof taxSplitSchema>;
+/** `POST /billing/quote`. The state is optional: without it, no tax split. */
+export declare const quoteBodySchema: z.ZodObject<{
+    item: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"membership">;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"plan">;
+        tier: z.ZodEnum<{
+            premium: "premium";
+            business: "business";
+        }>;
+        period: z.ZodEnum<{
+            month: "month";
+            year: "year";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"upgrade">;
+    }, z.core.$strip>], "kind">;
+    couponCode: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>;
+    stateCode: z.ZodOptional<z.ZodEnum<{
+        "01": "01";
+        "02": "02";
+        "03": "03";
+        "04": "04";
+        "05": "05";
+        "06": "06";
+        "07": "07";
+        "08": "08";
+        "09": "09";
+        10: "10";
+        11: "11";
+        12: "12";
+        13: "13";
+        14: "14";
+        15: "15";
+        16: "16";
+        17: "17";
+        18: "18";
+        19: "19";
+        20: "20";
+        21: "21";
+        22: "22";
+        23: "23";
+        24: "24";
+        26: "26";
+        27: "27";
+        29: "29";
+        30: "30";
+        31: "31";
+        32: "32";
+        33: "33";
+        34: "34";
+        35: "35";
+        36: "36";
+        37: "37";
+        38: "38";
+    }>>;
+}, z.core.$strip>;
+export type QuoteBody = z.infer<typeof quoteBodySchema>;
+/** What a plan or an upgrade would do to the plan, priced now. */
+export declare const planEffectSchema: z.ZodObject<{
+    tier: z.ZodEnum<{
+        premium: "premium";
+        business: "business";
+    }>;
+    startsAt: z.ZodISODateTime;
+    endsAt: z.ZodISODateTime;
+    upgradedDays: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+export type PlanEffect = z.infer<typeof planEffectSchema>;
+export declare const quoteSchema: z.ZodObject<{
+    item: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"membership">;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"plan">;
+        tier: z.ZodEnum<{
+            premium: "premium";
+            business: "business";
+        }>;
+        period: z.ZodEnum<{
+            month: "month";
+            year: "year";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"upgrade">;
+    }, z.core.$strip>], "kind">;
+    title: z.ZodString;
+    listPrice: z.ZodNumber;
+    discount: z.ZodNumber;
+    total: z.ZodNumber;
+    coupon: z.ZodNullable<z.ZodObject<{
+        code: z.ZodString;
+        label: z.ZodString;
+    }, z.core.$strip>>;
+    plan: z.ZodNullable<z.ZodObject<{
+        tier: z.ZodEnum<{
+            premium: "premium";
+            business: "business";
+        }>;
+        startsAt: z.ZodISODateTime;
+        endsAt: z.ZodISODateTime;
+        upgradedDays: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+    tax: z.ZodNullable<z.ZodObject<{
+        ratePercent: z.ZodNumber;
+        taxable: z.ZodNumber;
+        cgst: z.ZodNumber;
+        sgst: z.ZodNumber;
+        igst: z.ZodNumber;
+        total: z.ZodNumber;
+    }, z.core.$strip>>;
+    refundWindowDays: z.ZodNumber;
+}, z.core.$strip>;
+export type Quote = z.infer<typeof quoteSchema>;
+/**
+ * Where an order stands. ⚠ Stored: append only.
+ *
+ *   created         checkout open, nothing paid yet
+ *   paid            captured and granted; has an invoice
+ *   granted_free    a free coupon: granted with no payment and no invoice
+ *   expired         not paid within `ORDER_TTL_MINUTES`
+ *   refund_pending  staff refunded it; the gateway is returning the money
+ *   refunded        the money is back; has a credit note
+ *   refund_failed   the gateway could not return it; staff act from its dashboard
+ */
+export declare const ORDER_STATUS_VALUES: readonly ["created", "paid", "granted_free", "expired", "refund_pending", "refunded", "refund_failed"];
+export declare const orderStatusSchema: z.ZodEnum<{
+    paid: "paid";
+    created: "created";
+    granted_free: "granted_free";
+    expired: "expired";
+    refund_pending: "refund_pending";
+    refunded: "refunded";
+    refund_failed: "refund_failed";
+}>;
+export type OrderStatus = z.infer<typeof orderStatusSchema>;
+/**
+ * `POST /billing/orders`. Billing details are required for anything paid (the
+ * invoice needs a place of supply): the server refuses a paid order without
+ * them (`billing.stateCode`, VALIDATION_ERROR). A free coupon issues no
+ * invoice, so it needs none (0.12.0).
+ */
+export declare const createOrderBodySchema: z.ZodObject<{
+    item: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"membership">;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"plan">;
+        tier: z.ZodEnum<{
+            premium: "premium";
+            business: "business";
+        }>;
+        period: z.ZodEnum<{
+            month: "month";
+            year: "year";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"upgrade">;
+    }, z.core.$strip>], "kind">;
+    couponCode: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>;
+    billing: z.ZodOptional<z.ZodObject<{
+        stateCode: z.ZodEnum<{
+            "01": "01";
+            "02": "02";
+            "03": "03";
+            "04": "04";
+            "05": "05";
+            "06": "06";
+            "07": "07";
+            "08": "08";
+            "09": "09";
+            10: "10";
+            11: "11";
+            12: "12";
+            13: "13";
+            14: "14";
+            15: "15";
+            16: "16";
+            17: "17";
+            18: "18";
+            19: "19";
+            20: "20";
+            21: "21";
+            22: "22";
+            23: "23";
+            24: "24";
+            26: "26";
+            27: "27";
+            29: "29";
+            30: "30";
+            31: "31";
+            32: "32";
+            33: "33";
+            34: "34";
+            35: "35";
+            36: "36";
+            37: "37";
+            38: "38";
+        }>;
+        gstin: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>;
+        legalName: z.ZodOptional<z.ZodString>;
+        address: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type CreateOrderBody = z.infer<typeof createOrderBodySchema>;
+/**
+ * Either done (a free coupon granted at once) or a checkout to open. The
+ * checkout fields are Razorpay Checkout's own options; identity (name, email,
+ * phone) is the server's, never typed by the caller.
+ */
+export declare const createOrderResponseSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    status: z.ZodLiteral<"granted">;
+    orderId: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+}, z.core.$strip>, z.ZodObject<{
+    status: z.ZodLiteral<"checkout">;
+    orderId: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    expiresAt: z.ZodISODateTime;
+    checkout: z.ZodObject<{
+        keyId: z.ZodString;
+        razorpayOrderId: z.ZodString;
+        amount: z.ZodNumber;
+        currency: z.ZodLiteral<"INR">;
+        name: z.ZodString;
+        description: z.ZodString;
+        prefill: z.ZodObject<{
+            name: z.ZodString;
+            email: z.ZodString;
+            contact: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>], "status">;
+export type CreateOrderResponse = z.infer<typeof createOrderResponseSchema>;
+export declare const orderParamsSchema: z.ZodObject<{
+    orderId: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+}, z.core.$strip>;
+export type OrderParams = z.infer<typeof orderParamsSchema>;
+/** What Razorpay Checkout's `handler` hands back, as it names it. */
+export declare const confirmOrderBodySchema: z.ZodObject<{
+    razorpayOrderId: z.ZodString;
+    razorpayPaymentId: z.ZodString;
+    razorpaySignature: z.ZodString;
+}, z.core.$strip>;
+export type ConfirmOrderBody = z.infer<typeof confirmOrderBodySchema>;
+/** An order as its buyer polls it. */
+export declare const orderStateSchema: z.ZodObject<{
+    orderId: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    item: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"membership">;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"plan">;
+        tier: z.ZodEnum<{
+            premium: "premium";
+            business: "business";
+        }>;
+        period: z.ZodEnum<{
+            month: "month";
+            year: "year";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"upgrade">;
+    }, z.core.$strip>], "kind">;
+    status: z.ZodEnum<{
+        paid: "paid";
+        created: "created";
+        granted_free: "granted_free";
+        expired: "expired";
+        refund_pending: "refund_pending";
+        refunded: "refunded";
+        refund_failed: "refund_failed";
+    }>;
+    notApplied: z.ZodBoolean;
+}, z.core.$strip>;
+export type OrderState = z.infer<typeof orderStateSchema>;
+/** A party on an invoice. The supplier always has a GSTIN on a real invoice; a buyer, only on B2B. */
+export declare const invoicePartySchema: z.ZodObject<{
+    name: z.ZodString;
+    address: z.ZodNullable<z.ZodString>;
+    gstin: z.ZodNullable<z.ZodString>;
+    stateCode: z.ZodEnum<{
+        "01": "01";
+        "02": "02";
+        "03": "03";
+        "04": "04";
+        "05": "05";
+        "06": "06";
+        "07": "07";
+        "08": "08";
+        "09": "09";
+        10: "10";
+        11: "11";
+        12: "12";
+        13: "13";
+        14: "14";
+        15: "15";
+        16: "16";
+        17: "17";
+        18: "18";
+        19: "19";
+        20: "20";
+        21: "21";
+        22: "22";
+        23: "23";
+        24: "24";
+        26: "26";
+        27: "27";
+        29: "29";
+        30: "30";
+        31: "31";
+        32: "32";
+        33: "33";
+        34: "34";
+        35: "35";
+        36: "36";
+        37: "37";
+        38: "38";
+    }>;
+    stateName: z.ZodString;
+}, z.core.$strip>;
+export type InvoiceParty = z.infer<typeof invoicePartySchema>;
+/** A tax invoice, frozen when the payment was captured. */
+export declare const invoiceSchema: z.ZodObject<{
+    number: z.ZodString;
+    issuedAt: z.ZodISODateTime;
+    test: z.ZodBoolean;
+    supplier: z.ZodObject<{
+        name: z.ZodString;
+        address: z.ZodNullable<z.ZodString>;
+        gstin: z.ZodNullable<z.ZodString>;
+        stateCode: z.ZodEnum<{
+            "01": "01";
+            "02": "02";
+            "03": "03";
+            "04": "04";
+            "05": "05";
+            "06": "06";
+            "07": "07";
+            "08": "08";
+            "09": "09";
+            10: "10";
+            11: "11";
+            12: "12";
+            13: "13";
+            14: "14";
+            15: "15";
+            16: "16";
+            17: "17";
+            18: "18";
+            19: "19";
+            20: "20";
+            21: "21";
+            22: "22";
+            23: "23";
+            24: "24";
+            26: "26";
+            27: "27";
+            29: "29";
+            30: "30";
+            31: "31";
+            32: "32";
+            33: "33";
+            34: "34";
+            35: "35";
+            36: "36";
+            37: "37";
+            38: "38";
+        }>;
+        stateName: z.ZodString;
+    }, z.core.$strip>;
+    buyer: z.ZodObject<{
+        name: z.ZodString;
+        address: z.ZodNullable<z.ZodString>;
+        gstin: z.ZodNullable<z.ZodString>;
+        stateCode: z.ZodEnum<{
+            "01": "01";
+            "02": "02";
+            "03": "03";
+            "04": "04";
+            "05": "05";
+            "06": "06";
+            "07": "07";
+            "08": "08";
+            "09": "09";
+            10: "10";
+            11: "11";
+            12: "12";
+            13: "13";
+            14: "14";
+            15: "15";
+            16: "16";
+            17: "17";
+            18: "18";
+            19: "19";
+            20: "20";
+            21: "21";
+            22: "22";
+            23: "23";
+            24: "24";
+            26: "26";
+            27: "27";
+            29: "29";
+            30: "30";
+            31: "31";
+            32: "32";
+            33: "33";
+            34: "34";
+            35: "35";
+            36: "36";
+            37: "37";
+            38: "38";
+        }>;
+        stateName: z.ZodString;
+    }, z.core.$strip>;
+    kind: z.ZodEnum<{
+        b2b: "b2b";
+        b2c: "b2c";
+    }>;
+    sac: z.ZodString;
+    description: z.ZodString;
+    tax: z.ZodObject<{
+        ratePercent: z.ZodNumber;
+        taxable: z.ZodNumber;
+        cgst: z.ZodNumber;
+        sgst: z.ZodNumber;
+        igst: z.ZodNumber;
+        total: z.ZodNumber;
+    }, z.core.$strip>;
+    reverseCharge: z.ZodLiteral<false>;
+    razorpayPaymentId: z.ZodString;
+}, z.core.$strip>;
+export type Invoice = z.infer<typeof invoiceSchema>;
+/** A refund's credit note, against its invoice. */
+export declare const creditNoteSchema: z.ZodObject<{
+    number: z.ZodString;
+    issuedAt: z.ZodISODateTime;
+    invoiceNumber: z.ZodString;
+    tax: z.ZodObject<{
+        ratePercent: z.ZodNumber;
+        taxable: z.ZodNumber;
+        cgst: z.ZodNumber;
+        sgst: z.ZodNumber;
+        igst: z.ZodNumber;
+        total: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type CreditNote = z.infer<typeof creditNoteSchema>;
+/** One purchase in a member's history. Only settled orders are listed, never an abandoned checkout. */
+export declare const paymentSummarySchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    item: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"membership">;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"plan">;
+        tier: z.ZodEnum<{
+            premium: "premium";
+            business: "business";
+        }>;
+        period: z.ZodEnum<{
+            month: "month";
+            year: "year";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"upgrade">;
+    }, z.core.$strip>], "kind">;
+    title: z.ZodString;
+    total: z.ZodNumber;
+    status: z.ZodEnum<{
+        paid: "paid";
+        created: "created";
+        granted_free: "granted_free";
+        expired: "expired";
+        refund_pending: "refund_pending";
+        refunded: "refunded";
+        refund_failed: "refund_failed";
+    }>;
+    paidAt: z.ZodISODateTime;
+    invoiceNumber: z.ZodNullable<z.ZodString>;
+    refundableUntil: z.ZodNullable<z.ZodISODateTime>;
+}, z.core.$strip>;
+export type PaymentSummary = z.infer<typeof paymentSummarySchema>;
+export declare const paymentPageSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+        item: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            kind: z.ZodLiteral<"membership">;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"plan">;
+            tier: z.ZodEnum<{
+                premium: "premium";
+                business: "business";
+            }>;
+            period: z.ZodEnum<{
+                month: "month";
+                year: "year";
+            }>;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"upgrade">;
+        }, z.core.$strip>], "kind">;
+        title: z.ZodString;
+        total: z.ZodNumber;
+        status: z.ZodEnum<{
+            paid: "paid";
+            created: "created";
+            granted_free: "granted_free";
+            expired: "expired";
+            refund_pending: "refund_pending";
+            refunded: "refunded";
+            refund_failed: "refund_failed";
+        }>;
+        paidAt: z.ZodISODateTime;
+        invoiceNumber: z.ZodNullable<z.ZodString>;
+        refundableUntil: z.ZodNullable<z.ZodISODateTime>;
+    }, z.core.$strip>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type PaymentPage = z.infer<typeof paymentPageSchema>;
+export declare const paymentDetailSchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    item: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"membership">;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"plan">;
+        tier: z.ZodEnum<{
+            premium: "premium";
+            business: "business";
+        }>;
+        period: z.ZodEnum<{
+            month: "month";
+            year: "year";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"upgrade">;
+    }, z.core.$strip>], "kind">;
+    title: z.ZodString;
+    total: z.ZodNumber;
+    status: z.ZodEnum<{
+        paid: "paid";
+        created: "created";
+        granted_free: "granted_free";
+        expired: "expired";
+        refund_pending: "refund_pending";
+        refunded: "refunded";
+        refund_failed: "refund_failed";
+    }>;
+    paidAt: z.ZodISODateTime;
+    invoiceNumber: z.ZodNullable<z.ZodString>;
+    refundableUntil: z.ZodNullable<z.ZodISODateTime>;
+    listPrice: z.ZodNumber;
+    discount: z.ZodNumber;
+    coupon: z.ZodNullable<z.ZodObject<{
+        code: z.ZodString;
+        label: z.ZodString;
+    }, z.core.$strip>>;
+    invoice: z.ZodNullable<z.ZodObject<{
+        number: z.ZodString;
+        issuedAt: z.ZodISODateTime;
+        test: z.ZodBoolean;
+        supplier: z.ZodObject<{
+            name: z.ZodString;
+            address: z.ZodNullable<z.ZodString>;
+            gstin: z.ZodNullable<z.ZodString>;
+            stateCode: z.ZodEnum<{
+                "01": "01";
+                "02": "02";
+                "03": "03";
+                "04": "04";
+                "05": "05";
+                "06": "06";
+                "07": "07";
+                "08": "08";
+                "09": "09";
+                10: "10";
+                11: "11";
+                12: "12";
+                13: "13";
+                14: "14";
+                15: "15";
+                16: "16";
+                17: "17";
+                18: "18";
+                19: "19";
+                20: "20";
+                21: "21";
+                22: "22";
+                23: "23";
+                24: "24";
+                26: "26";
+                27: "27";
+                29: "29";
+                30: "30";
+                31: "31";
+                32: "32";
+                33: "33";
+                34: "34";
+                35: "35";
+                36: "36";
+                37: "37";
+                38: "38";
+            }>;
+            stateName: z.ZodString;
+        }, z.core.$strip>;
+        buyer: z.ZodObject<{
+            name: z.ZodString;
+            address: z.ZodNullable<z.ZodString>;
+            gstin: z.ZodNullable<z.ZodString>;
+            stateCode: z.ZodEnum<{
+                "01": "01";
+                "02": "02";
+                "03": "03";
+                "04": "04";
+                "05": "05";
+                "06": "06";
+                "07": "07";
+                "08": "08";
+                "09": "09";
+                10: "10";
+                11: "11";
+                12: "12";
+                13: "13";
+                14: "14";
+                15: "15";
+                16: "16";
+                17: "17";
+                18: "18";
+                19: "19";
+                20: "20";
+                21: "21";
+                22: "22";
+                23: "23";
+                24: "24";
+                26: "26";
+                27: "27";
+                29: "29";
+                30: "30";
+                31: "31";
+                32: "32";
+                33: "33";
+                34: "34";
+                35: "35";
+                36: "36";
+                37: "37";
+                38: "38";
+            }>;
+            stateName: z.ZodString;
+        }, z.core.$strip>;
+        kind: z.ZodEnum<{
+            b2b: "b2b";
+            b2c: "b2c";
+        }>;
+        sac: z.ZodString;
+        description: z.ZodString;
+        tax: z.ZodObject<{
+            ratePercent: z.ZodNumber;
+            taxable: z.ZodNumber;
+            cgst: z.ZodNumber;
+            sgst: z.ZodNumber;
+            igst: z.ZodNumber;
+            total: z.ZodNumber;
+        }, z.core.$strip>;
+        reverseCharge: z.ZodLiteral<false>;
+        razorpayPaymentId: z.ZodString;
+    }, z.core.$strip>>;
+    creditNote: z.ZodNullable<z.ZodObject<{
+        number: z.ZodString;
+        issuedAt: z.ZodISODateTime;
+        invoiceNumber: z.ZodString;
+        tax: z.ZodObject<{
+            ratePercent: z.ZodNumber;
+            taxable: z.ZodNumber;
+            cgst: z.ZodNumber;
+            sgst: z.ZodNumber;
+            igst: z.ZodNumber;
+            total: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+    refundedAt: z.ZodNullable<z.ZodISODateTime>;
+}, z.core.$strip>;
+export type PaymentDetail = z.infer<typeof paymentDetailSchema>;
+/** Who paid, as they are now, so staff can find them. Email only for a role that may read it. */
+export declare const payerSchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    displayName: z.ZodString;
+    email: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type Payer = z.infer<typeof payerSchema>;
+export declare const staffPaymentsQuerySchema: z.ZodObject<{
+    limit: z.ZodPreprocess<z.ZodDefault<z.ZodCoercedNumber<unknown>>, unknown>;
+    cursor: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodEnum<{
+        paid: "paid";
+        created: "created";
+        granted_free: "granted_free";
+        expired: "expired";
+        refund_pending: "refund_pending";
+        refunded: "refunded";
+        refund_failed: "refund_failed";
+    }>>;
+    memberId: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>;
+    needsAction: z.ZodPreprocess<z.ZodDefault<z.ZodCodec<z.ZodString, z.ZodBoolean>>, unknown>;
+}, z.core.$strip>;
+export type StaffPaymentsQuery = z.infer<typeof staffPaymentsQuerySchema>;
+export type StaffPaymentsQueryInput = z.input<typeof staffPaymentsQuerySchema>;
+export declare const staffPaymentSummarySchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    item: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"membership">;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"plan">;
+        tier: z.ZodEnum<{
+            premium: "premium";
+            business: "business";
+        }>;
+        period: z.ZodEnum<{
+            month: "month";
+            year: "year";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"upgrade">;
+    }, z.core.$strip>], "kind">;
+    title: z.ZodString;
+    total: z.ZodNumber;
+    status: z.ZodEnum<{
+        paid: "paid";
+        created: "created";
+        granted_free: "granted_free";
+        expired: "expired";
+        refund_pending: "refund_pending";
+        refunded: "refunded";
+        refund_failed: "refund_failed";
+    }>;
+    paidAt: z.ZodISODateTime;
+    invoiceNumber: z.ZodNullable<z.ZodString>;
+    refundableUntil: z.ZodNullable<z.ZodISODateTime>;
+    payer: z.ZodObject<{
+        id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+        displayName: z.ZodString;
+        email: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    needsAction: z.ZodBoolean;
+}, z.core.$strip>;
+export type StaffPaymentSummary = z.infer<typeof staffPaymentSummarySchema>;
+export declare const staffPaymentPageSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+        item: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            kind: z.ZodLiteral<"membership">;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"plan">;
+            tier: z.ZodEnum<{
+                premium: "premium";
+                business: "business";
+            }>;
+            period: z.ZodEnum<{
+                month: "month";
+                year: "year";
+            }>;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"upgrade">;
+        }, z.core.$strip>], "kind">;
+        title: z.ZodString;
+        total: z.ZodNumber;
+        status: z.ZodEnum<{
+            paid: "paid";
+            created: "created";
+            granted_free: "granted_free";
+            expired: "expired";
+            refund_pending: "refund_pending";
+            refunded: "refunded";
+            refund_failed: "refund_failed";
+        }>;
+        paidAt: z.ZodISODateTime;
+        invoiceNumber: z.ZodNullable<z.ZodString>;
+        refundableUntil: z.ZodNullable<z.ZodISODateTime>;
+        payer: z.ZodObject<{
+            id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+            displayName: z.ZodString;
+            email: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>;
+        needsAction: z.ZodBoolean;
+    }, z.core.$strip>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type StaffPaymentPage = z.infer<typeof staffPaymentPageSchema>;
+export declare const staffPaymentDetailSchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    item: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"membership">;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"plan">;
+        tier: z.ZodEnum<{
+            premium: "premium";
+            business: "business";
+        }>;
+        period: z.ZodEnum<{
+            month: "month";
+            year: "year";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"upgrade">;
+    }, z.core.$strip>], "kind">;
+    title: z.ZodString;
+    total: z.ZodNumber;
+    status: z.ZodEnum<{
+        paid: "paid";
+        created: "created";
+        granted_free: "granted_free";
+        expired: "expired";
+        refund_pending: "refund_pending";
+        refunded: "refunded";
+        refund_failed: "refund_failed";
+    }>;
+    paidAt: z.ZodISODateTime;
+    invoiceNumber: z.ZodNullable<z.ZodString>;
+    refundableUntil: z.ZodNullable<z.ZodISODateTime>;
+    listPrice: z.ZodNumber;
+    discount: z.ZodNumber;
+    coupon: z.ZodNullable<z.ZodObject<{
+        code: z.ZodString;
+        label: z.ZodString;
+    }, z.core.$strip>>;
+    invoice: z.ZodNullable<z.ZodObject<{
+        number: z.ZodString;
+        issuedAt: z.ZodISODateTime;
+        test: z.ZodBoolean;
+        supplier: z.ZodObject<{
+            name: z.ZodString;
+            address: z.ZodNullable<z.ZodString>;
+            gstin: z.ZodNullable<z.ZodString>;
+            stateCode: z.ZodEnum<{
+                "01": "01";
+                "02": "02";
+                "03": "03";
+                "04": "04";
+                "05": "05";
+                "06": "06";
+                "07": "07";
+                "08": "08";
+                "09": "09";
+                10: "10";
+                11: "11";
+                12: "12";
+                13: "13";
+                14: "14";
+                15: "15";
+                16: "16";
+                17: "17";
+                18: "18";
+                19: "19";
+                20: "20";
+                21: "21";
+                22: "22";
+                23: "23";
+                24: "24";
+                26: "26";
+                27: "27";
+                29: "29";
+                30: "30";
+                31: "31";
+                32: "32";
+                33: "33";
+                34: "34";
+                35: "35";
+                36: "36";
+                37: "37";
+                38: "38";
+            }>;
+            stateName: z.ZodString;
+        }, z.core.$strip>;
+        buyer: z.ZodObject<{
+            name: z.ZodString;
+            address: z.ZodNullable<z.ZodString>;
+            gstin: z.ZodNullable<z.ZodString>;
+            stateCode: z.ZodEnum<{
+                "01": "01";
+                "02": "02";
+                "03": "03";
+                "04": "04";
+                "05": "05";
+                "06": "06";
+                "07": "07";
+                "08": "08";
+                "09": "09";
+                10: "10";
+                11: "11";
+                12: "12";
+                13: "13";
+                14: "14";
+                15: "15";
+                16: "16";
+                17: "17";
+                18: "18";
+                19: "19";
+                20: "20";
+                21: "21";
+                22: "22";
+                23: "23";
+                24: "24";
+                26: "26";
+                27: "27";
+                29: "29";
+                30: "30";
+                31: "31";
+                32: "32";
+                33: "33";
+                34: "34";
+                35: "35";
+                36: "36";
+                37: "37";
+                38: "38";
+            }>;
+            stateName: z.ZodString;
+        }, z.core.$strip>;
+        kind: z.ZodEnum<{
+            b2b: "b2b";
+            b2c: "b2c";
+        }>;
+        sac: z.ZodString;
+        description: z.ZodString;
+        tax: z.ZodObject<{
+            ratePercent: z.ZodNumber;
+            taxable: z.ZodNumber;
+            cgst: z.ZodNumber;
+            sgst: z.ZodNumber;
+            igst: z.ZodNumber;
+            total: z.ZodNumber;
+        }, z.core.$strip>;
+        reverseCharge: z.ZodLiteral<false>;
+        razorpayPaymentId: z.ZodString;
+    }, z.core.$strip>>;
+    creditNote: z.ZodNullable<z.ZodObject<{
+        number: z.ZodString;
+        issuedAt: z.ZodISODateTime;
+        invoiceNumber: z.ZodString;
+        tax: z.ZodObject<{
+            ratePercent: z.ZodNumber;
+            taxable: z.ZodNumber;
+            cgst: z.ZodNumber;
+            sgst: z.ZodNumber;
+            igst: z.ZodNumber;
+            total: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+    refundedAt: z.ZodNullable<z.ZodISODateTime>;
+    payer: z.ZodObject<{
+        id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+        displayName: z.ZodString;
+        email: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    razorpay: z.ZodObject<{
+        orderId: z.ZodNullable<z.ZodString>;
+        paymentId: z.ZodNullable<z.ZodString>;
+        refundId: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    refundReason: z.ZodNullable<z.ZodString>;
+    grantFailed: z.ZodNullable<z.ZodString>;
+    disputedAt: z.ZodNullable<z.ZodISODateTime>;
+    refundedOutside: z.ZodNumber;
+    strayPayments: z.ZodArray<z.ZodObject<{
+        paymentId: z.ZodString;
+        amount: z.ZodNumber;
+        refunded: z.ZodBoolean;
+        at: z.ZodISODateTime;
+    }, z.core.$strip>>;
+    viewer: z.ZodObject<{
+        canRefund: z.ZodBoolean;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StaffPaymentDetail = z.infer<typeof staffPaymentDetailSchema>;
+/** `POST /staff/payments/:orderId/refund`. The reason is on the audit record. */
+export declare const refundPaymentBodySchema: z.ZodObject<{
+    reason: z.ZodString;
+}, z.core.$strip>;
+export type RefundPaymentBody = z.infer<typeof refundPaymentBodySchema>;
+/**
+ * `PUT /members/:memberId/membership`: grant (a partner, a press account) or
+ * revoke (a fake or duplicate account holding a founding place). A paid one
+ * is never revoked: refund its payment.
+ */
+export declare const setMembershipBodySchema: z.ZodObject<{
+    granted: z.ZodBoolean;
+    reason: z.ZodString;
+}, z.core.$strip>;
+export type SetMembershipBody = z.infer<typeof setMembershipBodySchema>;
+/** What a coupon is good for. A percent coupon names what it applies to. */
+export declare const COUPON_TARGET_VALUES: readonly ["membership", "premium", "business"];
+export declare const couponTargetSchema: z.ZodEnum<{
+    premium: "premium";
+    business: "business";
+    membership: "membership";
+}>;
+export type CouponTarget = z.infer<typeof couponTargetSchema>;
+/**
+ * ⚠ Stored: append only.
+ *
+ *   free_membership  the membership at Rs 0; `founding` numbers its holders
+ *                    ("Founding member #N")
+ *   percent_off      a share off the listed price of what it applies to
+ */
+export declare const couponBenefitSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"free_membership">;
+    founding: z.ZodBoolean;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"percent_off">;
+    percent: z.ZodNumber;
+    appliesTo: z.ZodArray<z.ZodEnum<{
+        premium: "premium";
+        business: "business";
+        membership: "membership";
+    }>>;
+}, z.core.$strip>], "kind">;
+export type CouponBenefit = z.infer<typeof couponBenefitSchema>;
+export declare const couponSchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    code: z.ZodString;
+    label: z.ZodString;
+    benefit: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"free_membership">;
+        founding: z.ZodBoolean;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"percent_off">;
+        percent: z.ZodNumber;
+        appliesTo: z.ZodArray<z.ZodEnum<{
+            premium: "premium";
+            business: "business";
+            membership: "membership";
+        }>>;
+    }, z.core.$strip>], "kind">;
+    max: z.ZodNullable<z.ZodNumber>;
+    used: z.ZodNumber;
+    active: z.ZodBoolean;
+    validFrom: z.ZodNullable<z.ZodISODateTime>;
+    validUntil: z.ZodNullable<z.ZodISODateTime>;
+    createdAt: z.ZodISODateTime;
+}, z.core.$strip>;
+export type Coupon = z.infer<typeof couponSchema>;
+/** Never paged: coupons are few. Newest first. */
+export declare const couponListSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+        code: z.ZodString;
+        label: z.ZodString;
+        benefit: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            kind: z.ZodLiteral<"free_membership">;
+            founding: z.ZodBoolean;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"percent_off">;
+            percent: z.ZodNumber;
+            appliesTo: z.ZodArray<z.ZodEnum<{
+                premium: "premium";
+                business: "business";
+                membership: "membership";
+            }>>;
+        }, z.core.$strip>], "kind">;
+        max: z.ZodNullable<z.ZodNumber>;
+        used: z.ZodNumber;
+        active: z.ZodBoolean;
+        validFrom: z.ZodNullable<z.ZodISODateTime>;
+        validUntil: z.ZodNullable<z.ZodISODateTime>;
+        createdAt: z.ZodISODateTime;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type CouponList = z.infer<typeof couponListSchema>;
+export declare const couponParamsSchema: z.ZodObject<{
+    couponId: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+}, z.core.$strip>;
+export type CouponParams = z.infer<typeof couponParamsSchema>;
+export declare const createCouponBodySchema: z.ZodObject<{
+    code: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    label: z.ZodString;
+    benefit: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"free_membership">;
+        founding: z.ZodBoolean;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"percent_off">;
+        percent: z.ZodNumber;
+        appliesTo: z.ZodArray<z.ZodEnum<{
+            premium: "premium";
+            business: "business";
+            membership: "membership";
+        }>>;
+    }, z.core.$strip>], "kind">;
+    max: z.ZodNullable<z.ZodNumber>;
+    validFrom: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+    validUntil: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+}, z.core.$strip>;
+export type CreateCouponBody = z.infer<typeof createCouponBodySchema>;
+/**
+ * What may change on a live coupon. The code and the benefit never change: a
+ * redemption is a record of what a code gave when it was used.
+ */
+export declare const updateCouponBodySchema: z.ZodObject<{
+    label: z.ZodOptional<z.ZodString>;
+    active: z.ZodOptional<z.ZodBoolean>;
+    max: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    validFrom: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+    validUntil: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+}, z.core.$strip>;
+export type UpdateCouponBody = z.infer<typeof updateCouponBodySchema>;
+//# sourceMappingURL=billing.d.ts.map