@archildata/api-types 0.0.48 → 0.0.50

package/index.d.ts

@@ -13,7 +13,7 @@ export interface paths {
         };
         /**
          * Get billing summary
-         * @description Returns the selected account's billing state and available actions.
+         * @description Returns the selected account's billing state and available actions. Accounts that share billing also share subscription and open-invoice information.
          */
         get: operations["getBillingSummary"];
         put?: never;
@@ -74,8 +74,8 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Start card setup with Stripe Elements
-         * @description Confirm the returned SetupIntent with Stripe Elements in the client.
+         * Start card setup
+         * @description Use the returned clientSecret to confirm card details in the client's payment form.
          */
         post: operations["createBillingSetupIntent"];
         delete?: never;
@@ -93,8 +93,8 @@ export interface paths {
         };
         get?: never;
         /**
-         * Set the default method for customer invoices and the current subscription
-         * @description Provide a saved method ID or a succeeded SetupIntent ID. The method must belong to the authenticated account's Stripe customer. Existing invoice debt is not paid by this action. Accounts with multiple billable subscriptions require support review.
+         * Set the default payment method
+         * @description Provide a saved payment method ID or a completed card setup ID. The payment method must belong to the selected account. This action does not pay outstanding invoices. Accounts with multiple billable subscriptions must contact support.
          */
         put: operations["setBillingDefaultPaymentMethod"];
         post?: never;
@@ -104,6 +104,64 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/billing/profile": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get invoice billing details */
+        get: operations["getBillingProfile"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /** Update invoice billing details */
+        patch: operations["updateBillingProfile"];
+        trace?: never;
+    };
+    "/api/billing/invoices": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List account invoices
+         * @description Returns invoice summaries for the selected account's billing profile. Accounts that share billing have the same invoice history. The default page size is 24; use limit to request between 1 and 100 invoices. When nextCursor is returned, pass its value as cursor to fetch the next page.
+         */
+        get: operations["listBillingInvoices"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/billing/invoices/{invoiceID}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get invoice details and a PDF download link
+         * @description Returns invoice details and an optional invoicePdf download link. Line items and credit notes are paginated independently; limit applies to each section and defaults to 24, with values from 1 to 100 accepted. A true partialData value means at least one section has more items. To continue a section, pass its lineNextCursor as lineCursor or its creditNoteNextCursor as creditNoteCursor. Retrieve a new PDF link when needed rather than storing it for later use.
+         */
+        get: operations["getBillingInvoice"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/activity": {
         parameters: {
             query?: never;
@@ -859,7 +917,7 @@ export interface components {
             code?: string;
         };
         BillingOwner: {
-            /** @description Selected account ID; linked accounts may share a Stripe customer. */
+            /** @description Selected account ID. */
             accountId: string;
             /** @enum {string} */
             type: "personal" | "organization";
@@ -912,7 +970,7 @@ export interface components {
             billingMode: "not_setup" | "self_serve" | "managed";
             /** @enum {string} */
             plan: "developer" | "team" | "enterprise" | "unknown";
-            /** @description Stripe subscription status, `none`, or `managed`. */
+            /** @description Current subscription status, `none`, or `managed`. */
             subscriptionStatus: string;
             billingPeriod?: components["schemas"]["BillingPeriod"];
             /**
@@ -998,6 +1056,109 @@ export interface components {
                 scope: "customer" | "customer_and_subscription";
             };
         };
+        BillingProfile: {
+            /** @enum {string} */
+            billingMode: "not_setup" | "self_serve";
+            name: string;
+            email: string;
+            phone: string;
+            address?: components["schemas"]["BillingAddress"];
+        };
+        BillingProfileValidationError: components["schemas"]["ErrorResponse"] & {
+            /** @enum {string} */
+            code: "invalid_billing_profile";
+            data: {
+                /** @description Validation messages keyed by profile field name. */
+                fieldErrors: {
+                    [key: string]: string;
+                };
+            };
+        };
+        ApiResponse_BillingProfile: {
+            success: boolean;
+            data: components["schemas"]["BillingProfile"];
+        };
+        BillingInvoiceSummary: {
+            id: string;
+            number: string;
+            /** Format: int64 */
+            date: number;
+            status: string;
+            currency: string;
+            /** Format: int64 */
+            totalCents: number;
+            /** Format: int64 */
+            amountDueCents: number;
+            /** Format: int64 */
+            amountPaidCents: number;
+            /** Format: int64 */
+            amountRemainingCents: number;
+        };
+        ApiResponse_BillingInvoices: {
+            success: boolean;
+            data: components["schemas"]["BillingInvoiceSummary"][];
+            nextCursor?: string;
+        };
+        BillingInvoiceTax: {
+            /** Format: int64 */
+            amountCents: number;
+            /** Format: int64 */
+            taxableAmountCents: number;
+            type: string;
+        };
+        BillingInvoiceCredit: {
+            /** Format: int64 */
+            amountCents: number;
+            type: string;
+        };
+        BillingInvoiceLine: {
+            id: string;
+            description: string;
+            /** Format: int64 */
+            amountCents: number;
+            currency: string;
+            /** Format: int64 */
+            quantity: number;
+            period?: components["schemas"]["BillingPeriod"];
+            taxes: components["schemas"]["BillingInvoiceTax"][];
+            pretaxCredits: components["schemas"]["BillingInvoiceCredit"][];
+        };
+        BillingCreditNote: {
+            id: string;
+            number: string;
+            /** Format: int64 */
+            date: number;
+            status: string;
+            type: string;
+            currency: string;
+            /** Format: int64 */
+            totalCents: number;
+            /** Format: int64 */
+            prePaymentAmountCents: number;
+            /** Format: int64 */
+            postPaymentAmountCents: number;
+        };
+        BillingInvoiceDetail: components["schemas"]["BillingInvoiceSummary"] & {
+            /** Format: int64 */
+            subtotalCents: number;
+            /** Format: int64 */
+            prePaymentCreditNotesAmountCents: number;
+            /** Format: int64 */
+            postPaymentCreditNotesAmountCents: number;
+            taxes: components["schemas"]["BillingInvoiceTax"][];
+            pretaxCredits: components["schemas"]["BillingInvoiceCredit"][];
+            lines: components["schemas"]["BillingInvoiceLine"][];
+            creditNotes: components["schemas"]["BillingCreditNote"][];
+            lineNextCursor?: string;
+            creditNoteNextCursor?: string;
+            partialData: boolean;
+            /** Format: uri */
+            invoicePdf?: string;
+        };
+        ApiResponse_BillingInvoiceDetail: {
+            success: boolean;
+            data: components["schemas"]["BillingInvoiceDetail"];
+        };
         ActivityEvent: {
             accountId: string;
             /**
@@ -2358,7 +2519,7 @@ export interface operations {
             };
         };
         responses: {
-            /** @description Updated safe method details */
+            /** @description Updated payment method details */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -2391,7 +2552,7 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            /** @description SetupIntent for client-side confirmation */
+            /** @description Card setup ID and client secret for confirmation */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -2445,7 +2606,7 @@ export interface operations {
             };
         };
         responses: {
-            /** @description Stripe defaults were fetched again and verified */
+            /** @description Default payment method updated */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -2469,6 +2630,144 @@ export interface operations {
             502: components["responses"]["InternalError"];
         };
     };
+    getBillingProfile: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Billing profile, or empty fields when billing is not set up */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_BillingProfile"];
+                };
+            };
+            403: components["responses"]["Unauthorized"];
+            502: components["responses"]["InternalError"];
+        };
+    };
+    updateBillingProfile: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    name?: string;
+                    /** Format: email */
+                    email?: string;
+                    phone?: string;
+                    address?: components["schemas"]["BillingAddressPatch"];
+                };
+            };
+        };
+        responses: {
+            /** @description Saved invoice billing profile */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_BillingProfile"];
+                };
+            };
+            /** @description Invalid profile, with fieldErrors in data */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BillingProfileValidationError"];
+                };
+            };
+            403: components["responses"]["Unauthorized"];
+            502: components["responses"]["InternalError"];
+        };
+    };
+    listBillingInvoices: {
+        parameters: {
+            query?: {
+                limit?: number;
+                /** @description Pagination cursor from a previous response */
+                cursor?: components["parameters"]["Cursor"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Invoice summaries and an optional next-page cursor */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_BillingInvoices"];
+                };
+            };
+            400: components["responses"]["ValidationError"];
+            401: components["responses"]["Unauthorized"];
+            /** @description Billing is managed by Archil (`managed_billing`) */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            502: components["responses"]["InternalError"];
+        };
+    };
+    getBillingInvoice: {
+        parameters: {
+            query?: {
+                limit?: number;
+                lineCursor?: string;
+                creditNoteCursor?: string;
+            };
+            header?: never;
+            path: {
+                invoiceID: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Invoice details with paginated line items and credit notes */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_BillingInvoiceDetail"];
+                };
+            };
+            400: components["responses"]["ValidationError"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            /** @description Billing is managed by Archil (`managed_billing`) */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            502: components["responses"]["InternalError"];
+        };
+    };
     listActivity: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@archildata/api-types",
-  "version": "0.0.48",
+  "version": "0.0.50",
   "description": "API types for the Archil control plane",
   "type": "module",
   "types": "index.d.ts",