@shipstatic/types 0.3.11 → 0.3.13

package/dist/index.d.ts

@@ -157,20 +157,21 @@ export declare const AccountPlan: {
 export type AccountPlanType = typeof AccountPlan[keyof typeof AccountPlan];
 /**
  * Core account object - used in both API responses and SDK
+ * All fields are readonly to prevent accidental mutations
  */
 export interface Account {
     /** User email address */
-    email: string;
+    readonly email: string;
     /** User display name */
-    name: string;
+    readonly name: string;
     /** User profile picture URL */
-    picture?: string;
+    readonly picture?: string;
     /** Account plan status */
-    plan: AccountPlanType;
+    readonly plan: AccountPlanType;
     /** Unix timestamp (seconds) when account was created */
-    created: number;
+    readonly created: number;
     /** Unix timestamp (seconds) when account was activated (first deployment) */
-    activated?: number;
+    readonly activated?: number;
 }
 /**
  * Account-specific configuration overrides
@@ -441,31 +442,30 @@ export interface TokenResource {
 }
 /**
  * Billing status response from GET /billing/status
+ *
+ * Note: The user's `plan` comes from Account, not here.
+ * This endpoint only returns billing-specific data (usage, portal, etc.)
+ *
+ * If `billing` is null, the user has no active billing.
  */
 export interface BillingStatus {
-    /** Whether the account has an active billing plan */
-    hasActiveBilling: boolean;
-    /** Current account plan */
-    plan: AccountPlanType;
-    /** Creem billing ID (if subscribed) */
-    billing?: string;
+    /** Creem billing ID, or null if no active billing */
+    billing: string | null;
     /** Number of billing units (1 unit = 1 custom domain) */
     units?: number;
     /** Number of custom domains currently in use */
-    customDomains?: number;
+    usage?: number;
     /** Billing status from Creem (active, trialing, canceled, etc.) */
     status?: string;
     /** Link to Creem customer portal for billing management */
-    portalLink?: string | null;
+    portal?: string | null;
 }
 /**
  * Checkout session response from POST /billing/checkout
  */
 export interface CheckoutSession {
     /** URL to redirect user to Creem checkout page */
-    checkoutUrl: string;
-    /** Creem checkout session ID */
-    checkoutId: string;
+    url: string;
 }
 /**
  * Billing resource interface - the contract all implementations must follow
@@ -485,14 +485,6 @@ export interface BillingResource {
      */
     status: () => Promise<BillingStatus>;
 }
-/**
- * @deprecated Use BillingStatus instead. Kept for backward compatibility.
- */
-export type SubscriptionStatus = BillingStatus;
-/**
- * @deprecated Use BillingResource instead. Kept for backward compatibility.
- */
-export type SubscriptionResource = BillingResource;
 /**
  * Keys resource interface - the contract all implementations must follow
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipstatic/types",
-  "version": "0.3.11",
+  "version": "0.3.13",
   "description": "Shared types for Shipstatic platform",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.ts

@@ -189,20 +189,21 @@ export type AccountPlanType = typeof AccountPlan[keyof typeof AccountPlan];
 
 /**
  * Core account object - used in both API responses and SDK
+ * All fields are readonly to prevent accidental mutations
  */
 export interface Account {
   /** User email address */
-  email: string;
+  readonly email: string;
   /** User display name */
-  name: string;
+  readonly name: string;
   /** User profile picture URL */
-  picture?: string;
+  readonly picture?: string;
   /** Account plan status */
-  plan: AccountPlanType;
+  readonly plan: AccountPlanType;
   /** Unix timestamp (seconds) when account was created */
-  created: number;
+  readonly created: number;
   /** Unix timestamp (seconds) when account was activated (first deployment) */
-  activated?: number;
+  readonly activated?: number;
 }
 
 /**
@@ -691,32 +692,32 @@ export interface TokenResource {
 
 /**
  * Billing status response from GET /billing/status
+ *
+ * Note: The user's `plan` comes from Account, not here.
+ * This endpoint only returns billing-specific data (usage, portal, etc.)
+ *
+ * If `billing` is null, the user has no active billing.
  */
 export interface BillingStatus {
-  /** Whether the account has an active billing plan */
-  hasActiveBilling: boolean;
-  /** Current account plan */
-  plan: AccountPlanType;
-  /** Creem billing ID (if subscribed) */
-  billing?: string;
+  /** Creem billing ID, or null if no active billing */
+  billing: string | null;
   /** Number of billing units (1 unit = 1 custom domain) */
   units?: number;
   /** Number of custom domains currently in use */
-  customDomains?: number;
+  usage?: number;
   /** Billing status from Creem (active, trialing, canceled, etc.) */
   status?: string;
   /** Link to Creem customer portal for billing management */
-  portalLink?: string | null;
+  portal?: string | null;
 }
 
+
 /**
  * Checkout session response from POST /billing/checkout
  */
 export interface CheckoutSession {
   /** URL to redirect user to Creem checkout page */
-  checkoutUrl: string;
-  /** Creem checkout session ID */
-  checkoutId: string;
+  url: string;
 }
 
 /**
@@ -739,16 +740,6 @@ export interface BillingResource {
   status: () => Promise<BillingStatus>;
 }
 
-/**
- * @deprecated Use BillingStatus instead. Kept for backward compatibility.
- */
-export type SubscriptionStatus = BillingStatus;
-
-/**
- * @deprecated Use BillingResource instead. Kept for backward compatibility.
- */
-export type SubscriptionResource = BillingResource;
-
 
 /**
  * Keys resource interface - the contract all implementations must follow