Detener Suscripción
Detiene una suscripción activa por ID interno o ID externo. Solo se pueden detener suscripciones sin límites de transacciones.
POST /v1/subscription/stop
Solicitud
Debe especificarse el ID de suscripción interno (id
) o el ID externo (external_id
).
Parámetros de Solicitud
Campo | Tipo | Requerido | Descripción |
---|---|---|---|
id | string | No* | ID de suscripción |
external_id | string | No* | ID de suscripción externa |
* Al menos uno de los parámetros debe especificarse: id
o external_id
bash
#!/bin/bash
API_TOKEN="your_api_token"
API_SECRET="your_api_secret"
REQUEST_BODY='{
"id": "01k33rz57drtqgqcedyn9tvk04"
}'
# Calculate signature
SIGNATURE=$(echo -n "${REQUEST_BODY}${API_SECRET}" | sha256sum | cut -d' ' -f1)
# Execute API request
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"
});
// Calculate signature
const signature = crypto
.createHash('sha256')
.update(requestBody + apiSecret)
.digest('hex');
// Execute API request
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"
]);
// Calculate signature
$signature = hash('sha256', $requestBody . $apiSecret);
// Execute API request
$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"
})
# Calculate signature
signature = hashlib.sha256((request_body + api_secret).encode()).hexdigest()
# Execute API request
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())
Ejemplo de solicitud con ID externo
bash
#!/bin/bash
API_TOKEN="your_api_token"
API_SECRET="your_api_secret"
REQUEST_BODY='{
"external_id": "my-subscription-123"
}'
# Calculate signature
SIGNATURE=$(echo -n "${REQUEST_BODY}${API_SECRET}" | sha256sum | cut -d' ' -f1)
# Execute API request
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'
});
// Calculate signature
const signature = crypto
.createHash('sha256')
.update(requestBody + apiSecret)
.digest('hex');
// Execute API request
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));
Respuesta
La respuesta contiene información sobre la suscripción detenida.
Campos de Respuesta
Campo | Tipo | Descripción |
---|---|---|
code | integer | Código de respuesta (0 = éxito) |
result | object | Datos de respuesta |
result.id | string | ID de suscripción |
result.subscription_id | string | ID del tipo de suscripción |
result.created_at | string | Fecha de creación (formato ISO 8601) |
result.stopped_at | string | Fecha de detención (formato ISO 8601) |
result.status | string | Estado de suscripción (debería ser "stopped") |
result.external_id | string | ID de suscripción externa (si se especifica) |
result.params | object | Parámetros de solicitud originales |
Ejemplo de Respuesta
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
}
}
}
Posibles Errores
Código de Error | Descripción |
---|---|
1 | Error de autenticación (token o firma inválida) |
2 | Servicio o parámetros inválidos |
20 | Suscripción no encontrada |
21 | No se puede detener la suscripción (la suscripción tiene límite de transacciones) |
500 | Error interno del servidor |