権限リファレンス

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

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 つリクエストすることも必要になります。

リソース	権限	説明
アカウント	`connected_account_read`	Account (アカウント) の読み取りアクセスを許可します
アカウントリンク	`account_link_write`	Account Link (アカウントリンク) へのアクセスを許可します
Apple Pay ドメイン	`apple_pay_domain_read`、`apple_pay_domain_write`	Apple Pay ドメインのリソースへのアクセスを許可します。Apple Payを使用するには、ウェブドメインを Apple に登録する必要があります。詳細については、ドメイン登録をご覧ください。
プラットフォーム手数料	`application_fee_read`、`application_fee_write`	Application Fee (プラットフォーム手数料) へのアクセスを許可します
残高	`balance_read`	Balance (残高) へのアクセスを許可します
残高取引ソース	`balance_transaction_source_read`	Balance Transaction (取引残高) の取得時に `source` 属性を拡張するためのアクセスを許可しますこの権限には、`application_fee_read`、`balance_read`、`transfer_read` の各権限も含まれます
請求クロック	`billing_clock_read`、`billing_clock_write`	テストクロックへのアクセスを許可します
請求メーター	`billing_meter_read`、`billing_meter_write`	請求メーターへのアクセス権を付与する
支払い	`charge_read`、`charge_write`	Charge (支払い) へのアクセスを許可します
Checkout セッション	`checkout_session_read`、`checkout_session_write`	Session (セッション) へのアクセスを許可しますこの権限には、`mandate_read`、`payment_intent_read`、`payment_links_read`、`product_read`、`setup_intent_read`、`sku_read` の各権限も含まれます
設定	`terminal_configuration_read`、`terminal_configuration_write`	Configuration (設定) へのアクセスを許可します
確認トークン	`confirmation_token_read`	確認トークンへの読み取り権限を付与する
確認トークン (クライアント)	`confirmation_token_client_write`	クライアントから取得した確認トークンへの書き込み権限を付与します。
接続トークン	`terminal_connection_token_write`	Connection Token (接続トークン) へのアクセスを許可します
クーポン	`coupon_read`、`coupon_write`	Coupon (クーポン) へのアクセスを許可します
クレジットノート	`credit_note_read`、`credit_note_write`	Credit Note (クレジットノート) へのアクセスを許可しますこの権限には、`invoice_read` 権限も含まれます。
カスタマーポータル	`customer_portal_read`、`customer_portal_write`	カスタマーポータルへのアクセスを許可しますカスタマーポータルを使用してサブスクリプションや決済手段を管理している場合は、`elements_write` もリクエストする必要があります。
顧客	`customer_read`、`customer_write`	Customer (顧客) へのアクセスを許可しますこの権限には、`billing_clock_read` 権限も含まれます。
不審請求の申し立て	`dispute_read`、`dispute_write`	Dispute (不審請求の申請) へのアクセスを許可します
リンクを編集する	`edit_link_write`	Login Link (ログインリンク) へのアクセスを許可します
Elements	`elements_write`	Stripe.js Elements へのアクセスを許可します
エンタイトルメント	`entitlement_read`	エンタイトルメントへのアクセス権を付与する
イベント	`event_read`	Event (イベント) へのアクセスを許可します
ファイル	`file_read`、`file_write`	File (ファイル) へのアクセスを許可します
請求書	`invoice_read`、`invoice_write`	Invoice (インボイス) へのアクセスを許可しますこの権限には、`credit_note_read` 権限も含まれますオンライン請求書ページを使用してインボイスや決済手段を管理している場合は、`elements_write` もリクエストする必要があります。
Issuing オーソリ	`issuing_authorization_read`、`issuing_authorization_write`	Authorization (オーソリ) へのアクセスを許可します
Issuing カード	`issuing_card_read`、`issuing_card_write`	Card (カード) へのアクセスを許可します
Issuing カード保有者	`issuing_cardholder_read`、`issuing_cardholder_write`	Cardholder (カード保有者) へのアクセスを許可します
Issuing の不審請求の申請	`issuing_dispute_read`、`issuing_dispute_write`	Issuing の Dispute (不審請求の申請) へのアクセスを許可します
Issuing 取引	`issuing_transaction_read, issuing_transaction_write`	Transaction (取引) へのアクセスを許可します
場所	`terminal_location_read`、`terminal_location_write`	Location (場所) へのアクセスを許可します
同意書	`mandate_read`、`mandate_write`	Mandate (同意書) へのアクセスを許可します
注文	`order_read`、`order_write`	Order (注文) へのアクセスを許可します
Payment Intent	`payment_intent_read`、`payment_intent_write`	PaymentIntent (支払いインテント) へのアクセスを許可します Stripe.js Elements を使用して PaymentIntent を管理している場合は、`elements_write` もリクエストする必要があります。この権限には、`product_read` 権限と `sku_read` 権限も含まれます。
決済用リンク	`payment_links_read`、`payment_links_write`	Payment Links へのアクセスを許可しますこの権限には、`mandate_read`、`product_read`、`sku_read` の各権限も含まれます。
決済手段	`payment_method_read`、`payment_method_write`	PaymentMethod (支払い方法) へのアクセスを許可しますこの権限には、`source_read` 権限も含まれます
入金	`payout_read`、`payout_write`	Payout (入金) へのアクセスを許可します
プラン	`plan_read`、`plan_write`	Plan (プラン)、Price (価格)、および (暗黙的に) Product (商品）へのアクセスを許可します
プロダクト	`product_read`、`product_write`	Product (商品) へのアクセスを許可します
プロモーションコード	`promotion_code_read`、`promotion_code_write`	Promotion Code (プロモーションコード) へのアクセスを許可します
見積もり	`quote_read`、`quote_write`	Quote (見積もり) へのアクセスを許可しますこの権限には、`sku_read`、`product_read` の各権限も含まれます
リーダー	`terminal_reader_read`、`terminal_reader_write`	Reader (リーダー) へのアクセスを許可します
レポートの実行とレポートの種類	`report_runs_and_report_types_read`	Report Type (レポートタイプ) への読み取りアクセスを許可し、Report Run (レポート実行) の作成を許可します
審査	`review_read`、`review_write`	Review (審査) へのアクセスを許可します
Secret	`secret_write`	Secret (シークレット) へのアクセスを許可します
Setup Intent	`setup_intent_read`、`setup_intent_write`	SetupIntent (支払い方法設定インテント) へのアクセスを許可します Stripe.js Elements を使用して SetupIntent を管理している場合は、`elements_write` もリクエストする必要があります。この権限には、`mandate_read` 権限も含まれます
配送料	`shipping_rate_read`、`shipping_rate_write`	Shipping Rates (配送料金) へのアクセスを許可します
SKU	`sku_read`、`sku_write`	SKU へのアクセスを許可します
ソース	`source_read`、`source_write`	Source (ソース) へのアクセスを許可します
Subscription	`subscription_read`、`subscription_write`	Subscription (サブスクリプション) へのアクセスを許可します
税率	`tax_rate_read`、`tax_rate_write`	Tax Rate (税率) へのアクセスを許可します
税金設定	`tax_settings_read`、`tax_settings_write`、	Tax Setting (Tax の設定) へのアクセスを許可します
税取引	`tax_calculations_and_transactions_read`、`tax_calculations_and_transactions_write`、	Tax Calculation (税額計算)と Tax Transaction (税金取引) へのアクセスを許可します
トークン	`token_read`、`token_write`	Token (トークン) へのアクセスを許可します
トップアップ	`top_up_read`、`top_up_write`	Top-up (トップアップ) へのアクセスを許可します
送金	`transfer_read`、`transfer_write`	Transfer (送金) へのアクセスを許可しますこの権限には、`payout_read`、`payout_write` の各権限も含まれます
使用量の記録	`usage_record_read`、`usage_record_write`	Usage Record (使用状況の記録) へのアクセスを許可します
ユーザーのメールアドレス	`user_email_read`	ユーザーのメールアドレスへのアクセスを許可します
Webhook	`webhook_read`、`webhook_write`	Webhook Endpoint (Webhook エンドポイント) へのアクセスを許可しますほとんどのアプリでは、`webhook_write` を含める必要はありません。代わりに、連結アカウントからのイベントをリッスンするための Webhook を設定します。それでも `webhook_write` が必要な場合は、Stripe サポートにお問い合わせください。

イベントの権限

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

読み込み中...

権限リファレンス

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

権限を管理する

オブジェクトの権限

アカウント

アカウントリンク

Apple Pay ドメイン

プラットフォーム手数料

残高

残高取引ソース

請求クロック

請求メーター

支払い

Checkout セッション

設定

確認トークン

確認トークン (クライアント)

接続トークン

クーポン

クレジットノート

カスタマーポータル

顧客

不審請求の申し立て

リンクを編集する

Elements

エンタイトルメント

イベント

ファイル

請求書

Issuing オーソリ

Issuing カード

Issuing カード保有者

Issuing の不審請求の申請

Issuing 取引

場所

同意書

注文

Payment Intent

決済用リンク

決済手段

入金

プラン

プロダクト

プロモーションコード

見積もり

リーダー

レポートの実行とレポートの種類

審査

Secret

Setup Intent

配送料

SKU

ソース

Subscription

税率

税金設定

税取引

トークン

トップアップ

送金

使用量の記録

ユーザーのメールアドレス

Webhook

イベントの権限

参照情報