Ana içeriğe geç

cancel-subscription

POST /api/{team}/gateway/cancel-subscription

Aboneliği iptal eder. İade yapılmaz ve bundan sonra tahsilat yapılmaz.

İptal anındaki durumSonuçGönderilen webhook olayları
Ödenmiş ve bitmemiş bir dönemin içindestatus active kalır, cancelled_at dolar. Dönem bitince status cancelled olur.Hemen cancelled; dönem bitince ended.
Ödenmiş bir dönemin içinde değil (pending, past_due)status hemen cancelled olur.cancelled ve ended.
Zaten iptal edilmişDeğişiklik yapılmaz; güncel hâl döner.Yok.

Webhook'lar yalnızca abonelik webhook_url ile açıldıysa gönderilir. Bkz. Abonelik webhook'u.

Kimlik doğrulama​

X-Api-Key, X-Signature, Content-Type: application/json. Ayrıntılar: Kimlik Doğrulama ve İmza.

İstek​

{
"subscription": {
"token": "5a4b3c2d-1e0f-4a9b-8c7d-6e5f4a3b2c1d"
}
}
AlanTipZorunluAçıklama
subscription.tokenstring (UUID)evetAboneliğin token'ı. Çalışma alanınıza ait olmalıdır.

SDK örnekleri​

use Gurmehub\Odemehub\Request\CancelSubscription;

$subscription = $client->cancelSubscription(new CancelSubscription(subscriptionToken: $token));

$subscription->cancelledAt; // iptal anı
$subscription->endsAt; // ödenmiş dönemin bitişi
$subscription->isCancelled(); // ödenmiş dönem sürüyorsa false

Yanıt​

Ödenmiş dönemin içinde iptal:

{
"result": {
"successful": true,
"message": null
},
"subscription": {
"token": "5a4b3c2d-1e0f-4a9b-8c7d-6e5f4a3b2c1d",
"channel_token": "6f1c2e7a-4b3d-4c8e-9a61-2f5d7b0c3e14",
"channel_reference": "UYELIK-4471",
"status": "active",
"period": "monthly",
"items": [
{ "channel_reference": "PREMIUM-AYLIK", "name": "Premium üyelik", "quantity": 1, "unit_amount": "149.90", "tax_rate": "20.00" }
],
"amount": "149.90",
"currency": "TRY",
"is_test": false,
"starts_at": "2026-09-29T10:15:00.000000Z",
"ends_at": "2026-10-29T10:15:00.000000Z",
"paid_at": "2026-09-29T10:15:00.000000Z",
"cancelled_at": "2026-10-05T08:00:00.000000Z",
"checkout_url": null
}
}

Alanlar: Abonelik nesnesi.

HTTP durum kodları​

KodDurum
200İptal işlendi ya da abonelik zaten iptal edilmişti.
401API anahtarı ya da imza geçersiz.
403Çalışma alanı işlem yapamıyor.
422subscription.token eksik, UUID değil ya da çalışma alanınıza ait değil.

Hatalar​

AlanMesaj
subscription.tokenBu abonelik bulunamadı.