権限リファレンス

使用可能なイベントと必要な権限のリスト。

Stripe アプリがユーザーデータの読み取りや書き込みを行うには、権限が必要です。これには以下の状況が含まれます。

Stripe API オブジェクトにアクセスする (オブジェクトの権限を参照)
イベントに登録する (イベントの権限を参照)

権限をリクエストするには、アプリマニフェストファイルで permissions 配列に権限をリストします。この配列は、CLI から管理することもできます。アプリをインストールするアカウント管理者はアプリを使用する前に、リストされた権限を受け入れる必要があります。

権限がないアクションをアプリが実行しようとすると、Stripe は無効なリクエストエラーを返すことがあります。

権限を管理する

以下のコマンドを使用すると、stripe-app.json アプリマニフェストファイルの permissions 配列に権限を追加できます。

Command Line
stripe apps grant permission "PERMISSION_NAME" "EXPLANATION"

以下を置き換えます。

PERMISSION_NAME には、権限名が表示されます。以下のセクションで、オブジェクトとイベントの権限名を確認することができます。
EXPLANATION には、アクセス有効化についての説明が表示されます。この説明は、アプリのインストール時にユーザーに表示されます。

アプリケーションに追加する権限ごとにこの手順を繰り返します。

たとえば、customer_read 権限を追加した後のアプリのマニフェストファイルは次のようになります。

stripe-app.json
{
  "id": "com.example.app",
  "version": "1.2.3",
  "name": "Example App",
  "icon": "./example_icon_32.png",
  "permissions": [
    {
      "permission": "customer_read",
      "purpose": "Receive access to the customer’s phone number"
    }
  ],
}

権限の削除には、CLI を使用することもできます。

Command Line
stripe apps revoke permission "PERMISSION_NAME"

オブジェクトの権限

アプリが読み取りまたは書き込みする API オブジェクトごとに、対応する権限を少なくとも 1 つリクエストする必要があります。

API リクエストのレスポンスでオブジェクトを拡張する場合は、拡張する API オブジェクトごとに対応する権限を少なくとも 1 つリクエストすることも必要になります。

商品	リソース	権限	説明

Core	残高	`balance_read`	バランスへのアクセスを付与します。
Core	取引残高ソース	`balance_transaction_source_read`	取引残高の取得時に `ソース`属性を拡張するためのアクセスを許可しますこの権限には、`application_fee_read`、`balance_read`、`transfer_read` の各権限も含まれます。
Core	支払い	`charge_read` `charge_write`	支払いへのアクセスを許可します。
Core	確認トークン (クライアント)	`confirmation_token_client_write`	クライアントから取得した確認トークンへの書き込み権限を付与します。
Core	確認トークン	`confirmation_token_read`	確認トークンへの読み取りアクセスを許可します。
Core	顧客	`customer_read` `customer_write`	顧客へのアクセスを許可します。この権限には、`billing_clock_read` 権限も含まれます。
Core	不審請求の申し立て	`dispute_read` `dispute_write`	不審請求の申し立てへのアクセスを許可します。
Core	Elements	`elements_write`	Stripe.js Elements へのアクセスを許可します。
Core	イベント	`event_read`	イベントへのアクセスを許可します。
Core	ファイル	`file_read` `file_write`	ファイルへのアクセスを許可します。
Core	同意書	`mandate_read` `mandate_write`	同意書へのアクセスを許可します。
Core	支払いインテント	`payment_intent_read` `payment_intent_write`	支払いインテントへのアクセスを付与。 Stripe.js Elements で支払いインテントを管理している場合は、`elements_write` もリクエストする必要があります。この権限には、`product_read` 権限と `sku_read` 権限も含まれます。
Core	Payment Links	`payment_links_read` `payment_links_write`	Payment Links へのアクセスを許可します。この権限には、`mandate_read`、`product_read`、`sku_read` の各権限も含まれます。
Core	決済手段	`payment_method_read` `payment_method_write`	決済手段へのアクセスを付与。この権限には、`source_read` 権限も含まれます
Core	決済手段ドメイン	`payment_method_domain_read` `payment_method_domain_write`	決済手段ドメインへのアクセスを付与。
Core	入金	`payout_read` `payout_write`	入金へのアクセスを許可します。
Core	プロダクト	`product_read` `product_write`	製品へのアクセスを許可します。
Core	Setup Intent	`setup_intent_read` `setup_intent_write`	SetupIntents へのアクセスを許可します。 Stripe.js Elements を使用して SetupIntent を管理している場合は、`elements_write` もリクエストする必要があります。この権限には、`mandate_read` 権限も含まれます。
Core	送料	`shipping_rate_read` `shipping_rate_write`	配送料金へのアクセスを許可します。
Core	ソース	`source_read` `source_write`	ソースへのアクセスを許可します。
Core	トークン	`token_read` `token_write`	トークンへのアクセスを許可します。
決済	Checkout セッション	`checkout_session_read` `checkout_session_write`	セッションへのアクセスを許可します。この権限には、`mandate_read`、`payment_intent_read`、`payment_links_read`、`product_read`、`setup_intent_read`、`sku_read` の各権限も含まれます。
請求書発行・請求管理	テストクロック	`billing_clock_read` `billing_clock_write`	テストクロックへのアクセスを付与。
請求書発行・請求管理	メーター	`billing_meter_read` `billing_meter_write`	メーターへのアクセスを付与。
請求書発行・請求管理	メーターイベント	`billing_meter_event_read` `billing_meter_event_write`	メーターイベントへのアクセスを付与。
請求書発行・請求管理	クーポン	`coupon_read` `coupon_write`	クーポンへのアクセスを許可します。
請求書発行・請求管理	クレジットノート。	`credit_note_read` `credit_note_write`	クレジットノートへのアクセスを許可します。この権限には、`invoice_read` 権限も含まれます。
請求書発行・請求管理	カスタマーポータル	`customer_portal_read` `customer_portal_write`	顧客ポータルへのアクセスを許可します。カスタマーポータルを使用してサブスクリプションや決済手段を管理している場合は、`elements_write` もリクエストする必要があります。
請求書発行・請求管理	エンタイトルメント	`entitlement_read`	エンタイトルメントへのアクセスを許可します。
請求書発行・請求管理	請求書	`invoice_read` `invoice_write`	請求書へのアクセスを許可します。この権限には、`credit_note_read` 権限も含まれます。オンライン請求書ページを使用して請求書や決済手段を管理している場合は、`elements_write` もリクエストする必要があります。 –
請求書発行・請求管理	プラン	`plan_read` `plan_write`	プラン、価格、および (暗黙的に) 製品へのアクセスを許可します。
請求書発行・請求管理	プロモーションコード	`promotion_code_read` `promotion_code_write`	プロモーションコードへのアクセスを許可します。
請求書発行・請求管理	見積もり	`quote_read` `quote_write`	見積もりへのアクセスを許可します。この権限には、`sku_read`、`product_read` の各権限も含まれます。
請求書発行・請求管理	Subscription	`subscription_read` `subscription_write`	サブスクリプションへのアクセスを許可します。
請求書発行・請求管理	税率	`tax_rate_read`, `tax_rate_write`	税率へのアクセスを許可します。
請求書発行・請求管理	使用量の記録	`usage_record_read` `usage_record_write`	使用状況レコードへのアクセスを許可します。
レポート作成	レポートの実行とレポートの種類	`report_runs_and_report_types_read`	レポートタイプへの読み取りアクセスを許可し、レポート実行の作成を許可します。
Connect	アカウント	`connected_account_read`	アカウントの読み取りアクセスを許可します。
Connect	アカウントリンク	`account_link_write`	アカウントリンクへのアクセスを許可します。
Connect	プラットフォーム手数料	`application_fee_read` `application_fee_write`	プラットフォーム手数料へのアクセスを許可します。
Connect	ログインリンク	`edit_link_write`	ログインリンクへのアクセスを許可します。
Connect	トップアップ (資金の追加)	`top_up_read` `top_up_write`	トップアップへのアクセスを許可します。
Connect	送金	`transfer_read` `transfer_write`	送金へのアクセスを許可します。この権限には、`payout_read`、`payout_write` の各権限も含まれます。
カード発行	Issuing オーソリ	`issuing_authorization_read` `issuing_authorization_write`	認証へのアクセスを許可します。
カード発行	Issuing カード	`issuing_card_read` `issuing_card_write`	カードへのアクセスを許可します。
カード発行	Issuing カード保有者	`issuing_cardholder_read` `issuing_cardholder_write`	カード保有者へのアクセスを許可します。
カード発行	Issuing の不審請求の申請	`issuing_dispute_read` `issuing_dispute_write`	発行不審請求の申し立てへのアクセスを許可します。
カード発行	Issuing 取引	`issuing_transaction_read` `issuing_transaction_write`	取引へのアクセスを許可します。
Terminal	設定	`terminal_configuration_read` `terminal_configuration_write`	設定へのアクセスを許可します。
Terminal	接続トークン	`terminal_connection_token_write`	接続トークンへのアクセスを許可します。
Terminal	場所	`terminal_location_read` `terminal_location_write`	拠点へのアクセスを許可します。
Terminal	リーダー	`terminal_reader_read` `terminal_reader_write`	リーダーへのアクセスを許可します。
税金	税金設定	`tax_settings_read` `tax_settings_write`	税設定へのアクセスを許可します。
税金	税取引	`tax_calculations_and_transactions_read` `tax_calculations_and_transactions_write`	税計算と税取引へのアクセスを許可します。
Radar	審査	`review_read` `review_write`	レビューへのアクセスを許可します。
Stripe Apps	Secret	`secret_write`	シークレットへのアクセスを許可します。
Stripe Apps	ユーザーのメールアドレス	`user_email_read`	ユーザーのメールアドレスへのアクセスを許可します。
Webhook	Webhook	`webhook_read` `webhook_write`	Webhook エンドポイントへのアクセスを許可します。ほとんどのアプリでは、`webhook_write` を含める必要はありません。代わりに、連結アカウントからのイベントをリッスンするための Webhook を設定します。それでも `webhook_write` が必要な場合は、Stripe サポートにお問い合わせください。
注文	注文	`order_read` `order_write`	注文へのアクセスを許可します。
注文	SKU	`sku_read` `sku_write`	SKU へのアクセスを許可します。

イベントの権限

アプリが登録するイベントごとに、対応する権限を少なくとも 1 つリクエストする必要があります。

読み込み中...

権限リファレンス

使用可能なイベントと必要な権限のリスト。

権限を管理する

オブジェクトの権限

イベントの権限

参照情報