訂閱項目

interface TSubscriptionItemExpanded {
  id: string; // 訂閱項目的唯一識別碼
  subscription_id: string; // 此項目所屬訂閱的 ID
  price_id: string; // 與此項目關聯的價格 ID
  quantity: number; // 價格的數量
  billing_thresholds: object | null; // 基於用量的計費閾值
  metadata: object | null; // 一組用於附加資訊的鍵值對
  created_at: number; // 建立時間戳
  updated_at: number; // 最後更新時間戳
  price: TPrice; // 展開的 Price 物件
}

const subscriptionItem = await payment.subscriptionItems.create({
  subscription_id: 'sub_xxxxxxxxxxxxxx',
  price_id: 'price_xxxxxxxxxxxxxx',
  quantity: 1,
});

const subscriptionItem = await payment.subscriptionItems.retrieve(
  'si_xxxxxxxxxxxxxx' // 訂閱項目 ID
);

const subscriptionItem = await payment.subscriptionItems.update(
  'si_xxxxxxxxxxxxxx', // 訂閱項目 ID
  {
    quantity: 2,
  }
);

const subscriptionItems = await payment.subscriptionItems.list({
  subscription_id: 'sub_xxxxxxxxxxxxxx',
});

const deletedItem = await payment.subscriptionItems.del(
  'si_xxxxxxxxxxxxxx', // 訂閱項目 ID
  {
    clear_usage: true, // 可選
  }
);

const usageRecord = await payment.subscriptionItems.createUsageRecord({
  subscription_item_id: 'si_xxxxxxxxxxxxxx',
  quantity: 100,
  action: 'increment',
  timestamp: Math.floor(Date.now() / 1000),
});

const summaries = await payment.subscriptionItems.listUsageRecordSummaries({
  subscription_item_id: 'si_xxxxxxxxxxxxxx',
});

interface TUsageRecordSummary {
  invoice_id: string; // 此週期的發票 ID
  subscription_item_id: string;
  total_usage: number; // 此週期的總用量
  period: {
    start: number; // 計費週期開始時間（UNIX 時間戳）
    end: number; // 計費週期結束時間（UNIX 時間戳）
  };
}

const records = await payment.subscriptionItems.listUsageRecords({
  subscription_item_id: 'si_xxxxxxxxxxxxxx',
});

interface TUsageRecord {
  id: string;
  subscription_item_id: string;
  quantity: number;
  timestamp: number; // 記錄的 UNIX 時間戳
  billed: boolean; // 此用量是否已計費
}