| Name | Type | Description | Notes |
|---|---|---|---|
| mode | \PAYJPV2\Model\CheckoutSessionMode | Checkout Session のモード | 指定できる値 |
| clientReferenceId | string | ID | [optional] |
| customerId | string | 顧客 ID | [optional] |
| customerEmail | string | 顧客オブジェクトを作成する時に使われます。指定されていない場合、顧客にメールアドレスの入力を求めます。すでに顧客のメールアドレスを持っている場合は、このパラメータを使ってあらかじめ情報を入力しておくことが可能です。 | [optional] |
| customerCreation | \PAYJPV2\Model\CustomerCreation | Checkout Session の確定時に Customer を作成するかどうかを指定します。<br> `payment` および `setup` モードでのみ設定可能です。 | [optional] |
| lineItems | \PAYJPV2\Model\LineItemRequest[] | 顧客が購入する商品のリストです。このパラメーターを使用して、1回限りまたは定期的な料金を渡します。 `payment` モードの場合、最大100個のラインアイテムを使用できます。 | [optional] |
| metadata | array<string,mixed> | キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata\">詳細はメタデータのドキュメントを参照してください。</a> | [optional] |
| successUrl | string | 支払いや設定が完了した際に、PAY.JP が顧客をリダイレクトする URL。成功した Checkout Session からの情報をページで使用したい場合は、成功ページのカスタマイズに関するガイドをお読みください。 | [optional] |
| cancelUrl | string | キャンセル時のリダイレクト URL | [optional] |
| currency | \PAYJPV2\Model\Currency | 価格の通貨。現在は `jpy` のみサポートしています。 | [optional] |
| expiresAt | \DateTime | Checkout Session の有効期限が失効する日時 | [optional] |
| locale | \PAYJPV2\Model\Locale | Checkout 画面の表示言語を指定します。 | 指定できる値 |
| paymentMethodTypes | \PAYJPV2\Model\PaymentMethodTypes[] | この PaymentFlow で使用できる支払い方法の種類（カードなど）のリストです。指定しない場合、管理画面で利用可能な状態にしている支払い方法を自動的に表示します。 | [optional] |
| paymentMethodOptions | \PAYJPV2\Model\CheckoutSessionPaymentMethodOptionsRequest | この PaymentFlow の支払い方法の個別設定 | [optional] |
| paymentFlowData | \PAYJPV2\Model\PaymentFlowDataRequest | `payment` モード指定時に PaymentFlow 作成に使用するパラメーター | [optional] |
| submitType | \PAYJPV2\Model\CheckoutSessionSubmitType | Checkout の画面上に表示される送信ボタンなど、ページ上の関連テキストをカスタマイズするために使用されます。<br> `submit_type` は、`payment` モードの Checkout Session でのみ指定できます。未指定時、あるいは `auto` の場合、`pay` が使用されます。 | 指定できる値 |
| setupFlowData | \PAYJPV2\Model\SetupFlowDataRequest | `setup` モードの Checkout Session を作成する際、SetupFlow の作成に渡されるパラメーター | [optional] |
| uiMode | \PAYJPV2\Model\CheckoutSessionUIMode | Checkout Session の UI モード。デフォルトは `hosted` です。 | 指定できる値 |