Permissions 参考

Stripe Apps 使用权限系统控制对 Stripe API 资源的访问。每个权限必须在应用 manifest 中明确声明,并附有清晰的目的说明。用户在安装应用时批准这些权限。

管理 Permissions

声明 Permissions

stripe-app.json manifest 中添加 permissions:

{
"permissions": [
{
"permission": "customer_read",
"purpose": "Read customer profiles to sync with Brevo contacts"
},
{
"permission": "customer_write",
"purpose": "Update customer metadata with Brevo sync status"
}
]
}

通过 CLI 授予 Permissions

在开发过程中,您可以使用 Stripe CLI 授予 permissions:

Terminal window
# 授予特定权限
stripe apps grant permission "customer_read" \
--purpose "Read customer profiles to sync with Brevo contacts"
# 授予多个权限
stripe apps grant permission "charge_read" \
--purpose "Access payment data for event tracking"
stripe apps grant permission "event_read" \
--purpose "Subscribe to real-time Stripe events"

Permissions 最佳实践

  • 最小必要原则:只请求应用实际使用的权限
  • 清晰目的:编写非技术用户能理解的目的说明
  • 为 read+write 提供理由:如果同时需要读写权限,请在每个目的中说明原因
  • 定期审查:更新应用时移除不再需要的权限

Tip

请求过多权限是应用被拒绝最常见的原因之一。只请求您需要的权限。

按产品分类的 Permissions

核心

资源Permission描述
Accountaccount_read读取账户详情和设置
Accountaccount_write更新账户设置
Balancebalance_read查看账户余额和交易
Customercustomer_read读取客户档案、元数据和支付方式
Customercustomer_write创建、更新或删除客户记录
Eventevent_read读取并订阅账户事件
Filefile_read读取已上传文件和文件链接
Filefile_write上传文件并创建文件链接
Mandatemandate_read读取支付授权
Productproduct_read读取产品目录和价格
Productproduct_write创建、更新或删除产品和价格
Tokentoken_read读取已 tokenize 的支付数据
Webhook Endpointwebhook_endpoint_read读取 webhook endpoint 配置
Webhook Endpointwebhook_endpoint_write创建、更新或删除 webhook endpoints

支付

资源Permission描述
Chargecharge_read读取付款 charges 和退款
Chargecharge_write创建 charges、capture 付款、发起退款
Disputedispute_read读取支付争议和证据
Disputedispute_write提交争议证据并回应争议
Payment Intentpayment_intent_read读取 payment intent 详情和状态
Payment Intentpayment_intent_write创建、确认或取消 payment intents
Payment Methodpayment_method_read读取已保存的支付方式
Payment Methodpayment_method_write将支付方式附加或分离到客户
Payoutpayout_read读取 payout 详情和计划
Payoutpayout_write创建或取消 payouts
Refundrefund_read读取退款详情
Refundrefund_write创建或更新退款
Setup Intentsetup_intent_read读取 setup intent 详情
Setup Intentsetup_intent_write创建或确认 setup intents

账单

资源Permission描述
Couponcoupon_read读取折扣券和促销码
Couponcoupon_write创建、更新或删除优惠券
Credit Notecredit_note_read读取信用票据
Credit Notecredit_note_write创建或作废信用票据
Invoiceinvoice_read读取发票详情、行项目和状态
Invoiceinvoice_write创建、更新、最终确认或作废发票
Invoice Iteminvoice_item_read读取待处理发票项目
Invoice Iteminvoice_item_write创建或删除发票项目
Planplan_read读取订阅计划和价格
Planplan_write创建、更新或删除计划
Priceprice_read读取价格配置
Priceprice_write创建或更新价格
Quotequote_read读取价格报价
Quotequote_write创建、最终确认或接受报价
Subscriptionsubscription_read读取订阅详情、计划和状态
Subscriptionsubscription_write创建、更新或取消订阅
Subscription Schedulesubscription_schedule_read读取订阅计划表
Subscription Schedulesubscription_schedule_write创建、更新或释放订阅计划表
Usage Recordusage_record_read读取计量计费使用记录
Usage Recordusage_record_write为计量计费创建使用记录

Checkout

资源Permission描述
Checkout Sessioncheckout_session_read读取 Checkout Session 详情和行项目
Checkout Sessioncheckout_session_write创建或使 Checkout Sessions 过期
Payment Linkpayment_link_read读取 Payment Link 配置
Payment Linkpayment_link_write创建或更新 Payment Links

Connect

资源Permission描述
Application Feeapplication_fee_read读取应用费详情
Connected Accountconnected_account_read读取关联账户详情
Connected Accountconnected_account_write创建或更新关联账户
Transfertransfer_read读取账户间转账详情
Transfertransfer_write创建到关联账户的转账
Top-uptopup_read读取充值详情
Top-uptopup_write创建 Stripe 余额充值

Issuing

资源Permission描述
Issuing Cardissuing_card_read读取已发行卡片详情
Issuing Cardissuing_card_write创建、更新或停用已发行卡片
Issuing Cardholderissuing_cardholder_read读取持卡人信息
Issuing Cardholderissuing_cardholder_write创建或更新持卡人
Issuing Transactionissuing_transaction_read读取卡片交易详情
Issuing Authorizationissuing_authorization_read读取授权请求
Issuing Authorizationissuing_authorization_write批准或拒绝授权请求
Issuing Disputeissuing_dispute_read读取 issuing 争议
Issuing Disputeissuing_dispute_write创建或提交 issuing 争议

报告

资源Permission描述
Report Runreport_run_read读取报告运行结果
Report Runreport_run_write创建新的报告运行
Report Typereport_type_read读取可用报告类型

税务

资源Permission描述
Tax Calculationtax_calculation_read读取税务计算结果
Tax Calculationtax_calculation_write创建税务计算
Tax Ratetax_rate_read读取税率配置
Tax Ratetax_rate_write创建或更新税率
Tax Registrationtax_registration_read读取税务注册详情

Terminal

资源Permission描述
Terminal Readerterminal_reader_read读取 terminal reader 详情
Terminal Readerterminal_reader_write注册或更新 terminal readers
Terminal Locationterminal_location_read读取 terminal 位置详情
Terminal Locationterminal_location_write创建或更新 terminal 位置

Secret Store

资源Permission描述
Secretsecret_read从 Secret Store 读取 secrets
Secretsecret_write创建、更新或删除 secrets

Tajo Brevo 集成推荐 Permissions

对于 Tajo Brevo 集成应用,以下是推荐的 permissions:

{
"permissions": [
{
"permission": "customer_read",
"purpose": "Sync customer profiles and contact information to Brevo"
},
{
"permission": "customer_write",
"purpose": "Store Brevo contact ID and sync status on customer metadata"
},
{
"permission": "charge_read",
"purpose": "Track purchase events and revenue data for Brevo analytics"
},
{
"permission": "product_read",
"purpose": "Sync product catalog to Brevo for personalized email campaigns"
},
{
"permission": "event_read",
"purpose": "Listen to real-time events to trigger Brevo automation workflows"
},
{
"permission": "invoice_read",
"purpose": "Track invoice events for transactional emails via Brevo"
},
{
"permission": "subscription_read",
"purpose": "Monitor subscription lifecycle for Brevo retention campaigns"
},
{
"permission": "secret_write",
"purpose": "Securely store Brevo API credentials in Stripe Secret Store"
},
{
"permission": "secret_read",
"purpose": "Retrieve stored Brevo API credentials for data sync operations"
},
{
"permission": "webhook_endpoint_write",
"purpose": "Register webhook endpoints for real-time event delivery to Tajo"
}
]
}

Permission 范围

Permissions 可以在不同范围内操作,具体取决于应用是安装在平台账户还是关联账户上:

范围描述
AccountPermissions 适用于安装账户自己的数据
Connected Account对于 Connect 平台,permissions 可以扩展到关联账户

Caution

请求 write permissions 时,请准备好在应用审核期间准确解释应用如何以及何时修改数据。不必要的 write permissions 是被拒绝的常见原因。

Subscribe to updates

developer-docs

Drop your email or phone number — we'll send you what matters next.

AI 助手

你好!关于文档有任何问题都可以问我。

免费开始使用Brevo