Abonelik İptali

Zotlo üzerinden başlatılan aboneliklerin iptali için kullanılan servistir.
POST  https://api.zotlo.com/v1/subscription/cancellation
Servise gönderilen abonenin durumunu sonlandırmak için kullanılır. Eğer servis ile birlikte force parametresi 1 olarak gönderilirse o anda abonelik sonlanır diğer durumlarda bitiş tarihine kadar hesabını kullanmaya devam edebilir.
Profile servisi için gönderilmesi gereken parametreler şunlardır :
Alan
Açıklama
subscriberId
Hesabının iptal edilmek istenildiği abone id'si.
packageId
Hesaba ait iptali gerçekleştirilecek paket id'dir. Gönderilmesi zorunlu alandır.
cancellationReason
Hesabın iptal nedeni.
force
Eğer hesap iptalinden sonra abonenin kullanımı hemen sonlandırmak istiyorsanız bu değeri 1 gönderiniz. Diğer durumlarda abone süresi bitene kadar hesabını kullanmaya devam edecektir..
Örnek İstek
Curl
Php
Java
Python
C#
curl --location --request POST 'https://api.zotlo.com/v1/subscription/cancellation' \
--header 'AccessKey: ***' \
--header 'AccessSecret: ***' \
--header 'Content-Type: application/json' \
--header 'Language: tr' \
--header 'ApplicationId: 2' \
--data-raw '{
	"subscriberId":"Z113331",
	"cancellationReason":"Not Interest",
	"force":0,
        "packageId":"zotlo.premium"
}'
$curl = curl_init();
​
curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.zotlo.com/v1/subscription/cancellation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{\n\t\"subscriberId\":\"Z113331\",\n\t\"cancellationReason\":\"Not Interest\",\n\t\"force\":0,\n    \"packageId\":\"zotlo.premium\"\n}",
  CURLOPT_HTTPHEADER => array(
    "AccessKey: ***",
    "AccessSecret: ***",
    "Content-Type: application/json",
    "Language: tr",
    "ApplicationId: 2"
  ),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n\t\"subscriberId\":\"Z113331\",\n\t\"cancellationReason\":\"Not Interest\",\n\t\"force\":0,\n    \"packageId\":\"zotlo.premium\"\n}");
Request request = new Request.Builder()
  .url("https://api.zotlo.com/v1/subscription/cancellation")
  .method("POST", body)
  .addHeader("AccessKey", "***")
  .addHeader("AccessSecret", "***")
  .addHeader("Content-Type", "application/json")
  .addHeader("Language", "tr")
  .addHeader("ApplicationId", "2")
  .build();
Response response = client.newCall(request).execute();
import requests
​
url = "https://api.zotlo.com/v1/subscription/cancellation"
​
payload = "{\n\t\"subscriberId\":\"Z113331\",\n\t\"cancellationReason\":\"Not Interest\",\n\t\"force\":0,\n    \"packageId\":\"zotlo.premium\"\n}"
headers = {
  'AccessKey': '***',
  'AccessSecret': '***',
  'Content-Type': 'application/json',
  'Language': 'tr',
  'ApplicationId': '2'
}
​
response = requests.request("POST", url, headers=headers, data = payload)
​
print(response.text.encode('utf8'))
var client = new RestClient("https://api.zotlo.com/v1/subscription/cancellation");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("AccessKey", "***");
request.AddHeader("AccessSecret", "***");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Language", "tr");
request.AddHeader("ApplicationId", "2");
request.AddParameter("application/json", "{\n\t\"subscriberId\":\"Z113331\",\n\t\"cancellationReason\":\"Not Interest\",\n\t\"force\":0,\n    \"packageId\":\"zotlo.premium\"\n}",  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
Servis Cevapları
Eğer Abonelik Profili Varsa ve İptal Gerçekleştiyse :
{
    "meta": {
        "requestId": "6d2989e84793-REQ-5f32a93a80310",
        "httpStatus": 200
    },
    "result": {
        "profile": {
            "status": "active",
            "realStatus": "passive",
            "subscriberId": "9",
            "subscriptionType": "paid",
            "startDate": "2020-08-10 21:57:25",
            "expireDate": "2020-09-09 21:57:25",
            "package": "zotlo-premium",
            "country": "TR",
            "phoneNumber": "+905555555555",
            "language": "tr",
            "originalTransactionId": "80397a95-742d-4c74-975e-f740d1909580",
            "cancellation": {
                "date": "2020-08-11 14:20:42",
                "reason": "Not Interest",
                "code": "CU00001"
            },
            "customParameters": {
                "source": "Landing",
            }
        },
        "package": {
            "packageId": "zotlo-premium",
            "price": 3.99,
            "currency": "USD",
            "packageType": "subscription",
            "name": "Zotlo Premium"
        },
        "newPackage": null,
        "card": {
            "cardNumber": "411111******1111",
            "expireDate": "12/20"
        },
        "customer": {
            "id": 1,
            "createDate": "2020-05-13 12:57:36",
            "country": "TR",
            "firstname": "Test",
            "lastname": "Test",
            "email": "[email protected]"
        }
    }
}
Başarılı Cevap Parametreleri
Alan
Açıklama
status
Abonenin durumunu verir. active ya da passive değerlerini alabilir. Aktif ise abone haklarını kullanmaya devam edebilir. passive durumunda abonenin hakları sona ermiştir.
realStatus
Abonenin gerçek durumunu verir. active ya da passive değerlerini alabilir. 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.
subscriptionType
Kullanıcının aboneliğinin durumunu veren parametredir. trial ya da paid değerlerini alır. trial ise abone henüz deneme süresi içerisindedir. paid olduğunda da kullanıcı ücretli süreye geçmiş ve en az bir kere paket ücreti çekilmiş demektir.
startDate
Aboneliğinin başladı tarih
expireDate
Abonelik bitiş tarihi. Bu tarihte abonelik yenileme işlemleri yapılır. Eğer yapılamazsa abonelik sistem tarafından iptal edilir.
package
Aktif aboneliğinin olduğu paket
country
Kullanıcının ülkesi
language
Kullanıcının dili
cancellation
Eğer "null" ise kullanıcı hesabı aktif durumdadır. Eğer array şeklinde gelirse abonelik iptaline ait detaylar dönülür.
cancellation.date
Aboneliğin iptal edildiği tarih
cancellation.reason
Aboneliğin iptal nedeni
cancellation.code
Zotlo tarafından verilen abonelik iptaline ait durum kodudur. Abonelik iptal durum kodlarını aşağıda bulabilirsiniz.
İptal Durum Kodları
Kod
Açıklama
CP00001
Kullanıcının hesabında otomatik yenileme yapılamadığı için hesap 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.
Hata Durumları
Ödeme servislerinden 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.
{
    "meta": {
        "requestId": "MacBook-Pro.local-REQ-5e7da75228368",
        "httpStatus": 400,
        "errorMessage": "Kullanıcı abonelik profili bulunamadı.",
        "errorCode": 400009
    },
    "result": []
}
Cevap
Açıklama
requestId
Her request için sistem tarafından atanan id değeridir. Sistemsel hatalarda loglardan hata yakalamak için kullanılmaktadır.
httpStatus
Hatanın HttpStatusCode değeri
errorMessage
Hata mesajı. Tüm hata kodlarına Hata Kodları menüsünden ulaşabilirsiniz.
errorCode
İlgili hata için Zotlo tarafından verilen hata kodu.

Abonelik Servisleri - Previous

Abonelik Profili Sorgulama

Next - Abonelik Servisleri

Ödeme Listesi

Last modified 10mo ago

Copy link

Outline

Örnek İstek

Servis Cevapları

Başarılı Cevap Parametreleri

İptal Durum Kodları

Hata Durumları