サブスクリプションアイテム

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' // Subscription Item ID
);

const subscriptionItem = await payment.subscriptionItems.update(
  'si_xxxxxxxxxxxxxx', // Subscription Item ID
  {
    quantity: 2,
  }
);

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

const deletedItem = await payment.subscriptionItems.del(
  'si_xxxxxxxxxxxxxx', // Subscription Item ID
  {
    clear_usage: true, // Optional
  }
);

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; // この使用量が請求済みかどうか
}