@codeguide/core 0.0.6 → 0.0.8

package/services/subscriptions/subscription-service.ts

@@ -0,0 +1,147 @@
+import { BaseService } from '../base/base-service'
+import {
+  CurrentSubscriptionResponse,
+  UserSubscriptionsResponse,
+  CancelSubscriptionRequest,
+  CancelSubscriptionResponse,
+} from '../../types'
+
+export class SubscriptionService extends BaseService {
+  constructor(config: any) {
+    super(config)
+  }
+
+  /**
+   * Get the currently active subscription for the authenticated user
+   * GET /subscriptions/current
+   */
+  async getCurrentSubscription(): Promise<CurrentSubscriptionResponse> {
+    return this.get<CurrentSubscriptionResponse>('/subscriptions/current')
+  }
+
+  /**
+   * Get all subscriptions (active and historical) for the authenticated user
+   * GET /subscriptions/
+   */
+  async getAllSubscriptions(): Promise<UserSubscriptionsResponse> {
+    return this.get<UserSubscriptionsResponse>('/subscriptions/')
+  }
+
+  /**
+   * Cancel subscription but keep it active until the end of the current billing period
+   * POST /subscriptions/{subscription_id}/cancel
+   */
+  async cancelSubscription(
+    subscriptionId: string,
+    request: CancelSubscriptionRequest
+  ): Promise<CancelSubscriptionResponse> {
+    return this.post<CancelSubscriptionResponse>(
+      `/subscriptions/${subscriptionId}/cancel`,
+      request
+    )
+  }
+
+  /**
+   * Get subscription details by ID
+   * GET /subscriptions/{subscription_id}
+   */
+  async getSubscriptionById(subscriptionId: string): Promise<{
+    status: string
+    data: {
+      subscription: any
+      product: any
+      price: any
+    }
+  }> {
+    return this.get(`/subscriptions/${subscriptionId}`)
+  }
+
+  /**
+   * Reactivate a canceled subscription (if supported by API)
+   * POST /subscriptions/{subscription_id}/reactivate
+   */
+  async reactivateSubscription(subscriptionId: string): Promise<{
+    status: string
+    message: string
+    data: any
+  }> {
+    return this.post(`/subscriptions/${subscriptionId}/reactivate`, {})
+  }
+
+  /**
+   * Update subscription quantity or other parameters
+   * PUT /subscriptions/{subscription_id}
+   */
+  async updateSubscription(
+    subscriptionId: string,
+    updates: {
+      quantity?: number
+      metadata?: Record<string, any>
+    }
+  ): Promise<{
+    status: string
+    data: any
+  }> {
+    return this.put(`/subscriptions/${subscriptionId}`, updates)
+  }
+
+  /**
+   * Get subscription usage statistics (if supported by API)
+   * GET /subscriptions/{subscription_id}/usage
+   */
+  async getSubscriptionUsage(subscriptionId: string): Promise<{
+    status: string
+    data: {
+      current_usage: number
+      limit: number
+      period_start: string
+      period_end: string
+      usage_breakdown?: Array<{
+        feature: string
+        used: number
+        limit: number
+      }>
+    }
+  }> {
+    return this.get(`/subscriptions/${subscriptionId}/usage`)
+  }
+
+  /**
+   * Get upcoming invoice for subscription
+   * GET /subscriptions/{subscription_id}/upcoming-invoice
+   */
+  async getUpcomingInvoice(subscriptionId: string): Promise<{
+    status: string
+    data: {
+      amount: number
+      currency: string
+      date: string
+      line_items: Array<{
+        description: string
+        amount: number
+        currency: string
+      }>
+    }
+  }> {
+    return this.get(`/subscriptions/${subscriptionId}/upcoming-invoice`)
+  }
+
+  /**
+   * Get subscription history and payments
+   * GET /subscriptions/{subscription_id}/history
+   */
+  async getSubscriptionHistory(subscriptionId: string): Promise<{
+    status: string
+    data: Array<{
+      id: string
+      type: 'payment' | 'invoice' | 'refund'
+      amount: number
+      currency: string
+      status: string
+      created: string
+      description?: string
+    }>
+  }> {
+    return this.get(`/subscriptions/${subscriptionId}/history`)
+  }
+}

package/types.ts

@@ -106,3 +106,135 @@ export interface RevokeApiKeyResponse {
   message: string
   revoked_key_id?: string
 }
+
+// Subscription Types
+export interface Subscription {
+  id: string
+  user_id: string
+  status: 'active' | 'canceled' | 'past_due' | 'unpaid' | 'trialing' | 'incomplete' | 'incomplete_expired'
+  metadata: Record<string, any>
+  price_id: string
+  quantity: number
+  cancel_at_period_end: boolean
+  created: string
+  current_period_start: string
+  current_period_end: string
+  ended_at?: string | null
+  cancel_at?: string | null
+  canceled_at?: string | null
+  trial_start?: string | null
+  trial_end?: string | null
+  org_id?: string | null
+}
+
+export interface Product {
+  id: string
+  active: boolean
+  name: string
+  description: string
+  image: string
+  metadata: Record<string, any>
+  marketing_features: string[]
+  live_mode: boolean
+  is_team_plan: boolean
+}
+
+export interface Price {
+  id: string
+  product_id: string
+  active: boolean
+  description: string
+  unit_amount: number
+  currency: string
+  type: 'recurring' | 'one_time'
+  interval: 'day' | 'week' | 'month' | 'year'
+  interval_count: number
+  trial_period_days?: number | null
+  metadata?: Record<string, any> | null
+}
+
+export interface CurrentSubscriptionResponse {
+  status: string
+  data: {
+    subscription: Subscription
+    product: Product
+    price: Price
+  }
+}
+
+export interface UserSubscriptionsResponse {
+  status: string
+  data: Subscription[]
+}
+
+export interface CancelSubscriptionRequest {
+  cancel_at_period_end: boolean
+}
+
+export interface CancelSubscriptionResponse {
+  status: string
+  message: string
+  data: Subscription
+}
+
+// Cancellation Funnel Types
+export interface CancellationFunnelInitiateRequest {
+  subscription_id: string
+}
+
+export interface CancellationFunnelInitiateResponse {
+  status: string
+  message: string
+  data: {
+    funnel_id: string
+    subscription_id: string
+    current_step: 'initiated'
+    created_at: string
+    available_offers: string[]
+  }
+}
+
+export interface CancellationFunnelPauseOfferRequest {
+  subscription_id: string
+  action: 'accepted' | 'declined'
+  pause_duration_months?: number
+}
+
+export interface CancellationFunnelPauseOfferResponse {
+  status: string
+  message: string
+  data: {
+    funnel_id: string
+    subscription_id: string
+    pause_offer: {
+      action: 'accepted' | 'declined'
+      pause_duration_months?: number
+      pause_start_date?: string
+      pause_end_date?: string
+    }
+    next_step: string
+  }
+}
+
+export interface CancellationFunnelSurveyRequest {
+  subscription_id: string
+  reason: string
+  feedback?: string
+  competitor_name?: string
+}
+
+export interface CancellationFunnelSurveyResponse {
+  status: string
+  message: string
+  data: {
+    funnel_id: string
+    subscription_id: string
+    survey_response: {
+      reason: string
+      feedback?: string
+      competitor_name?: string
+      submitted_at: string
+    }
+    next_step: string
+  }
+}