権限リファレンス
Stripe アプリがユーザーデータの読み取りや書き込みを行うには、権限が必要です。これには以下の状況が含まれます。
権限をリクエストするには、アプリマニフェストファイルで permissions
配列に権限をリストします。この配列は、CLI から管理することもできます。アプリをインストールするアカウント管理者はアプリを使用する前に、リストされた権限を受け入れる必要があります。
権限がないアクションをアプリが実行しようとすると、Stripe は無効なリクエストエラーを返すことがあります。
権限を管理する
以下のコマンドを使用すると、stripe-app.json
アプリマニフェストファイルの permissions
配列に権限を追加できます。
stripe apps grant permission "PERMISSION_NAME" "EXPLANATION"
以下を置き換えます。
PERMISSION_NAME
: 追加する権限の名前。使用可能な権限の名前をご覧ください。EXPLANATION
: アクセス有効化についての説明。この説明はアプリのインストール時にユーザーに表示されます。
アプリケーションに追加する新たな権限ごとに、このステップを繰り返します。
権限追加後のアプリのマニフェストファイルは以下のようになります。
権限の削除には、CLI を使用することもできます。
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 | Grants access to Apple Pay Domain resources. To use Apple Pay, you need to register your web domains with Apple. See domain registration for more information. |
プラットフォーム手数料 | application_fee_read 、application_fee_write | Application Fee (プラットフォーム手数料) へのアクセスを許可します |
残高 | balance_read | Balance (残高) へのアクセスを許可します |
取引残高ソース |
| Balance Transaction (取引残高) の取得時に この権限には、 |
請求クロック | billing_clock_read 、billing_clock_write | テストクロックへのアクセスを許可します |
支払い | charge_read 、charge_write | Charge (支払い) へのアクセスを許可します |
Checkout セッション |
| Session (セッション) へのアクセスを許可します この権限には、 |
Configuration | terminal_configuration_read , terminal_configuration_write | Grants access to Configurations |
Connection Token | terminal_connection_token_write | Grants access to Connection Tokens |
クーポン | coupon_read 、coupon_write | Coupon (クーポン) へのアクセスを許可します |
クレジットノート |
| Credit Note (クレジットノート) へのアクセスを許可します この権限には次の権限も含まれます: |
カスタマーポータル |
| Grants access to the customer portal If you’re using the customer portal to manage subscriptions or payment methods, you must also request |
顧客 |
| Customer (顧客) へのアクセスを許可します この権限には、 |
不審請求の申請 | dispute_read 、dispute_write | Dispute (不審請求の申請) へのアクセスを許可します |
リンクの編集 | edit_link_write | Login Link (ログインリンク) へのアクセスを許可します |
Elements | elements_write | Stripe.js Elements へのアクセスを許可します |
イベント | event_read | Event (イベント) へのアクセスを許可します |
ファイル | file_read 、file_write | File (ファイル) へのアクセスを許可します |
請求書 |
| Invoice (請求書) へのアクセスを許可します この権限には、 If you’re using the hosted invoice page to manage invoices or payment methods, you must also request |
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 (取引) へのアクセスを許可します |
Location | terminal_location_read , terminal_location_write | Grants access to Locations |
同意書 | mandate_read 、mandate_write | Mandate (同意書) へのアクセスを許可します |
注文 | order_read 、order_write | Order (注文) へのアクセスを許可します |
支払いインテント |
| PaymentIntent (支払いインテント) へのアクセスを許可します If you’re managing PaymentIntents with Stripe.js Elements, you must also request この権限には、 |
決済フォームへのリンク |
| Grants access to Payment Links この権限には、 |
決済手段 |
| PaymentMethod (支払い方法) へのアクセスを許可します この権限には、 |
入金 | payout_read 、payout_write | Payout (入金) へのアクセスを許可します |
プラン | plan_read 、plan_write | Grants access to Plans and Prices |
商品 | product_read 、product_write | Product (商品) へのアクセスを許可します |
プロモーションコード | promotion_code_read , promotion_code_write | Grants access to Promotion Codes |
見積もり |
| Quote (見積もり) へのアクセスを許可します この権限には、 |
Reader | terminal_reader_read , terminal_reader_write | Grants access to Readers |
レポート実行とレポートタイプ | report_runs_and_report_types_read | Report Type (レポートタイプ) への読み取りアクセスを許可し、Report Run (レポート実行) の作成を許可します |
確認 | review_read , review_write | Grants access to Reviews |
シークレット | secret_write | Secret (シークレット) へのアクセスを許可します |
支払い方法設定インテント |
| SetupIntent (支払い方法設定インテント) へのアクセスを許可します If you’re managing SetupIntents with Stripe.js Elements, you must also request この権限には、 |
Shipping rate | shipping_rate_read , shipping_rate_write | Grants access to Shipping Rates |
SKU | sku_read 、sku_write | SKU へのアクセスを許可します |
支払い元 | source_read 、source_write | Source (ソース) へのアクセスを許可します |
サブスクリプション | subscription_read 、subscription_write | Subscription (サブスクリプション) へのアクセスを許可します |
税率 | tax_rate_read 、tax_rate_write | Tax Rate (税率) へのアクセスを許可します |
トークン | token_read 、token_write | Token (トークン) へのアクセスを許可します |
トップアップ (資金の追加) | top_up_read 、top_up_write | Top-up (トップアップ) へのアクセスを許可します |
送金 |
| Transfer (送金) へのアクセスを許可します この権限には、 |
使用状況の記録 | usage_record_read 、usage_record_write | Usage Record (使用状況の記録) へのアクセスを許可します |
ユーザーのメール | user_email_read | ユーザーのメールへのアクセスを許可します |
Webhook | webhook_read | Webhook Endpoint (Webhook エンドポイント) へのアクセスを許可します |
イベントの権限
アプリが登録するイベントごとに、対応する権限を少なくとも 1 つリクエストする必要があります。