Job Runner

Stripe のチェックアウトセッションを作成する

概要

Stripe のチェックアウトセッションを作成します。

チェックアウトセッションは支払いリンクと似ていますが、一回だけ有効で、一度そのセッションから決済すると URL は自動的に無効になります。決済せずに24時間経過した場合も自動的に無効になります。

使い方

事前に Stripe の API キーを発行しておきます。Stripe には初めから用意された「標準キー」というものがありますが、これらは使用せず「制限付きのキー」を発行してください。手順の詳細はStripe のサイト をご覧ください。これは Customine ではなく Stripe の画面での設定になります。

Stripe 側で事前に商品データを登録しておく必要はありません。Customine の「Stripe のチェックアウトセッションを作成する」が自動的に Stripe に商品を登録します。逆に、事前に Stripe に登録済みの商品を kintone のレコードと紐付けたい場合は、Stripe の商品にメタデータを追加し、product_code というキーで商品コードをセットしておいてください。

この「やること」を実行すると、Stripe 上に商品、価格データを登録し、チェックアウトセッションを作成します。

「明細マッピング」にて「商品コード」を指定している場合、Stripe 側にその商品コードの商品が登録済みであれば、Stripe 上の商品データを更新します。そうでない場合は Stripe 上に新たな商品データを追加します。

このアクションを実行し、Stripe 上にチェックアウトセッションが作成されると、アクションの結果としてチェックアウトセッションのIDとURLの組み合わせがセットされます。例えば「Stripe のチェックアウトセッションを作成する」を実行したアクションが1番で、チェックアウトセッションの ID を取り出したい場合は、以下のような式を記述します。

= $1.id

同様に、URL を取り出したい場合は以下のように記述します。商品購入者にはこの URL を伝えることになります。

= $1.url

設定するパラメーター

「Stripe APIキー」「明細になるレコード」「明細マッピング」「通貨単位」「成功URL」を設定します。

Stripe APIキー

事前に発行しておいた API キーを指定します。

Stripe の API キーには「標準キーの公開可能キー」「標準キーのシークレットキー」「制限付きのキー」という3種類のキーがありますが、「制限付きのキー」を使用してください。

この API キーには以下の権限が必要です。

  • Checkout Sessions: 書き込み
  • Files: 書き込み(※商品画像を登録する場合のみ必要で、画像を登録しないならば不要です)
  • Prices: 書き込み
  • Products: 書き込み

明細になるレコード

商品・サービス1つにつき1レコードになるように、レコードを指定します。1つのチェックアウトセッション内に、このレコードの行数分だけ商品明細が作成されます。

このレコードは最低1行以上を含む必要があります。空の場合は実行時にエラーになります。

明細マッピング

明細の詳細情報をマッピング形式で入力します。

マッピングでは式が使用できます。マッピング中の式でフィールドコードを指定した場合は、そのフィールドは「明細になるレコード」のフィールドになります。

以下の要素にマッピングを行います。

  • 「商品コード」
    • これを指定した場合、Stripe に同じ商品コードの商品が登録済みであれば、その商品データを上書き更新します。未登録であれば新規に登録します。
    • 省略した場合は、毎回 Stripe に商品データが新規登録されます。
    • 購入者の画面には表示されません。
  • 「商品名」
    • 購入者の画面上に表示される商品の名前です。
    • 必須です。
  • 「商品説明」
    • 購入者の画面上に表示される商品説明文です。
    • 省略可能です。
  • 「商品画像」
    • 購入者の画面上に表示される商品画像です。
    • 省略可能です。
    • 指定する場合、式で添付ファイルフィールドを指定してください。その添付ファイルフィールドに添付されている最初の画像が商品画像になります。画像以外の添付ファイルは無視されます。
      • 添付ファイルフィールド中の何番目のファイルが商品画像か分かっている場合、その番号を指定することも可能です。例えば2番目のファイルを指定したければ
        = 添付ファイルフィールド[1]
        

        とします。式では番号をゼロからカウントしますので、2番目であれば1を指定します。

    • セットする場合、商品画像は上書きでセットされます。
    • 省略した場合や、指定した添付ファイルフィールドに画像が添付されていない場合は、商品に画像はセットされません。この場合、すでにセット済みの画像は維持されます。
    • カスタマイズの中に、添付ファイルフィールドからファイルを取得するために必要なAPIトークン(「kintone 接続設定を行う」)がセットされている必要があります。通常は、「明細になるレコード」を取得する際に使用したAPIトークンがすでにあるはずなので特に気にする必要はありません。
  • 「単価」
    • このチェックアウトセッションでこの商品を1個あたりいくらで売るかを指定します。
    • 必須です。
    • 通貨単位がドルの場合はセント単位で指定します。例えば 10 USD で販売したい場合は 1000 と指定してください。同様に、ユーロの場合はセントユーロ単位で指定します。
    • 税込み価格で指定します。
  • 「数量」
    • 何個売るのかを指定します。
    • 省略可能です。省略時は1を指定したことになります。
  • 「最大数量」「最小数量」
    • 指定した場合、購入者が購入する数量を変更することができるようになり、選択できる数量の範囲がこの値になります。
    • 省略可能です。最大、最小とも省略した場合は、購入者は数量変更できず「数量」で指定した個数で固定になります。

通貨単位

通貨単位を選択します。円、ドル、ユーロが選択できます。それ以外の通貨には対応していません。

この通貨単位としてドル、ユーロを指定する場合、明細マッピングで単価の単位に注意してください。

成功URL

購入者の支払い処理が成功した後に遷移する画面です。

一般的には「お支払いありがとうございました」のようなメッセージを表示する画面を事前に作成しておき、そのページを指定します。「Stripe の支払いリンクを作成する」の場合は Stripe がこのページを用意してくれていますが、チェックアウトセッションの場合はご自分で用意していただく必要があります。

制限事項

  • 単価、数量など指定可能な数値の範囲、対応している画像の形式は、Stripe の仕様に依存します。
  • リッチエディターフィールドには対応していません。商品名、商品説明でリッチエディターフィールドの値を指定すると、HTMLがそのまま表示されます。
  • 1つの商品に複数の画像を登録することはできません。
  • チェックアウトセッションの有効期限を設定することはできません。Stripe のデフォルトである24時間で固定です。