SQL見るだけクエリ#184 Stripe API 稼働中サブスクリプション一覧と関連するクレジットカードの有効期限を取得

記入日：2023-07-11　編集日：2023-07-11

Stripe API 稼働中サブスクリプション一覧と関連するクレジットカードの有効期限を取得する方法について解説してみようと思います。

サブスク一覧とカードの有効期限を取得

以下のコードは、Stripe APIを使用して稼働中のサブスクリプションとそれに関連するクレジットカードの有効期限を表示するためのPHPスクリプトです。以下にコードの概要と各セクションの解説を示します。

1. Stripeのライブラリと秘密鍵を読み込み

require_once '../vendor/autoload.php';
require_once '../secrets.php';

\Stripe\Stripe::setApiKey($stripeSecretKey);

- require_once 文は、StripeのPHPライブラリと secrets.php ファイルを読み込んでいます。autoload.php ファイルは、Composerを使用してStripeライブラリをインストールした場合に自動的に生成されます。
- \Stripe\Stripe::setApiKey($stripeSecretKey); は、Stripe APIキーを設定しています。$stripeSecretKey 変数には、Stripeのシークレットキーが格納されている必要があります。

2. 稼働中のサブスクリプションのIDを取得

try {
  $subscriptions = \Stripe\Subscription::all([
    'status' => 'active',
    'limit' => 100
  ]);
  
  $subscriptionIds = [];
  
  foreach ($subscriptions->data as $subscription) {
    $subscriptionIds[] = $subscription->id;
  }
  
  echo '稼働中のサブスクID: ' . implode(', ', $subscriptionIds);
} catch (\Stripe\Exception\ApiErrorException $e) {
  echo 'エラー: ' . $e->getMessage();
}

- Subscription::all() メソッドを使用して、status パラメータが 'active' のサブスクリプションを取得しています。limit パラメータは、取得するサブスクリプションの数を制限しています。
- 取得したサブスクリプションのIDを $subscriptionIds 配列に格納しています。
- 最後に、implode() 関数を使用して $subscriptionIds 配列を文字列に変換し、稼働中のサブスクリプションのIDを表示しています。

3. サブスクリプションのクレジットカードの有効期限を表示

foreach ($subscriptionIds as $subscriptionId) {
  try {
    $subscription = \Stripe\Subscription::retrieve($subscriptionId);
    $paymentMethodId = $subscription->default_payment_method;
    
    $paymentMethod = \Stripe\PaymentMethod::retrieve($paymentMethodId);
    $card = $paymentMethod->card;
    
    $expirationMonth = $card->exp_month;
    $expirationYear = $card->exp_year;
    
    echo 'サブスクID: ' . $subscriptionId . '<br>';
    echo 'クレジットカードの有効期限: ' . $expirationMonth . '/' . $expirationYear;
    echo '<br><br>';
  } catch (\Stripe\Exception\ApiErrorException $e) {
    echo 'エラー: ' . $e->getMessage();
  }
}

- foreach ループを使用して、登録された各サブスクリプションに対して以下の処理を行います。
- Subscription::retrieve() メソッドを使用して、サブスクリプションの詳細を取得します。
- サブスクリプションのデフォルト支払い方法のIDを取得します。
- PaymentMethod::retrieve() メソッドを使用して、支払い方法の詳細を取得します。
- クレジットカードの有効期限を取得し、変数に格納します。
- サブスクリプションIDとクレジットカードの有効期限を表示します。

最後に、catch ブロックがあり、Stripe APIからの例外をキャッチしてエラーメッセージを表示しています。