@archildata/api-types 0.0.43 → 0.0.45

package/index.d.ts

@@ -4,6 +4,60 @@
  */
 
 export interface paths {
+    "/api/billing/summary": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get billing summary
+         * @description Returns the selected account's billing state and available actions.
+         */
+        get: operations["getBillingSummary"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/billing/payment-methods": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List saved billing payment methods */
+        get: operations["listBillingPaymentMethods"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/billing/setup-intents": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Start card setup with Stripe Elements */
+        post: operations["createBillingSetupIntent"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/activity": {
         parameters: {
             query?: never;
@@ -709,6 +763,105 @@ export interface components {
             /** @description Stable machine-readable error code. */
             code?: string;
         };
+        BillingOwner: {
+            /** @description Selected account ID; linked accounts may share a Stripe customer. */
+            accountId: string;
+            /** @enum {string} */
+            type: "personal" | "organization";
+        };
+        BillingPeriod: {
+            /**
+             * Format: int64
+             * @description Unix timestamp in seconds.
+             */
+            start: number;
+            /**
+             * Format: int64
+             * @description Unix timestamp in seconds.
+             */
+            end: number;
+        };
+        BillingScheduledChange: {
+            /** @enum {string} */
+            type: "schedule_transition" | "plan_change";
+            /**
+             * Format: int64
+             * @description Unix timestamp in seconds.
+             */
+            effectiveAt: number;
+            /** @enum {string} */
+            targetPlan?: "developer" | "team" | "enterprise";
+        };
+        BillingPaymentHealth: {
+            /** @enum {string} */
+            status: "not_applicable" | "invoice_open" | "action_required" | "missing_payment_method" | "healthy";
+            hasDefaultPaymentMethod: boolean;
+            openInvoiceId?: string;
+            /** Format: int64 */
+            amountRemainingCents?: number;
+            openInvoiceCurrency?: string;
+        };
+        BillingSummaryActions: {
+            canStartCheckout: boolean;
+            canManagePaymentMethods: boolean;
+            canUpdateBillingProfile: boolean;
+            canViewInvoices: boolean;
+            canChangePlan: boolean;
+            canCancel: boolean;
+            canKeepSubscription: boolean;
+            canPayOpenInvoice: boolean;
+        };
+        BillingSummary: {
+            billingOwner: components["schemas"]["BillingOwner"];
+            /** @enum {string} */
+            billingMode: "not_setup" | "self_serve" | "managed";
+            /** @enum {string} */
+            plan: "developer" | "team" | "enterprise" | "unknown";
+            /** @description Stripe subscription status, `none`, or `managed`. */
+            subscriptionStatus: string;
+            billingPeriod?: components["schemas"]["BillingPeriod"];
+            /**
+             * Format: int64
+             * @description Unix timestamp in seconds.
+             */
+            scheduledCancellationAt?: number;
+            scheduledChange?: components["schemas"]["BillingScheduledChange"];
+            hasPendingUpdate: boolean;
+            paymentHealth: components["schemas"]["BillingPaymentHealth"];
+            actions: components["schemas"]["BillingSummaryActions"];
+        };
+        ApiResponse_BillingSummary: {
+            /** @example true */
+            success: boolean;
+            data: components["schemas"]["BillingSummary"];
+        };
+        BillingPaymentMethod: {
+            id: string;
+            type: string;
+            card?: {
+                brand: string;
+                last4: string;
+                /** Format: int64 */
+                expMonth: number;
+                /** Format: int64 */
+                expYear: number;
+            };
+            isCustomerDefault: boolean;
+            isSubscriptionDefault: boolean;
+            isDefault: boolean;
+        };
+        ApiResponse_BillingPaymentMethods: {
+            success: boolean;
+            data: components["schemas"]["BillingPaymentMethod"][];
+            nextCursor?: string;
+        };
+        ApiResponse_BillingSetupIntent: {
+            success: boolean;
+            data: {
+                id: string;
+                clientSecret: string;
+            };
+        };
         ActivityEvent: {
             accountId: string;
             /**
@@ -1887,6 +2040,143 @@ export interface components {
 }
 export type $defs = Record<string, never>;
 export interface operations {
+    getBillingSummary: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Billing summary */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_BillingSummary"];
+                };
+            };
+            /** @description Missing, invalid, or disallowed credential */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Billing data could not be loaded */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    listBillingPaymentMethods: {
+        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 Saved methods, with a cursor when more remain */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_BillingPaymentMethods"];
+                };
+            };
+            400: components["responses"]["ValidationError"];
+            /** @description Missing, invalid, or disallowed credential */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Billing is managed by Archil (`managed_billing`) */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Payment methods could not be loaded */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    createBillingSetupIntent: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description SetupIntent for client-side confirmation */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_BillingSetupIntent"];
+                };
+            };
+            /** @description Missing, invalid, or disallowed credential */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Billing is managed by Archil (`managed_billing`) */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Card setup could not be started */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
     listActivity: {
         parameters: {
             query?: {

package/package.json

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