Permissions reference

A list of available events and their required permissions.

A Stripe App needs permission to read or write user data. This includes these situations:

Accessing Stripe API objects—see Object permissions
Subscribing to events—see Event permissions

To request permissions, list them in the permissions array in your app manifest file. You can also manage this array from the CLI. Account administrators that install your app must accept the permissions that you list before using it.

If your app performs an action it lacks permissions for, Stripe might raise an invalid request error.

Manage permissions

You can add a permission to the permissions array in your stripe-app.json app manifest file using the following command:

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

Replace:

PERMISSION_NAME with the permission name. You can find permission names for objects and events in the sections below.
EXPLANATION with an explanation for enabling access. Users see this explanation when they install your app.

Repeat this step for each permission that you want to add to your application.

For example, after you add the customer_read permission, your app manifest file might look like this:

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"
    }
  ],
}

To remove a permission, you can also use the CLI:

Command Line
stripe apps revoke permission "PERMISSION_NAME"

Object permissions

For each API object your app reads or writes, it must request at least one of the corresponding permissions.

If you’re expanding objects in the responses of your API requests, you must also request at least one corresponding permission for each API object you expand.

Product	Resource	Permission	Description

Core	Balance	`balance_read`	Grants access to Balances.
Core	Balance Transaction Source	`balance_transaction_source_read`	Grants access to expand the `source` attribute when retrieving Balance Transactions. This permission also implies the following permissions: `application_fee_read`, `balance_read`, and `transfer_read`.
Core	Charge	`charge_read` `charge_write`	Grants access to Charges.
Core	Confirmation Token (client)	`confirmation_token_client_write`	Grants write access to Confirmation Tokens from the client.
Core	Confirmation Token	`confirmation_token_read`	Grants read access to Confirmation Tokens.
Core	Customer	`customer_read` `customer_write`	Grants access to Customers. This permission also implies the following permission: `billing_clock_read`.
Core	Dispute	`dispute_read` `dispute_write`	Grants access to Disputes.
Core	Elements	`elements_write`	Grants access to Stripe.js Elements.
Core	Event	`event_read`	Grants access to Events.
Core	File	`file_read` `file_write`	Grants access to Files.
Core	Mandate	`mandate_read` `mandate_write`	Grants access to Mandates.
Core	Payment Intent	`payment_intent_read` `payment_intent_write`	Grants access to Payment Intents. If you’re managing Payment Intents with Stripe.js Elements, you must also request `elements_write`. This permission also implies the following permissions: `product_read` and `sku_read`.
Core	Payment Links	`payment_links_read` `payment_links_write`	Grants access to Payment Links. This permission also implies the following permissions: `mandate_read`, `product_read` and `sku_read`.
Core	Payment Method	`payment_method_read` `payment_method_write`	Grants access to Payment Methods. This permission also implies the following permission: `source_read`
Core	Payment Method Domain	`payment_method_domain_read` `payment_method_domain_write`	Grants access to Payment Method Domains.
Core	Payout	`payout_read` `payout_write`	Grants access to Payouts.
Core	Product	`product_read` `product_write`	Grants access to Products.
Core	Setup Intent	`setup_intent_read` `setup_intent_write`	Grants access to SetupIntents. If you’re managing SetupIntents with Stripe.js Elements, you must also request `elements_write`. This permission also implies the following permission: `mandate_read`.
Core	Shipping Rate	`shipping_rate_read` `shipping_rate_write`	Grants access to Shipping Rates.
Core	Source	`source_read` `source_write`	Grants access to Sources.
Core	Token	`token_read` `token_write`	Grants access to Tokens.
Checkout	Checkout Session	`checkout_session_read` `checkout_session_write`	Grants access to Sessions. This permission also implies the following permissions: `mandate_read`, `payment_intent_read`, `payment_links_read`, `product_read`, `setup_intent_read` and `sku_read`.
Billing	Test clock	`billing_clock_read` `billing_clock_write`	Grants access to test clocks.
Billing	Meter	`billing_meter_read` `billing_meter_write`	Grants access to Meters.
Billing	Meter events	`billing_meter_event_read` `billing_meter_event_write`	Grants access to meter events.
Billing	Coupon	`coupon_read` `coupon_write`	Grants access to Coupons.
Billing	Credit note .	`credit_note_read` `credit_note_write`	Grants access to Credit Notes. This permission also implies the following permissions: `invoice_read`.
Billing	Customer portal	`customer_portal_read` `customer_portal_write`	Grants access to the customer portal. If you’re using the customer portal to manage subscriptions or payment methods, you must also request `elements_write`.
Billing	Entitlements	`entitlement_read`	Grants access to Entitlements.
Billing	Invoice	`invoice_read` `invoice_write`	Grants access to Invoices. This permission also implies the following permission: `credit_note_read`. If you’re using the hosted invoice page to manage invoices or payment methods, you must also request `elements_write`. –
Billing	Plan	`plan_read` `plan_write`	Grants access to Plans, Prices, and (implicitly) Products.
Billing	Promotion Code	`promotion_code_read` `promotion_code_write`	Grants access to Promotion Codes.
Billing	Quote	`quote_read` `quote_write`	Grants access to Quotes. This permission also implies the following permissions: `sku_read` and `product_read`.
Billing	Subscription	`subscription_read` `subscription_write`	Grants access to Subscriptions.
Billing	Tax rate	`tax_rate_read`, `tax_rate_write`	Grants access to Tax Rates.
Billing	Usage record	`usage_record_read` `usage_record_write`	Grants access to Usage Records.
Reporting	Report Runs and Report Types	`report_runs_and_report_types_read`	Grants read access to Report Types and allows creation of Report Runs.
Connect	Account	`connected_account_read`	Grants access to read Accounts.
Connect	Account link	`account_link_write`	Grants access to Account Links.
Connect	Application Fee	`application_fee_read` `application_fee_write`	Grants access to Application Fees.
Connect	Login link	`edit_link_write`	Grants access to Login Links.
Connect	Top-up	`top_up_read` `top_up_write`	Grants access to Top-ups.
Connect	Transfer	`transfer_read` `transfer_write`	Grants access to Transfers. This permission also implies the following permission: `payout_read` and `payout_write`.
Issuing	Issuing authorization	`issuing_authorization_read` `issuing_authorization_write`	Grants access to Authorizations.
Issuing	Issuing card	`issuing_card_read` `issuing_card_write`	Grants access to Cards.
Issuing	Issuing cardholder	`issuing_cardholder_read` `issuing_cardholder_write`	Grants access to Cardholders.
Issuing	Issuing dispute	`issuing_dispute_read` `issuing_dispute_write`	Grants access to Issuing Disputes.
Issuing	Issuing transaction	`issuing_transaction_read` `issuing_transaction_write`	Grants access to Transactions.
Terminal	Configuration	`terminal_configuration_read` `terminal_configuration_write`	Grants access to Configurations.
Terminal	Connection Token	`terminal_connection_token_write`	Grants access to Connection Tokens.
Terminal	Location	`terminal_location_read` `terminal_location_write`	Grants access to Locations.
Terminal	Reader	`terminal_reader_read` `terminal_reader_write`	Grants access to Readers.
Tax	Tax settings	`tax_settings_read` `tax_settings_write`	Grants access to Tax Settings.
Tax	Tax transaction	`tax_calculations_and_transactions_read` `tax_calculations_and_transactions_write`	Grants access to Tax Calculations and Transactions.
Radar	Review	`review_read` `review_write`	Grants access to Reviews.
Stripe Apps	Secret	`secret_write`	Grants access to Secrets.
Stripe Apps	User Email	`user_email_read`	Grants access to user emails.
Webhooks	Webhook	`webhook_read` `webhook_write`	Grants access to Webhook Endpoints. For most apps, you don’t need to include`webhook_write`. Instead, set up a webhook to listen to events from your connected accounts. If you still need `webhook_write`, contact Stripe Support.
Orders	Order	`order_read` `order_write`	Grants access to Orders.
Orders	SKU	`sku_read` `sku_write`	Grants access to SKUs.

Event permissions

For each Event your app subscribes to, it must request at least one of the corresponding permissions.

Permissions reference

A list of available events and their required permissions.

Manage permissions

Object permissions

Event permissions

See also