---
title: "订阅申请"
method: POST
path: "/subscription/apply"
---

# 订阅申请

`POST /subscription/apply`

创建订阅订单

## Request body

- object
  - `appId` integer, required — 业务ID（后台获取，需要根据参数currency传递对应的业务ID）
  - `subscriptionOrderId` string, required — 商户订单号(必须保证唯一性，长度不超过48)
  - `amount` string, required — 交易金额（精确到小数点后两位；禁止添加标点符号，例如：","）
  - `name` string — 用户姓名，推荐使用真实姓名，格式：包含firstName和lastName，以空格分割的，示例：John Doe
  - `phone` string, required — 真实手机号（格式参考电话号码格式）
  - `email` string, email — 真实电子邮件
  - `subject` string, required — 订阅标题
  - `body` string — 备注详情
  - `inBankCode` 'CREDIT_CARD' | 'GOOGLE_PAY' | 'APPLE_PAY', required — 支付方式编码，与 paymentMethods 二选一
  - `payType` 'SUBSCRIPTION', required — 支付方式类型
  - `callBackUrl` string, uri, required — 用户支付成功后跳转地址
  - `notifyUrl` string, uri, required — 异步通知地址
  - `country` string, required — 国家
  - `currency` 'USD', required — 币种，目前支持：USD
  - `partnerUserId` string, required — 用户唯一标识（如用户ID userId），用于风控系统，必须真实有效，否则会影响交易。格式要求：数字、大小写字母或常用符号-~!@#$%&*()_。
  - `recurringInterval` 'D' | 'W' | 'M' | 'Y', required — 循环周期类型 D（天）,W（周）,M（月）,Y（年）
  - `recurringIntervalCount` integer, required — 循环周期间隔
  - `recurringMaxNumber` integer, required — 最大循环次数，无论循环周期是哪个，最长时间不能超过三年，到期订阅自动取消
  - `website` string, uri, required — 交易网站
  - `retryTimes` integer, required — 定期扣款失败重试次数，默认为3
  - `cancelUrl` string, uri — 用户取消支付URL，如果传递，用户可在支付页面点击返回到此页面
  - `couponPeriod` integer — 优惠期数(暂时只支持首期优惠与全期优惠，即couponPeriod只能等于1或者等于recurringMaxNumber)
  - `couponAmountPerPeriod` string — 每期优惠金额
  - `sign` string, required — 签名
  - `paymentMethods` string — 支持的支付方式列表，英文逗号分隔，如 CREDIT_CARD,GOOGLE_PAY,APPLE_PAY，与 inBankCode 二选一，暂时仅支持前置组件组合模式使用

## Response `200`

- object
  - `status` string — 状态码
  - `error` string — 错误码
  - `msg` string — 返回信息
  - `data` object
    - `subscriptionOrderId` string — 商户订阅号(必须保证唯一性)
    - `subscriptionNo` string — 平台订阅号
    - `appId` string — 业务ID
    - `subject` string — 支付备注
    - `payType` string — 订阅固定为SUBSCRIPTION
    - `inBankCode` string — 银行编码
    - `amount` string — 金额
    - `payUrl` string — 授权链接
    - `recurringInterval` 'W' | 'M' | 'Y' — 循环周期 W,M,Y
    - `recurringIntervalCount` string — 环周期间隔
    - `status` '-1' | '1' | '2' | '3' | '4' — 订阅状态(-1: 订阅异常, 1: 处理中, 2: 订阅成功, 3: 订阅失败, 4: 订阅取消)
    - `clientToken` string — 在JavaScript Web SDK中使用的客户端令牌(见HaiPaySDK.js)
    - `sign` string — 签名

---

[API](https://skmtc.net/haipay/apis/aed.md) · [All operations](https://skmtc.net/haipay/apis/aed/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/haipay/aed/versions/37b596150f0f/schema)