{
"id": "<string>",
"object": "subscription",
"customer": "<string>",
"store_id": "<string>",
"currency": "<string>",
"description": "<string>",
"status": "incomplete",
"items": [
{
"id": "<string>",
"price_data": {
"id": "<string>",
"currency": "<string>",
"product": "<string>",
"unit_amount": 123,
"recurring": {
"interval": "day",
"interval_count": 123
}
},
"quantity": 2,
"metadata": {}
}
],
"payment_method_id": "<string>",
"billing_cycle_anchor": 123,
"current_period_start": 123,
"current_period_end": 123,
"canceled_at": 123,
"cancel_at": 123,
"latest_invoice": "<string>",
"latest_invoice_object": {
"id": "<string>",
"object": "invoice",
"subscription_id": "<string>",
"customer": "<string>",
"amount_due": 123,
"amount_paid": 123,
"amount_remaining": 123,
"currency": "<string>",
"status": "open",
"payment_status": "pending",
"billing_reason": "<string>",
"period_start": 123,
"period_end": 123,
"created": 123,
"frequency": "<string>",
"recurring_interval": "day",
"recurring_interval_count": 123,
"payment_id": "<string>",
"paid_at": 123,
"due_date": 123
},
"customer_object": {
"id": "<string>",
"object": "customer",
"merchant_id": "<string>",
"external_customer_id": "<string>",
"email": "jsmith@example.com",
"name": "<string>",
"phone": "<string>",
"default_payment_method": "<string>",
"description": "<string>",
"created": 123
},
"payment_method_object": {
"id": "<string>",
"object": "payment_method",
"customer": "<string>",
"merchant_id": "<string>",
"type": "<string>",
"currency": "<string>",
"chain_type": 123,
"status": "active",
"mandate_id": "<string>",
"metadata": {},
"created": 123
},
"checkout_url": "<string>",
"metadata": {},
"created": 123
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"decline_code": "<string>",
"request_log_url": "<string>",
"charge": "<string>"
},
"request_id": "<string>",
"timestamp": 123
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"decline_code": "<string>",
"request_log_url": "<string>",
"charge": "<string>"
},
"request_id": "<string>",
"timestamp": 123
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"decline_code": "<string>",
"request_log_url": "<string>",
"charge": "<string>"
},
"request_id": "<string>",
"timestamp": 123
}创建订阅
创建一个新的订阅。创建后订阅通常进入 incomplete 状态,需用户在返回的 checkout_url 完成首次授权付款后才进入 active(或 trialing)。请求头中的 Idempotency-Key 为必填幂等键。
{
"id": "<string>",
"object": "subscription",
"customer": "<string>",
"store_id": "<string>",
"currency": "<string>",
"description": "<string>",
"status": "incomplete",
"items": [
{
"id": "<string>",
"price_data": {
"id": "<string>",
"currency": "<string>",
"product": "<string>",
"unit_amount": 123,
"recurring": {
"interval": "day",
"interval_count": 123
}
},
"quantity": 2,
"metadata": {}
}
],
"payment_method_id": "<string>",
"billing_cycle_anchor": 123,
"current_period_start": 123,
"current_period_end": 123,
"canceled_at": 123,
"cancel_at": 123,
"latest_invoice": "<string>",
"latest_invoice_object": {
"id": "<string>",
"object": "invoice",
"subscription_id": "<string>",
"customer": "<string>",
"amount_due": 123,
"amount_paid": 123,
"amount_remaining": 123,
"currency": "<string>",
"status": "open",
"payment_status": "pending",
"billing_reason": "<string>",
"period_start": 123,
"period_end": 123,
"created": 123,
"frequency": "<string>",
"recurring_interval": "day",
"recurring_interval_count": 123,
"payment_id": "<string>",
"paid_at": 123,
"due_date": 123
},
"customer_object": {
"id": "<string>",
"object": "customer",
"merchant_id": "<string>",
"external_customer_id": "<string>",
"email": "jsmith@example.com",
"name": "<string>",
"phone": "<string>",
"default_payment_method": "<string>",
"description": "<string>",
"created": 123
},
"payment_method_object": {
"id": "<string>",
"object": "payment_method",
"customer": "<string>",
"merchant_id": "<string>",
"type": "<string>",
"currency": "<string>",
"chain_type": 123,
"status": "active",
"mandate_id": "<string>",
"metadata": {},
"created": 123
},
"checkout_url": "<string>",
"metadata": {},
"created": 123
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"decline_code": "<string>",
"request_log_url": "<string>",
"charge": "<string>"
},
"request_id": "<string>",
"timestamp": 123
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"decline_code": "<string>",
"request_log_url": "<string>",
"charge": "<string>"
},
"request_id": "<string>",
"timestamp": 123
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"decline_code": "<string>",
"request_log_url": "<string>",
"charge": "<string>"
},
"request_id": "<string>",
"timestamp": 123
}授权
Bearer API Key,例如 Bearer sk_live_xxx。
Unix 时间戳(秒)。必须与服务端时间相差不超过 5 分钟。
防重放随机字符串,长度 16-64 个字符,建议每次请求使用新的 UUID。
使用商户 API Secret 对 {timestamp}.{nonce}.{requestBody} 计算 HMAC-SHA256,结果为小写 hex。GET 请求的 requestBody 为空字符串。
请求头
商户生成的幂等键,最长 128 字符。相同键重试会返回首次创建的订阅对象。
128Unix 时间戳(秒)。必须与服务端时间相差不超过 5 分钟。
防重放随机字符串,长度 16-64 个字符,建议每次请求使用新的 UUID。
16 - 64使用商户 API Secret 对 {timestamp}.{nonce}.{requestBody} 计算 HMAC-SHA256,结果为小写 hex。GET 请求的 requestBody 为空字符串。
请求体
订阅项列表,当前仅支持 1 个元素。
1 elementShow child attributes
Show child attributes
外部客户 ID(商户侧客户标识)。
客户邮箱。
客户手机号。
客户姓名。
255订阅币种。当前仅支持 USD,可省略并由 price_data.currency 决定。
USD, usd 订阅描述。
500用户完成首次付款后的跳转 URL,最长 512 字符。
512用户取消首次付款后的跳转 URL,最长 512 字符。
512试用期结束时间,Unix 秒。与 billing_cycle_anchor 互斥。
账期锚点时间,Unix 秒。与 trial_end 互斥;非试用场景必须为未来时间或当前/过去时间代表立即扣首期。
计划取消时间,Unix 秒。必须为未来时间,且与 iterations 互斥。
运行 N 个周期后自动取消。必须大于 0,且与 cancel_at 互斥。
x >= 1商户自定义元数据。
响应
订阅创建成功;重复使用相同 Idempotency-Key 时返回首次创建的订阅对象。
订阅对象。
订阅 ID。
"subscription"
外部客户 ID。
店铺 ID。
币种。
订阅描述。
订阅状态。
incomplete, trialing, active, past_due, canceled, incomplete_expired 订阅项列表。
Show child attributes
Show child attributes
默认支付方式 ID。
账期锚点,Unix 秒。
当前周期开始,Unix 秒。
当前周期结束,Unix 秒。
取消完成时间,Unix 秒。
计划取消时间,Unix 秒。
最近一张发票 ID。
expand=latest_invoice 时返回完整发票对象。
Show child attributes
Show child attributes
expand=customer 时返回完整客户对象。
Show child attributes
Show child attributes
expand=payment_method 时返回完整支付方式对象。
Show child attributes
Show child attributes
首次付款收银台 URL,仅创建时返回。
商户自定义元数据。
创建时间,Unix 秒。
此页面对您有帮助吗?
