サブスクリプション

direction: down

style: {
  stroke-width: 2
  font-size: 14
}

Checkout: {
  label: "チェックアウトセッション"
  shape: circle
  style: {
    fill: "#e6f7ff"
    stroke: "#91d5ff"
  }
}

Incomplete: {
  label: "未完了"
  style: {
    fill: "#fffbe6"
    stroke: "#ffe58f"
  }
}

Trialing: {
  label: "トライアル中"
  style: {


<!-- DIAGRAM_IMAGE_START:flowchart:16:9::1765369146 -->
![Subscriptions](assets/diagram/core-concepts-subscriptions-01.ja.jpg)
<!-- DIAGRAM_IMAGE_END -->

<!-- DIAGRAM_IMAGE_START:flowchart:16:9::1765369146 -->
![Subscriptions](assets/diagram/core-concepts-subscriptions-01.ja.jpg)
<!-- DIAGRAM_IMAGE_END -->

fill: "#f6ffed"
    stroke: "#b7eb8f"
  }
}

Active: {
  label: "アクティブ"
  style: {
    fill: "#d4edda"
    stroke: "#28a745"
  }
}

Past-Due: {
  label: "支払い遅延"
  style: {
    fill: "#fff1f0"
    stroke: "#ffccc7"
  }
}

Canceled: {
  label: "キャンセル済み"
  style: {
    fill: "#fafafa"
    stroke: "#d9d9d9"
  }
}

Paused: {
  label: "一時停止中"
  style: {
    fill: "#e6f7ff"
    stroke: "#91d5ff"
  }
}

Checkout -> Incomplete: "支払いの失敗"
Checkout -> Trialing: "トライアルありで成功"
Checkout -> Active: "成功、トライアルなし"

Incomplete -> Active: "支払いの成功"

Trialing -> Active: "トライアル終了"

Active -> Past-Due: "更新の失敗"
Past-Due -> Active: "支払いの成功"
Past-Due -> Canceled: "再試行の失敗"

Active -> Canceled: "ユーザー/管理者によるキャンセル"
Trialing -> Canceled: "ユーザー/管理者によるキャンセル"

Active <-> Paused: "一時停止/再開"

import payment from '@blocklet/payment-js';

async function createSubscriptionCheckout() {
  try {
    const session = await payment.checkout.sessions.create({
      success_url: 'https://example.com/success?session_id={CHECKOUT_SESSION_ID}',
      cancel_url: 'https://example.com/cancel',
      mode: 'subscription',
      line_items: [
        { price_id: 'price_xxx', quantity: 1 } // 定期的な価格IDに置き換えてください
      ],
      subscription_data: {
        trial_period_days: 14, // オプション：14日間の無料トライアル
        metadata: {
          project_id: 'proj_123',
        },
      },
    });
    console.log('チェックアウトセッションが作成されました:', session.url);
    // 顧客を session.url にリダイレクトします
  } catch (error) {
    console.error('チェックアウトセッションの作成中にエラーが発生しました:', error.message);
  }
}

createSubscriptionCheckout();

async function getSubscription(subscriptionId) {
  try {
    const subscription = await payment.subscriptions.retrieve(subscriptionId);
    console.log(`${subscription.id} のステータス: ${subscription.status}`);
    console.log('現在の期間の終了日:', new Date(subscription.current_period_end * 1000));
  } catch (error) {
    console.error('サブスクリプションの取得中にエラーが発生しました:', error.message);
  }
}

getSubscription('sub_xxx'); // 有効なサブスクリプションIDに置き換えてください

async function listActiveSubscriptionsForCustomer(customerId) {
  try {
    const subscriptions = await payment.subscriptions.list({
      customer_id: customerId,
      status: 'active',
      activeFirst: true,
      order: 'created_at:DESC',
    });

    console.log(`顧客 ${customerId} のアクティブなサブスクリプションが ${subscriptions.total} 件見つかりました:`);
    subscriptions.data.forEach(sub => {
      console.log(`- ID: ${sub.id}, ステータス: ${sub.status}`);
    });
  } catch (error) {
    console.error('サブスクリプションのリスト表示中にエラーが発生しました:', error.message);
  }
}

listActiveSubscriptionsForCustomer('cus_xxx'); // 有効な顧客IDに置き換えてください

async function cancelSubscription(subscriptionId) {
  try {
    const subscription = await payment.subscriptions.cancel(subscriptionId, {
      at: 'current_period_end', // サブスクリプションは請求サイクルが終了するまでアクティブなままです。
      // 即時キャンセルするには 'now' を使用します。
      reason: 'cancellation_requested',
      feedback: 'ユーザーはサービスを必要としなくなりました。',
    });
    console.log(`サブスクリプション ${subscription.id} はキャンセルが予定されました。`);
  } catch (error) {
    console.error('サブスクリプションのキャンセル中にエラーが発生しました:', error.message);
  }
}

cancelSubscription('sub_xxx'); // 有効なサブスクリプションIDに置き換えてください

async function manageSubscriptionPause(subscriptionId) {
  try {
    // サブスクリプションを一時停止する
    let subscription = await payment.subscriptions.pause(subscriptionId);
    console.log(`サブスクリプション ${subscription.id} は現在 ${subscription.status} です。`);

    // しばらくしてから再開する
    subscription = await payment.subscriptions.resume(subscriptionId);
    console.log(`サブスクリプション ${subscription.id} は現在 ${subscription.status} です。`);

  } catch (error) {
    console.error('サブスクリプションの一時停止状態の管理中にエラーが発生しました:', error.message);
  }
}

manageSubscriptionPause('sub_xxx'); // 有効なサブスクリプションIDに置き換えてください

async function reportApiUsage(subscriptionItemId) {
  try {
    const usageRecord = await payment.subscriptionItems.createUsageRecord({
      subscription_item_id: subscriptionItemId,
      quantity: 100, // 報告する使用量
      action: 'increment', // 'increment'は既存の使用量に追加し、'set'は上書きします。
      timestamp: Math.floor(Date.now() / 1000), // 使用が発生した時間
    });
    console.log('使用状況レコードが作成されました:', usageRecord.id);
  } catch (error) {
    console.error('使用状況の報告中にエラーが発生しました:', error.message);
  }
}

// subscription_item_idはサブスクリプションオブジェクトで見つけることができます。
reportApiUsage('si_xxx'); // 有効なサブスクリプションアイテムIDに置き換えてください