RevGlance文档

Stripe

使用只读的受限密钥连接 Stripe,然后添加 webhook,让新的付款立即显示。

RevGlance 使用您创建的密钥,通过 Stripe 的 API 读取您的 Stripe 账户。它读取扣款、退款、手续费、争议和订阅,从不扣款、退款或更改任何内容。

开始之前

  • 您需要是 RevGlance 中该业务的所有者或管理员。查看者无法添加数据源。
  • 请使用 受限密钥,而不是您的私密密钥。RevGlance 两者都接受(rk_… 或 sk_…),但受限密钥只能读取您允许的内容。
  • 测试模式的密钥同样可用,方便初次体验。准备就绪后,再用正式密钥连接第二个数据源。

连接

  1. 在 Stripe Dashboard 中,打开 Developers › API keys,选择 Create restricted key,将其命名为 RevGlance。
  2. 为 Balance、Charges、Customers、Disputes、Invoices、Checkout Sessions、Subscriptions 和 Coupons 授予 Read 权限,其余全部保持为 None。
  3. 创建并复制该密钥。它以 rk_live_ 开头。
  4. 将其粘贴到 受限密钥 下,然后选择 连接 Stripe。首次同步会读取您的全部历史数据。

表单需要填写的内容

字段格式示例
受限密钥加密存储rk_live_…

名称 字段为选填项。它用于区分同一业务中的两个 Stripe 账户。

添加 webhook

没有 webhook 时,RevGlance 每小时同步一次 Stripe。有了 webhook,新的付款、退款或取消会在几秒内触发同步排队。

  1. 在 RevGlance 中,打开 设置 › 来源,找到 Stripe 数据源,打开其菜单并选择 Webhook。复制 URL。
  2. 在 Stripe 中,打开 Developers › Webhooks,使用该 URL 添加一个端点。
  3. 选择会改变您数据的事件:charge.succeeded、charge.failed、charge.refunded、charge.dispute.closed、customer.subscription.created、customer.subscription.updated、customer.subscription.deleted 和 invoice.paid。任何事件都可以:每个事件只是触发一次同步。
  4. 复制该端点的 signing secret(whsec_…),在 RevGlance 中将其粘贴到 签名密钥 下并保存。

RevGlance 同步哪些数据

  • 余额交易:每笔扣款、退款、争议和 Stripe 手续费,以 Stripe 结算时的币种计。
  • 失败的扣款,用于失败扣款指标和挽回功能。
  • 所有状态的 订阅,包括其客户、订阅项、折扣和最新发票,用于计算 MRR、方案、试用和取消。如果 Stripe 有取消原因和客户评论,也会一并同步。

首次同步会读取您的全部历史数据。之后每次同步都从上一次同步的三天前开始读取,因此不会漏掉延迟的变更,订阅则每次都完整读取。

Stripe 的计算方式

  • 扣款、退款和 Stripe 的手续费来自您的余额交易,以 Stripe 结算时使用的货币计。
  • 银行卡退款按 Stripe 记录的日期计入。银行付款(ACH、SEPA 和其他本地支付方式)也计入;银行退回的款项会再次减少您的退款。
  • 当 Stripe 收回款项时,争议计为退款;如果您赢得争议,该退款会被取消。Stripe 的争议手续费计为手续费。
  • 订阅和单个项目上的优惠券会从 MRR 中扣除。固定金额优惠券只在其自身货币中计入。
  • 已暂停和未付款的订阅计为流失;逾期订阅在 Stripe 重试银行卡期间继续计入。
  • 扣款、退款和争议按税前计入,税费比例取自其发票或 Checkout Session。如果没有 Checkout Sessions 的读取权限,发票之外销售的税费仍包含在内。
  • 含税价格按最新发票上的税费比例,以税前金额计入 MRR。
  • 暂停收款计为流失,从 RevGlance 首次发现之日起算,因为 Stripe 不提供其日期。

适用于所有服务商的规则,请参阅我们如何计算。

挽回邮件

挽回功能会将失败的订阅付款链接到 Stripe 中对应的未付发票页面,客户可以在那里用新卡付款。如果没有未付发票,则会改为打开 Stripe 客户门户会话。这一备用方式需要在 Stripe 中开启客户门户,并且密钥需要具有写入 Customer portal 会话的权限;否则,邮件会链接到您自己的更新银行卡页面。

故障排除

  • “请粘贴 Stripe 密钥或受限密钥。” 密钥必须以 rk_ 或 sk_ 开头。可发布密钥(pk_)无法读取任何内容。
  • “Stripe refused that key.” 该密钥已被吊销,或缺少对 Balance 的读取权限。
  • “Stripe refused the failed-charge request” 或 “the subscription request”:该密钥无法读取 Charges 或 Subscriptions。付款仍会同步;添加缺少的权限后再次同步即可。