{
"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
}{
"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
}Cancel subscription
Cancel a subscription immediately, or schedule it to cancel at the end of the current billing period.
{
"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
}{
"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, for example Bearer sk_live_xxx.
Unix timestamp in seconds. Must be within 5 minutes of server time.
Replay-protection nonce, 16-64 characters. Use a fresh UUID per request.
Lowercase hex HMAC-SHA256 of {timestamp}.{nonce}.{requestBody} signed with the merchant API Secret. For GET requests, requestBody is an empty string.
请求头
Unix timestamp in seconds. Must be within 5 minutes of server time.
Replay-protection nonce, 16-64 characters. Use a fresh UUID per request.
16 - 64Lowercase hex HMAC-SHA256 of {timestamp}.{nonce}.{requestBody} signed with the merchant API Secret. For GET requests, requestBody is an empty string.
路径参数
Subscription ID.
请求体
响应
Canceled successfully.
Subscription object.
Subscription ID.
"subscription"
External customer ID.
Store ID.
Currency.
Subscription description.
Subscription status.
incomplete, trialing, active, past_due, canceled, incomplete_expired Subscription items.
Show child attributes
Show child attributes
Default payment method ID.
Billing cycle anchor, Unix seconds.
Current period start, Unix seconds.
Current period end, Unix seconds.
Cancellation time, Unix seconds.
Scheduled cancellation time, Unix seconds.
Latest invoice ID.
Full invoice object returned when expand=latest_invoice.
Show child attributes
Show child attributes
Full customer object returned when expand=customer.
Show child attributes
Show child attributes
Full payment method object returned when expand=payment_method.
Show child attributes
Show child attributes
Initial-payment checkout URL, returned on creation.
Merchant metadata.
Creation time, Unix seconds.
此页面对您有帮助吗?
