💰

【Stripe API × Cloud Functions】プラットフォーム型サービスにサブスクを導入する

2021/06/02に公開

Firebase

はじめに

2021 年の 3 月にリリースした
現役エンジニアとプログラミング学習者のマッチングプラットフォーム、『CodeBoy』ですが、本日より「月額プラン」に対応しました！🙌（以前までは「単発プラン」のみでした）

本記事では、CodeBoy のような「プラットフォーム型サービス」で、サブスクリプションを実装するにあたって詰まったこと、気をつけたことなどを共有できればと思います。

CodeBoy の技術構成

フロントエンド

Flutter Web

バックエンド

Firebase
- Authentication
- Firestore
- Storage
- Hosting
- Functions
- Extensions(Trigger Email)

決済システム

Stripe

それぞれについて詳しく知りたい、という方はKBOY さんの記事をみていただけると全体像が把握できると思います。

サービスの全体像

Customer

顧客。購入者でありお金を支払うユーザー。上の図で緑。
CodeBoy では、「生徒」にあたります。

Platform

その名の通りプラットフォームを提供するサービス。上の図の青。
CodeBoy では、「CodeBoy というサービスそのもの」にあたります。

Connected Account

プラットフォームを利用してサービスを提供し、入金を受ける方。上の図のピンク。
CodeBoy では、「講師」にあたります。

サブスクリプション関連の Stripe リソース

リソース	概要
Product	複数の料金を保存できる場所。CodeBoy では「ConnectAccount（講師）：Product（商品）」が「1:1」の関係になるように設定している。
Price	価格。Products に対して複数設定可能で、請求金額と請求間隔が設定できる。CodeBoy では「月額プラン」にあたる。
Subscription	月額の自動決済。状態を持ち、支払いに関連して状態遷移する。CodeBoy では「月額プランを購入」したタイミングで生まれる。

他にも Invoice や PaymentIntents などの多くのリソースがありますが、今回は「サブスクリプションが成立するまでの流れ」について取り上げるので、以上 3 つを扱います。

サブスクリプションが成立するまでの流れ

Product の作成
Product 内に Price を格納
顧客情報と Price をもとに、Subscription を作成

ひとつずつ解説していきます。

1. Product の作成

まずは Product（複数の Price を格納できる箱）を用意します。
必須パラメータはnameだけです。
コードはこちら（Functions は TypeScript で書いています）

// MARK: - Productを作成する
export const createStripeProduct = functions
  .region("asia-northeast1")
  .https.onCall((data, context) => {
    const stripeAccountId = data.stripeAccountId;

    return stripe.products.create(
      {
        name: stripeAccountId, // Productの名前（必須）
      },
      {
        idempotencyKey: data.idempotencyKey, // べき等性の担保
      }
    );
  });

CodeBoy において「複数の Price を格納するもの」は講師なので、name には講師の ConnectAccount の id を指定しました。（Price 内にも ConnectAccountId は入っているので、実際のところなんでも良いと思いますが、Stripe の管理画面でソートしやすいものにしたほうが良いと思います）
return された Product オブジェクト内にある id は productId として講師データ内に持たせておきます。

また、create メソッドの第 2 引数として渡しているidempotencyKeyは、べき等性を担保するためのパラメータです。
べき等とは、ある操作を 1 回行っても複数回行っても結果が同じであることをいう概念です。つまりidempotencyKeyをつければ、その key がついたリクエストを複数行ったとしても１回だけの処理にしてくれるということです。

すべての stripe のメソッドに対して、追加の引数として渡すとべき等にしてくれます。
特に決済などの重複してはいけない処理には必須かと思われます。

2. Product 内に Price を作成

次に、先程作った Product 内に Price（価格）を格納していきます。

// MARK: - Priceを作成する
export const createStripePrice = functions
  .region("asia-northeast1")
  .https.onCall((data, context) => {
    const amount = data.amount;
    const productionId = data.product;

    return stripe.prices.create(
      {
        unit_amount: amount, // 料金
        currency: "jpy", // 通貨
        recurring: { interval: "month" }, // 請求間隔
        product: productionId, // 保存するProductのid
      },
      {
        idempotencyKey: data.idempotencyKey,
      }
    );
  });

今回指定したのは以下の 4 つです。

料金
通貨
請求間隔
保存する ProductId

請求間隔は「day, week, month, year」から選択することができるので、monthを指定しています。（ニーズがあればプラン作成時に選択できるようにするのも面白いかも知れません）

3. 顧客情報と Price をもとに、Subscription を作成

Product と Price が準備できたので、最後に Subscription を作成します。
Subscription 自体の解説に入る前に、StripeConnect における、3 つの決済種別について簡単に触れておきます。

決済の種別

Stripe には3 種類の決済種別があり、どれを使うかによって、サービスの資金フローが大きく変わります。

↑ の記事で、3 種類それぞれについて非常にわかりやすく解説されているので、ここでの解説は省きますが、
CodeBoy のようにサービス側が資金フローに責任を持つ場合はDestination chargeによる決済が妥当なので、以下の例は Destination charge におけるサブスクリプションであることに注意して下さい。（charge の種類によって少しコードの書き方も違います）

サブスクリプションの作成

// MARK: - Subscriptionを作成する
export const createStripeSubscription = functions
  .region("asia-northeast1")
  .https.onCall((data, context) => {
    const customerId = data.customerId;
    const priceId = data.priceId;
    const stripeAccountId = data.stripeAccountId;

    return stripe.subscriptions.create(
      {
        customer: customerId, // 顧客（生徒）
        items: [
          {
            price: priceId, // 料金
          },
        ],
        application_fee_percent: 10, // プラットフォーム手数料
        transfer_data: {
          destination: stripeAccountId, // 料金を受け取るアカウント（講師）
        },
      },
      {
        idempotencyKey: data.idempotencyKey,
      }
    );
  });

customer

customerには顧客であるユーザーの id を指定します。サービスの内容にもよりますが、CodeBoy ではサインアップと同時にcustomerを create し、その id を Firestore のユーザードキュメント内に保存しています。

items

itemsでは、税率やメタデータなどの詳細設定が可能です。
CodeBoy の場合、特別な設定は特に必要ないので、price の情報だけを渡します。

application_fee_percent

ここでプラットフォーム手数料をパーセンテージで指定します。
CodeBoy は 10％なので 10 を指定。

transfer_data

料金の受取先アカウントを ConnectAccount の id で指定します。

Stripe 管理画面の「顧客」→「定期支払い」から、サブスクリプションが作成されていることが確認出来ます。

まとめ

以上がサブスクリプション作成までの流れです。
作成以降の管理（支払い WebHook イベントに応じた取引データの作成・解約など）については、少しの間サブスクリプションを運用してみてから、別の記事にまとめようと思います。

当方エンジニア歴がまだ 1 年にも満たないひよっこエンジニアなので、もし間違った認識をしていたり、ベターな実装方法があれあばご指摘いただきたいです！🙏

CodeBoy は

手数料が業界最安値の 10％であること（競合他社は 13.6~22％）
講師の質が高い（GitHub などによる審査を行っています）

などが強みです！
現役エンジニアの方はぜひ講師として一緒に盛り上げてくださると嬉しいです！💪

最後までご覧いただき、ありがとうございました！

https://codeboy.jp/

GitHubで編集を提案