@periskope/types 0.6.461 → 0.6.463

package/src/billing.types.ts

@@ -0,0 +1,520 @@
+import { Merge, OverrideProperties } from 'type-fest';
+
+import { OrgPlanEnterprise, OrgPlanNonEnterprise } from './types';
+
+/* ----------------------------- BILLING V2 PLANS & PACKS ----------------------------- */
+
+export type BillingVersion = 'v1' | 'v2';
+
+export enum AllPlansV2 {
+  FREE_TRIAL = 'v2-free-trial',
+  MONTHLY_STARTER = 'v2-monthly-starter',
+  YEARLY_STARTER = 'v2-annual-starter',
+  MONTHLY_PRO = 'v2-monthly-pro',
+  YEARLY_PRO = 'v2-annual-pro',
+}
+
+export type AddonPackId = SeatAddonPackId | RecurringAddonPackId;
+
+/** V2-only — per-seat user & phone add-ons (tier-specific). */
+export type SeatAddonPackId =
+  | 'v2-additional-phone-pro'
+  | 'v2-additional-user-pro'
+  | 'v2-additional-phone-starter'
+  | 'v2-additional-user-starter';
+
+/** Shared by v1 and v2 — recurring optional add-ons. */
+export type RecurringAddonPackId = 'priority-support-pack' | 'automation-pack';
+
+/** Shared by v1 and v2 — one-time charge packs. */
+export type ChargesPack =
+  | 'ai-pack'
+  | 'bulk-message-credits'
+  | 'guided-onboarding'
+  | 'support-call'
+  | 'support-call-pack';
+
+/** Packs with no billing-version prefix — included under both v1 and v2. */
+export type GenericPackId = RecurringAddonPackId | ChargesPack;
+
+export const GENERIC_PACK_IDS: readonly GenericPackId[] = [
+  'priority-support-pack',
+  'automation-pack',
+  'ai-pack',
+  'bulk-message-credits',
+  'guided-onboarding',
+  'support-call',
+  'support-call-pack',
+];
+
+export type UsageType = 'ai_credits' | 'automation_rules';
+
+export type UsageAllowances = Partial<Record<UsageType, number>>;
+export type UsageConsumption = Partial<Record<UsageType, number>>;
+
+/** Recurring add-on flags derived from subscription line items. */
+export type V2AddonEntitlements = Partial<
+  Record<RecurringAddonPackId, boolean>
+>;
+
+export type OrgPlanV2 = Merge<
+  OverrideProperties<
+    OrgPlanEnterprise | OrgPlanNonEnterprise,
+    {
+      plan_id: AllPlansV2;
+    }
+  >,
+  {
+    billing_version: 'v2';
+    usage_allowances?: UsageAllowances;
+    addon_entitlements?: V2AddonEntitlements;
+  }
+>;
+
+export type OrgPlanV1 = (OrgPlanEnterprise | OrgPlanNonEnterprise) & {
+  billing_version?: 'v1';
+};
+
+export type AnyOrgPlan = OrgPlanV1 | OrgPlanV2;
+
+export const isV2Plan = (plan: AnyOrgPlan): plan is OrgPlanV2 =>
+  plan.billing_version === 'v2';
+
+/* ----------------------------- SHARED ----------------------------- */
+
+export type BillingEntity = 'IN' | 'US';
+
+/** Line item passed to Chargebee item-price / subscription APIs. */
+export type BillingV2LineItem = {
+  item_price_id: string;
+  quantity?: number;
+  unit_price?: number;
+};
+
+/** Headers required on all billing V2 requests. */
+export type BillingV2RequestHeaders = {
+  org_id: string;
+  'x-periskope-trace-id'?: string;
+};
+
+export type BillingFrequency = 'monthly' | 'yearly';
+
+export type BillingPlanTier = 'starter' | 'pro';
+
+/** Money in major currency units (e.g. 2400 = ₹2,400). */
+export type BillingMoney = {
+  amount: number;
+  currency_code: string;
+};
+
+/* ----------------------------- GET PRICES ----------------------------- */
+
+export type BillingPriceItem = {
+  item_price_id: string;
+  item_id: string;
+  lookup_key: string | null;
+  name: string;
+  description: string | null;
+  price: BillingMoney;
+  frequency: BillingFrequency | null;
+  period: number | null;
+  status: string;
+};
+
+export type BillingVersionPrices = {
+  plan: BillingPriceItem[];
+  addons: BillingPriceItem[];
+  charges: BillingPriceItem[];
+};
+
+export type GetPricesParams = {
+  currency: string;
+};
+
+export type GetPricesResponse = {
+  v1: BillingVersionPrices;
+  v2: BillingVersionPrices;
+};
+
+/* ----------------------------- UPGRADE FLOW — STEP 2: SEAT ADDONS ----------------------------- */
+
+export type SeatAddonConfig = {
+  pack_id: SeatAddonPackId;
+  label: string;
+  unit_price: BillingMoney;
+  /** Included in base plan before add-on quantity applies (typically 1). */
+  included_quantity: number;
+};
+
+export type GetSeatAddonsParams = {
+  currency: string;
+  plan_key: AllPlansV2;
+};
+
+export type GetSeatAddonsResponse = {
+  users: SeatAddonConfig;
+  phones: SeatAddonConfig;
+  credits_per_seat_per_month: number;
+};
+
+/* ----------------------------- UPGRADE FLOW — STEP 3: RECURRING ADDONS ----------------------------- */
+
+export type RecurringAddonBillingModel = 'quantity' | 'flat';
+
+export type RecurringAddonOption = {
+  pack_id: RecurringAddonPackId;
+  name: string;
+  description: string;
+  billing_model: RecurringAddonBillingModel;
+  unit_price: BillingMoney;
+  /** e.g. "pack" for automation rules. */
+  unit_label?: string;
+  rules_per_pack?: number;
+};
+
+export type GetRecurringAddonsParams = {
+  currency: string;
+};
+
+export type GetRecurringAddonsResponse = {
+  automation_pack: RecurringAddonOption;
+  priority_support: RecurringAddonOption;
+};
+
+/* ----------------------------- ORDER SUMMARY (SIDEBAR + REVIEW) ----------------------------- */
+
+export type OrderSummaryItemType = 'plan' | 'addon';
+
+export type OrderSummaryItem = {
+  type: OrderSummaryItemType;
+  item_price_id: string;
+  lookup_key: string | null;
+  name: string;
+  description: string | null;
+  quantity: number;
+  unit_price: BillingMoney;
+  amount: BillingMoney;
+  /** null for one-time charge line items */
+  frequency: BillingFrequency | null;
+};
+
+export type GetOrderSummaryRequestBody = {
+  subscription_id?: string;
+  line_items: BillingV2LineItem[];
+  coupon_id?: string;
+};
+
+export type OrderSummaryNextCharge = {
+  /** Unix timestamp for the next recurring charge. */
+  date: number;
+  amount: BillingMoney;
+};
+
+export type GetOrderSummaryResponse = {
+  frequency: BillingFrequency;
+  currency_code: string;
+  items: OrderSummaryItem[];
+  /** Line items with quantity > 0 — for "Subtotal (N items)". */
+  item_count: number;
+  /** Pre-adjustment subtotal from Chargebee invoice_estimate.sub_total. */
+  subtotal: BillingMoney;
+  /** Promotional / account credits applied — null when none on estimate. */
+  credits_applied: BillingMoney | null;
+  /** null when no coupon on the estimate. */
+  coupon: AppliedCouponSummary | null;
+  /** Amount due after credits and coupon (invoice_estimate.total). */
+  total: BillingMoney;
+  /** Prorated amount due now (invoice_estimate.amount_due). */
+  due_today: BillingMoney;
+  /** Next full recurring charge — null when not available on estimate. */
+  next_charge: OrderSummaryNextCharge | null;
+};
+
+/* ----------------------------- COUPONS ----------------------------- */
+
+export type CouponDiscountType = 'fixed_amount' | 'percentage' | 'offer_quantity';
+
+export type GetCouponDetailsRequestBody = {
+  coupon_code: string;
+};
+
+export type GetCouponDetailsResponse = {
+  coupon_id: string;
+  coupon_code: string;
+  name: string | null;
+  discount_type: CouponDiscountType;
+  /** Set when discount_type is percentage; otherwise null. */
+  discount_percentage: number | null;
+  /** Set when discount_type is fixed_amount; otherwise null. */
+  discount_amount: BillingMoney | null;
+  duration_type: 'one_time' | 'forever' | 'limited_period';
+  status: string;
+};
+
+export type AppliedCouponSummary = {
+  coupon_id: string;
+  name: string | null;
+  discount_type: CouponDiscountType;
+  discount_percentage: number | null;
+  discount_amount: BillingMoney | null;
+  /** Coupon discount applied on this estimate — null when coupon present but discount is zero. */
+  applied_amount: BillingMoney | null;
+};
+
+/* ----------------------------- CHECKOUT (POST-CONFIRM) ----------------------------- */
+
+export type CreateCheckoutSessionRequestBody = {
+  success_url: string;
+  cancel_url: string;
+  line_items: BillingV2LineItem[];
+  subscription_id?: string;
+  /** Chargebee coupon ids — resolve via POST /get-coupon-details */
+  coupon_ids?: string[];
+  /** When upgrading an existing sub with coupons. Default `true`. */
+  replace_coupon_list?: boolean;
+};
+
+export type CreateCheckoutSessionResponse = {
+  url: string;
+  hosted_page_id: string | null;
+  expires_at: number | null;
+};
+
+export type CreateChargeCheckoutSessionRequestBody = {
+  line_items: BillingV2LineItem[];
+  currency?: string;
+};
+
+export type CreateChargeCheckoutSessionResponse = {
+  url: string;
+  hosted_page_id: string | null;
+  expires_at: number | null;
+};
+
+export type CreateCustomerPortalRequestBody = {
+  redirect_url: string;
+};
+
+export type CreateCustomerPortalResponse = {
+  url: string;
+  expires_at?: number;
+};
+
+/* ----------------------------- SUBSCRIPTION ----------------------------- */
+
+export type UpdateSubscriptionRequestBody = {
+  subscription_id: string;
+  line_items: BillingV2LineItem[];
+  replace_addon_list?: boolean;
+};
+
+export type UpdateSubscriptionResponse = {
+  subscription_id: string;
+  status: string;
+  current_term_start: number | null;
+  current_term_end: number | null;
+  cancelled_at: number | null;
+};
+
+export type CancelSubscriptionRequestBody = {
+  subscription_id: string;
+};
+
+export type CancelSubscriptionResponse = {
+  subscription_id: string;
+  status: string;
+  cancelled_at?: number;
+};
+
+export type ResumeCancelledSubscriptionRequestBody = {
+  subscription_id: string;
+};
+
+export type ResumeCancelledSubscriptionResponse = {
+  subscription_id: string;
+  status: string;
+};
+
+/* ----------------------------- INVOICES ----------------------------- */
+
+export type BillingV2InvoiceSummary = {
+  invoice_id: string;
+  status: string;
+  amount_due: BillingMoney;
+  date: number;
+};
+
+export type GetUnpaidInvoicesResponse = BillingV2InvoiceSummary[];
+
+export type GetLatestNextInvoiceResponse = {
+  latest_invoice: BillingV2InvoiceSummary | null;
+  next_invoice: {
+    amount: BillingMoney;
+    date: number;
+  } | null;
+};
+
+export type GetInvoiceLinkResponse = {
+  url: string;
+} | null;
+
+export type DownloadInvoiceParams = {
+  invoice_id: string;
+};
+
+export type DownloadInvoiceResponse = {
+  url: string;
+  valid_till?: number;
+};
+
+export type GetRecentInvoicesParams = {
+  /** Max invoices to return (default 10, max 50). Customer resolved from org_id — do not pass customer_id. */
+  limit?: number;
+};
+
+export type RecentInvoiceLineItem = {
+  description: string | null;
+  entity_description: string | null;
+  quantity: number;
+  amount: BillingMoney;
+};
+
+/** Chargebee invoice row — aligned with dashboard fields (ID, status, type, total, credits). */
+export type ChargebeeInvoiceSummary = {
+  invoice_id: string;
+  /** Primary display title — first line item description from Chargebee. */
+  name: string;
+  description: string | null;
+  status: string;
+  /** `recurring` → "Recurring"; otherwise "One-time" on Chargebee. */
+  type: 'recurring' | 'one_time';
+  recurring: boolean;
+  /** Invoice created date (Chargebee `date`). */
+  date: number | null;
+  due_date: number | null;
+  paid_at: number | null;
+  subscription_id: string | null;
+  total: BillingMoney;
+  amount_due: BillingMoney;
+  amount_paid: BillingMoney;
+  /** Promotional / account credits applied ("Credits Issued" on Chargebee). */
+  credits_applied: BillingMoney | null;
+  line_items: RecentInvoiceLineItem[];
+  download_url: string | null;
+  download_valid_till: number | null;
+};
+
+export type RecentInvoice = ChargebeeInvoiceSummary;
+
+export type GetRecentInvoicesResponse = RecentInvoice[];
+
+/* ----------------------------- CUSTOMER ----------------------------- */
+
+/** Billing address fields accepted by Chargebee customer.updateBillingInfo. */
+export type BillingAddress = {
+  first_name?: string;
+  last_name?: string;
+  email?: string;
+  company?: string;
+  phone?: string;
+  line1?: string;
+  line2?: string;
+  line3?: string;
+  city?: string;
+  state_code?: string;
+  state?: string;
+  country?: string;
+  zip?: string;
+  vat_number?: string;
+};
+
+export type UpdateBillingDetailsRequestBody = {
+  billing_address: BillingAddress;
+  /** When country is IN, optionally move free-trial customer to IN entity. Defaults to US behaviour otherwise. */
+  move_to_entity?: BillingEntity;
+};
+
+export type UpdateBillingDetailsResponse = {
+  customer_id: string;
+  billing_address: BillingAddress;
+  preferred_currency_code: string;
+};
+
+/* ----------------------------- USAGE ----------------------------- */
+
+export type GetUsageResponse = {
+  allowances: UsageAllowances;
+  consumption: UsageConsumption;
+};
+
+/* ----------------------------- PLAN SUMMARY ----------------------------- */
+
+/** Upcoming renewal charge — null when no subscription or estimate unavailable. */
+export type PlanSummaryNextInvoice = {
+  amount: BillingMoney;
+  date: number;
+  /** e.g. "USD 56.00 on 18 Jul 2026" */
+  label: string;
+};
+
+export type PlanSummarySection = {
+  current_plan: string;
+  /** null when org_plan is not seeded yet */
+  plan_id: AllPlansV2 | string | null;
+  billing_frequency: BillingFrequency | 'weekly' | 'custom';
+  users: number;
+  phones: number;
+  /** null on free trial — no recurring rules allowance */
+  rules_allowance: number | null;
+  /** null on free trial — recurring BM only; free trial has top-up via charge_packs */
+  bm_credits_allowance: number | null;
+  /** null on free trial or when no upcoming renewal */
+  next_invoice: PlanSummaryNextInvoice | null;
+};
+
+export type PlanSummarySubscriptionStatus = 'active' | 'unpaid' | 'inactive';
+
+export type PlanSummaryInvoice = ChargebeeInvoiceSummary & {
+  /** Hosted payment page — null unless status is payment_due / not_paid. */
+  payment_url: string | null;
+};
+
+export type PlanSummaryChargePack = {
+  pack_id: 'bulk-message-credits';
+  lookup_key: string;
+  name: string;
+  /** Current top-up balance — null when zero. */
+  remaining_credits: number | null;
+};
+
+export type GetPlanSummaryResponse = {
+  billing_version: BillingVersion;
+  summary: PlanSummarySection;
+  subscription_status: PlanSummarySubscriptionStatus;
+  /** Newest first — empty when customer has no invoices. */
+  last_5_invoices: PlanSummaryInvoice[];
+  /** BM top-up only — empty when top-up balance is zero. */
+  charge_packs: PlanSummaryChargePack[];
+};
+
+/* ----------------------------- WEBHOOKS ----------------------------- */
+
+/** Raw Chargebee webhook POST body. */
+export type ChargebeeWebhookEventPayload = {
+  id: string;
+  occurred_at: number;
+  event_type: string;
+  content: Record<string, unknown>;
+  source?: string;
+  webhook_status?: string;
+};
+
+export type ChargebeeV2EventHandleResult = {
+  received: true;
+  handled: boolean;
+  event_id: string;
+  event_type: string;
+  billing_version?: BillingVersion;
+  org_id?: string;
+  reason?: string;
+};

package/src/index.ts

@@ -1,3 +1,4 @@
+export * from './billing.types';
 export * from './object.types';
 export * from './rules.types';
 export * from './supabase.types';

package/src/supabase.types.ts

@@ -2249,6 +2249,56 @@ export type Database = {
           },
         ]
       }
+      tbl_api_tokens: {
+        Row: {
+          exp: string
+          iat: string
+          id: string
+          is_revealed: boolean
+          name: string
+          org_id: string
+          role: string
+          token: string
+          token_hash: string
+          token_metadata: Json
+          type: Database["public"]["Enums"]["enum_integration_type"]
+        }
+        Insert: {
+          exp: string
+          iat: string
+          id: string
+          is_revealed?: boolean
+          name: string
+          org_id: string
+          role: string
+          token: string
+          token_hash: string
+          token_metadata?: Json
+          type: Database["public"]["Enums"]["enum_integration_type"]
+        }
+        Update: {
+          exp?: string
+          iat?: string
+          id?: string
+          is_revealed?: boolean
+          name?: string
+          org_id?: string
+          role?: string
+          token?: string
+          token_hash?: string
+          token_metadata?: Json
+          type?: Database["public"]["Enums"]["enum_integration_type"]
+        }
+        Relationships: [
+          {
+            foreignKeyName: "tbl_api_tokens_org_id_fkey"
+            columns: ["org_id"]
+            isOneToOne: false
+            referencedRelation: "tbl_org"
+            referencedColumns: ["org_id"]
+          },
+        ]
+      }
       tbl_integration_tokens: {
         Row: {
           exp: string

package/src/types.ts

@@ -128,6 +128,7 @@ export type OrgAISettings = {
   top_p?: string;
   top_k?: string;
   ai_maintain_flag_status?: boolean;
+  ai_inline_unflag_on_reply?: boolean;
   enable_shift_timing?: boolean;
   shift_start_time?: string;
   shift_end_time?: string;
@@ -1014,6 +1015,7 @@ export type APIAuthDetails = {
   org_details: Tables<'view_org'> | null;
   phone_details: Tables<'tbl_org_phones'> | null;
   token_details: Tables<'tbl_integration_tokens'> | null;
+  api_token_details: Tables<'tbl_api_tokens'> | null;
 };
 
 export type WebhookDataType = OverrideProperties<