
Checkout Sessions API
以编程方式创建 Checkout session。
Preview Checkout
在创建会话前计算价格和税费。
Payment Methods
支持的支付方式和配置。
Integration Guide
集成 Checkout 的分步指南。
通过 Checkout Sessions API 生成的 Checkout 链接不可重复使用。它们会在 24 小时后过期;如果设置了
confirm: true,则会在 15 分钟后过期。请为每位客户和每次支付尝试生成新的 session。Adaptive Currency
Adaptive Currency 允许客户使用偏好的本地货币支付,从而提升信任度和转化率。 启用后,客户会在 Checkout 页面看到货币选择器。价格会按照实时 FX 汇率转换为客户选择的货币。如果产品启用了 Purchasing Power Parity,则会转换经过 PPP 调整的价格,而不是基础价格。如果启用了 Charm Pricing,转换后的金额会舍入为类似 49.99 的整洁尾数。
Adaptive Currency
支持的货币、转换费用和退款处理。
多语言 Checkout
Checkout 支持 22 种语言。客户可以直接在页面上切换语言,UI 文本、标签和系统消息都会进行本地化。
支持的语言
要强制使用特定语言,请在创建 Checkout session 时设置
customization.force_language。详情请参阅 Checkout Sessions API。
自动税费计算
系统会根据客户的账单地址自动计算税费,确保符合 GST、VAT 和销售税要求。 税务规则会在适用时根据客户所在的国家和地区应用。当客户更改国家或更新地址时,税费金额会自动更新。最终的税费明细会在支付前清晰显示。Business Tax ID 支持
对于 B2B 交易,Checkout 允许客户输入其 Business Tax ID(例如 VAT 或 GST 编号)。输入后,系统会实时验证该税号,并自动应用适用的税收豁免或反向征税规则。
折扣码
客户可以使用您在 dashboard 中创建的折扣码或促销码。折扣会即时验证,并显示更新后的价格。 当产品启用 Purchasing Power Parity 后,折扣会应用于经过 PPP 调整的价格,而不是基础价格。
discount_codes 接受一个最多包含 20 个代码的数组,并按顺序叠加使用。单数形式的 discount_code 字段已弃用,但为了向后兼容仍然有效。Discount Codes
创建和管理折扣码。
Validate Discount by Code
使用代码名称查找和验证折扣。
智能地址收集
Checkout 支持灵活的地址输入,在速度、准确性和全球覆盖范围之间取得平衡。选项
最简地址模式
为了最大限度地提高转化率,请启用最简地址收集,以减少 Checkout 阻力。当minimal_address 设置为 true 时,Checkout 仅收集:
- 国家/地区 — 税费确定始终需要
- ZIP/邮政编码 — 仅在销售税、VAT 或 GST 计算需要的地区收集

完整地址收集为默认设置。对于不需要完整账单详情的数字产品和 SaaS 流程,请启用
minimal_address。电话号码收集
控制 Checkout 页面是否显示电话号码字段,以及该字段是否为必填项。自定义字段
通过定义自定义表单字段,在 Checkout 期间收集客户的其他信息。这适用于收集公司名称、团队规模、推荐来源或其他业务特定数据。可用字段类型
示例
客户的回答会自动包含在 webhook payload(
payment.succeeded、subscription.active)以及 API 响应的 custom_field_responses 数组中。每个 Checkout session 最多可以定义 5 个自定义字段。Custom Fields Guide
自定义字段配置和响应访问方式。
隐私政策与条款接受
为确保法律和合规透明度:- Checkout 页面会清晰显示 Privacy Policy 和 Buyer Terms 链接
- 客户必须在完成支付前明确确认这些内容
这有助于满足包括 GDPR 合规在内的全球消费者保护和数据隐私要求。
产品集合
Product Collections 提供统一的 Checkout 体验,让客户可以在一次 Checkout 中查看并选择多个相关产品(例如 Starter、Pro 和 Enterprise 方案)。 使用集合时,集合中的所有有效产品都会显示。第一个产品会被预先选中,客户可以比较选项后再进行选择。Product Collections
创建和管理产品集合。
Checkout Session 配置
使用 Checkout Sessions API 控制 Checkout 行为:支付完成后,客户会被重定向到您的
return_url,并自动附加 query parameters ——包括 payment_id 或 subscription_id、status、email,以及 license_key(如适用)。完整列表请参阅 Checkout Sessions guide。Checkout Sessions API
Checkout session 的完整 API reference。
Checkout Integration Guide
集成 Checkout 的分步指南。
主题自定义
使用customization.theme_config 参数自定义 Checkout 页面外观,使其与您的品牌保持一致。您可以为浅色和深色模式配置颜色、字体、边框圆角和按钮文本。
本节介绍 server-side API,该 API 使用 bg_primary 等属性名称。在 session 上设置的主题适用于 hosted、overlay 和 inline Checkout。Checkout SDK 的 client-side themeConfig 选项使用 bgPrimary 等属性名称,现已弃用。请参阅 Overlay Checkout。

Design & Theme Customization
从 dashboard 直观配置主题,包括预构建主题、排版、颜色和实时预览。
主题配置选项
颜色配置(浅色/深色模式)
每种模式都支持以下颜色属性:所有颜色字段都接受标准 CSS 颜色格式:
- Hex:
#fff、#ffffff、#ffffffff - RGB/RGBA:
rgb(255, 255, 255)、rgba(255, 255, 255, 0.5) - HSL/HSLA:
hsl(120, 100%, 50%)、hsla(120, 100%, 50%, 0.5) - 命名颜色:
red、blue、transparent