停止订阅
通过内部 ID 或外部 ID 停止活跃订阅。只能停止没有交易数量限制的订阅。
POST /v1/subscription/stop
请求
必须指定订阅的内部 ID (id
) 或外部 ID (external_id
)。
请求参数
字段 | 类型 | 必需 | 描述 |
---|---|---|---|
id | string | 否* | 订阅 ID |
external_id | string | 否* | 外部订阅 ID |
* 必须指定以下参数之一:id
或 external_id
bash
#!/bin/bash
API_TOKEN="your_api_token"
API_SECRET="your_api_secret"
REQUEST_BODY='{
"id": "01k33rz57drtqgqcedyn9tvk04"
}'
# 计算签名
SIGNATURE=$(echo -n "${REQUEST_BODY}${API_SECRET}" | sha256sum | cut -d' ' -f1)
# 执行 API 请求
curl -X POST "https://api.tronzap.com/v1/subscription/stop" \
-H "Authorization: Bearer ${API_TOKEN}" \
-H "X-Signature: ${SIGNATURE}" \
-H "Content-Type: application/json" \
-d "${REQUEST_BODY}"
javascript
const crypto = require('crypto');
const axios = require('axios');
const apiToken = 'your_api_token';
const apiSecret = 'your_api_secret';
const requestBody = JSON.stringify({
id: "01k33rz57drtqgqcedyn9tvk04"
});
// 计算签名
const signature = crypto
.createHash('sha256')
.update(requestBody + apiSecret)
.digest('hex');
// 执行 API 请求
axios({
method: 'post',
url: 'https://api.tronzap.com/v1/subscription/stop',
headers: {
'Authorization': `Bearer ${apiToken}`,
'X-Signature': signature,
'Content-Type': 'application/json'
},
data: requestBody
})
.then(response => console.log(response.data))
.catch(error => console.error(error));
php
<?php
$apiToken = 'your_api_token';
$apiSecret = 'your_api_secret';
$requestBody = json_encode([
'id' => "01k33rz57drtqgqcedyn9tvk04"
]);
// 计算签名
$signature = hash('sha256', $requestBody . $apiSecret);
// 执行 API 请求
$ch = curl_init('https://api.tronzap.com/v1/subscription/stop');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $requestBody);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer ' . $apiToken,
'X-Signature: ' . $signature,
'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
python
import hashlib
import json
import requests
api_token = 'your_api_token'
api_secret = 'your_api_secret'
request_body = json.dumps({
'id': "01k33rz57drtqgqcedyn9tvk04"
})
# 计算签名
signature = hashlib.sha256((request_body + api_secret).encode()).hexdigest()
# 执行 API 请求
headers = {
'Authorization': f'Bearer {api_token}',
'X-Signature': signature,
'Content-Type': 'application/json'
}
response = requests.post(
'https://api.tronzap.com/v1/subscription/stop',
headers=headers,
data=request_body
)
print(response.json())
使用外部 ID 的请求示例
bash
#!/bin/bash
API_TOKEN="your_api_token"
API_SECRET="your_api_secret"
REQUEST_BODY='{
"external_id": "my-subscription-123"
}'
# 计算签名
SIGNATURE=$(echo -n "${REQUEST_BODY}${API_SECRET}" | sha256sum | cut -d' ' -f1)
# 执行 API 请求
curl -X POST "https://api.tronzap.com/v1/subscription/stop" \
-H "Authorization: Bearer ${API_TOKEN}" \
-H "X-Signature: ${SIGNATURE}" \
-H "Content-Type: application/json" \
-d "${REQUEST_BODY}"
javascript
const crypto = require('crypto');
const axios = require('axios');
const apiToken = 'your_api_token';
const apiSecret = 'your_api_secret';
const requestBody = JSON.stringify({
external_id: 'my-subscription-123'
});
// 计算签名
const signature = crypto
.createHash('sha256')
.update(requestBody + apiSecret)
.digest('hex');
// 执行 API 请求
axios({
method: 'post',
url: 'https://api.tronzap.com/v1/subscription/stop',
headers: {
'Authorization': `Bearer ${apiToken}`,
'X-Signature': signature,
'Content-Type': 'application/json'
},
data: requestBody
})
.then(response => console.log(response.data))
.catch(error => console.error(error));
响应
响应包含已停止订阅的信息。
响应字段
字段 | 类型 | 描述 |
---|---|---|
code | integer | 响应代码 (0 = 成功) |
result | object | 响应数据 |
result.id | string | 订阅 ID |
result.subscription_id | string | 订阅类型 ID |
result.created_at | string | 创建日期 (ISO 8601 格式) |
result.stopped_at | string | 停止日期 (ISO 8601 格式) |
result.status | string | 订阅状态 (应为 "stopped") |
result.external_id | string | 外部订阅 ID (如果指定) |
result.params | object | 原始请求参数 |
响应示例
json
{
"code": 0,
"result": {
"id": "01k33rz57drtqgqcedyn9tvk04",
"subscription_id": "energy_monthly_unlimited",
"created_at": "2024-03-22T12:00:00Z",
"stopped_at": "2024-03-25T10:30:00Z",
"status": "stopped",
"external_id": "my-subscription-123",
"params": {
"address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
"duration": 30,
"transactions_limit": 0,
"activate_address": true
}
}
}
可能的错误
错误代码 | 描述 |
---|---|
1 | 认证错误 (无效的令牌或签名) |
2 | 无效的服务或参数 |
20 | 未找到订阅 |
21 | 无法停止订阅 (订阅有交易限制) |
500 | 服务器内部错误 |