Abonelik İptali
Zotlo ile aboneliklerinizi yönetin
Bu API hizmeti, Zotlo aracılığıyla oluşturulan bir aboneliği iptal etmek için kullanılır.
force parametresi 1 değeriyle gönderilirse, abonelik hemen sonlandırılır.
force parametresi sağlanmazsa veya 1'den farklı bir değere sahipse, abone mevcut faturalama döneminin sonuna kadar hizmeti kullanmaya devam edebilir.
Method
POST
Request Parameters
subscriberId: Kullanıcının aboneliği başlatırken kullandığı e-posta ya da telefon numarası bilgisidir.
packageId: Kullanıcıya ait aboneliğinin sorgulanacağı paket id'dir.
cancellationReason: İptal sebebini belirtir.
force: Eğer iptal işleminden sonra abonenin kullanımı hemen sonlandırılmak istenirse bu değer 1 gönderilmelidir. Eğer 0 gönderilir ise abonelik süresi bitene kadar kullanım hakları devam edecektir.
Örnek İstek
Ödeme İşlemleri Raporu servisine istek gönderirken gerekli olan Access Key,Access Secret ve App Id bilgilerine, Zotlo Panel'de yer alan Developer Tools/API Keys sayfasından ulaşabilirsiniz. Bu bilgileri isteğin header'ında göndermeniz gerekmektedir.
POST https://api.zotlo.com/v1/subscription/cancellation HTTP/1.1
AccessKey: ••••••
AccessSecret: ••••••
Content-Type: application/json
ApplicationId: •
Language: ••
{
"subscriberId":"[email protected]",
"cancellationReason":"Not Interest",
"force":0,
"packageId":"zotlo.premium"
}Başarılı Cevap Örneği
Eğer Abonelik Profili Varsa ve İptal Gerçekleştiyse
Başarılı Cevap Parametreleri
The parameters included in the successful response are as follows.
status
Abonelik durumunu belirtir. Aşağıdaki değerleri alabilir:
active : Kullanıcı haklarını kullanmaya devam edebilir.
passive : Kullanıcının hakları sona ermiştir.
grace : Paket yenileme işlemi yapılamamış, ancak kullanıcı belirli bir süre boyunca haklarını kullanmaya devam edebilir.
realStatus
Abonenin gerçek durumunu verir. Eğer kullanıcının hesabı bir şekilde iptal olduysa passive döner. Status değerinden farklı, status kullanıcının son kullanma tarihi gelene kadar active dönmeye devam edecektir.
active : Kullanıcı haklarını kullanmaya devam edebilir.
passive : Kullanıcının hesabı bir şekilde iptal olmuş demektir. Status değerinden farklıdır. Status, kullanıcının son kullanma tarihi gelene kadar active dönmeye devam edecektir.
subscriptionType
Kullanıcının aboneliğinin durumunu belirtir. Aşağıdaki değerleri alabilir:
trial ise abone henüz deneme süresi içerisindedir.
paid ise kullanıcı ücretli süreye geçmiş ve en az bir kere paket ücreti çekilmiş demektir.
startDate
Aboneliğin başladığı tarih bilgisidir.
expireDate
Abonelik bitiş tarihidir. Bu tarihte abonelik yenileme işlemleri yapılır.
package
Aboneliğin bulunduğu paket id bilgisidir.
country
Kullanıcının ülke bilgisidir.
language
Kullanıcının dil bilgisidir.
cancellation
Kullanıcı hesabının iptal olup olmadığı bilgisini verir.
Eğer "null" ise kullanıcı hesabı aktif durumdadır. Eğer array şeklinde gelirse, abonelik iptaline ait detaylara erişilir.
cancellation.date
Abonelik iptal edilme tarihidir.
cancellation.reason
Aboneliğin iptal nedenini belirtir.
cancellation.code
Zotlo tarafından verilen abonelik iptaline ait durum kodudur. Aşağıdaki değerleri alabilir. CP00001 : Kullanıcının hesabında otomatik yenileme yapılamadığı için abonelik iptal edilmiştir. CU00001: Kullanıcı hesabını kendi isteği ile iptal etmiştir. CU00002: İade işleminden sonra sistem tarafından otomatik iptal edilmiştir.
Başarısız Cevap Örneği
Servislerimizden HTTP status code olarak başarılı durumlarda 200 dönmektedir. Başarısız durumlarda ise 400 ya da 500 Http StatusCode dönmektedir. Örnek hata cevabı aşağıdaki şekildedir.
Başarısız Cevap Parametreleri
Başarısız dönen isteklerde yer alan parametreler aşağıdaki gibidir. Başarısız isteklerde hata kodu olarak 400 ya da 500 dönmektedir.
requestId
Zotlo tarafından üretilen ve saklanan benzersiz istek parametresidir.
httpStatus
İlgili cevaba ait HttpStatus kodudur. Standart kodlar olan, 400 ya da 500 dönmektedir.
errorMessage
Alınan hatanın detayıdır. Hata mesajı, gönderdiğiniz dil parametresine göre her dile özel verilmektedir.
404001 : Geçersiz endpoint
401002: AccessKey, AccessSecret parametreleri hatalı.
400008: subscriberId parametresi hatalı.
400009: Subscriber profili bulunamadı.
500000: Sunucu hatası.
errorCode
İlgili hatanın Zotlo'daki hata kodudur. Zotlo'da her hataya özel tekil hata kodları yer almaktadır. Aşağıdaki hata kodlarını alabilir.
404001 : Geçersiz endpoint
401002: AccessKey, AccessSecret parametreleri hatalı.
400008: subscriberId parametresi hatalı.
400009: Kullanıcı profili bulunamadı.
500000: Sunucu hatası.
result
Bu alanın alabileceği değer dinamik olarak değişebilir. Hata durumunda ilgili servisten bir cevap dönerken dolu olarak gelebilir. Aksi durumda ise boş bir obje olarak dönebilir.
Last updated