Abonelik Ürünü
Abonelik çözümü temel olarak planlar üzerine kurulmuştur. Planlar ise ürünlere bağlı olmak zorundadır. Bir ürün oluşturmak için sadece isim (name) parametresini iletmek yeterli olacaktır.
Bir ürün birden fazla ödeme planına sahip olabilir ve hem API hem de iyzico merchant panelinden tüm bu işlemleri yapmak mümkündür.
Ürün adı eşşiz bir değerdir. Birbirinden farklı olacak şekilde sınırsız ürün oluşturmak mümkündür.
Ürünler üzerinde kullanılabilecek 5 farklı metod vardır.
Yeni bir abonelik ürünü oluşturur. Subscription API ödeme planlarına göre tekrarlı ödeme alır ve her ödeme planı en az bir ürüne bağlıdır. Ürün sayısında herhangi bir sınırlama yoktur ve sadece isim bilgisi gönderilerek bir ürün oluşturulabilir.
Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.
İstek gövdesinin içerik tipi.
application/json
iyzico yanıt metinlerinin dili. Varsayılan tr; en desteklenir.
tr
İstek/yanıt eşleşmesi için kullanılabilecek referans değeri.
123456789
Ürün adı.
Kahve Paketi
Ürün açıklaması.
Türk Kahvesi
Başarılı yanıt
Hatalı istek
POST https://api.iyzipay.com/v2/subscription/products
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json
{
"locale": "tr",
"conversationId": "123456789",
"name": "Kahve Paketi",
"description": "Türk Kahvesi"
}
{
"status": "success",
"systemTime": 1755552252594,
"data": {
"referenceCode": "08159c1d-6fe9-4934-8a55-e191bd4119e0",
"createdDate": "2024-10-15 12:24:12",
"name": "Kahve Paketi",
"description": "Türk Kahvesi",
"status": "ACTIVE",
"pricingPlans": []
}
}
Örnek Kodlar
Abonelik ürününü günceller. Bir ürünün isim ve açıklama bilgileri hem API hem de iyzico merchant paneli üzerinden düzenlenebilir. API üzerinden bu işlemi yapabilmek için, ürüne ait eşsiz referans kodu kullanılmalıdır.
Ürüne ait eşsiz referans kodu.
Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.
İstek gövdesinin içerik tipi.
application/json
Yanıt dili (tr/en).
tr
İstek/yanıt eşleştirme değeri.
123456789
Ürüne verilecek yeni isim.
Ürün Güncelleme
Ürüne verilecek yeni açıklama.
Yeni açıklama
Başarılı yanıt
Hatalı istek
POST https://api.iyzipay.com/v2/subscription/products/{productReferenceCode}
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json
{
"locale": "tr",
"conversationId": "123456789",
"name": "Ürün Güncelleme",
"description": "Yeni açıklama"
}
{
"status": "success",
"systemTime": 1755552995773,
"data": {
"referenceCode": "e935ca98-5a8f-4c67-95c9-221eb8edb081",
"createdDate": "2024-10-10 10:09:53",
"name": "Ürün Güncelleme",
"description": "Yeni açıklama",
"status": "ACTIVE",
"pricingPlans": [
{
"referenceCode": "7b0e7912-c1c4-44a6-ac41-403809401458",
"createdDate": "2024-10-10 10:10:11",
"name": "testPlan",
"price": 30,
"paymentInterval": "WEEKLY",
"paymentIntervalCount": 1,
"trialPeriodDays": 30,
"currencyCode": "TRY",
"productReferenceCode": "e935ca98-5a8f-4c67-95c9-221eb8edb081",
"planPaymentType": "RECURRING",
"status": "ACTIVE",
"recurrenceCount": 5
}
]
}
}
Örnek Kodlar
Abonelik ürününü siler. Ürünler kendilerine bağlı herhangi bir plan olmadıkça hem API hem de iyzico merchant panel üzerinden silinebilir.
Ürüne ait eşsiz referans kodu.
Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.
İstek gövdesinin içerik tipi.
application/json
Başarılı yanıt
Hatalı istek
DELETE https://api.iyzipay.com/v2/subscription/products/{productReferenceCode}
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json
{
"status": "success",
"systemTime": 1755553111881
}
Örnek Kodlar
Bir ürünün detaylarına API isteği ile ulaşılabilir. Bunun için gönderilen istekte ürün refereans kodunu belirtmek yeterlidir.
Ürüne ait eşsiz referans kodu.
Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.
İstek gövdesinin içerik tipi.
application/json
Başarılı yanıt
Hatalı istek
GET https://api.iyzipay.com/v2/subscription/products/{productReferenceCode}
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json
{
"status": "success",
"systemTime": 1755552931289,
"data": {
"referenceCode": "e935ca98-5a8f-4c67-95c9-221eb8edb081",
"createdDate": "2024-10-10 10:09:53",
"name": "KingOfProduct",
"description": "DescriptionOfProduct",
"status": "ACTIVE",
"pricingPlans": [
{
"referenceCode": "7b0e7912-c1c4-44a6-ac41-403809401458",
"createdDate": "2024-10-10 10:10:11",
"name": "testPlan",
"price": 30,
"paymentInterval": "WEEKLY",
"paymentIntervalCount": 1,
"trialPeriodDays": 30,
"currencyCode": "TRY",
"productReferenceCode": "e935ca98-5a8f-4c67-95c9-221eb8edb081",
"planPaymentType": "RECURRING",
"status": "ACTIVE",
"recurrenceCount": 5
}
]
}
}
Örnek Kodlar
Abonelik ürünlerini listeler. Ürün listeleme tüm ürünlere ve ürünlere bağlı planlara ulaşmak için kullanılır. Cevap süresini kısaltmak ve cevap boyutunu kısaltmak için sayfalama metodu kullanulmıştır. Bu sayede ürün listesini sayfa sayfa hızlıca alabilirsiniz.
Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.
İstek gövdesinin içerik tipi.
application/json
Belirtilen sayfa için tüm ürünleri getirir.
1
Sayfa başına kaç ürün listeleneceğini belirtir.
20
Başarılı yanıt
Hatalı istek
GET https://api.iyzipay.com/v2/subscription/products
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json
{
"page": 1,
"count": 1
}
{
"status": "success",
"systemTime": 1755552794380,
"data": {
"totalCount": "2",
"currentPage": 1,
"pageCount": 1,
"items": [
{
"referenceCode": "b59fbf3d-5b74-45a3-836e-97f708462a95",
"createdDate": "2024-10-15 12:19:52",
"name": "Kahve Paketi",
"description": "Türk Kahvesi",
"status": "ACTIVE",
"pricingPlans": []
},
{
"referenceCode": "e935ca98-5a8f-4c67-95c9-221eb8edb081",
"createdDate": "2024-10-10 10:09:53",
"name": "KingOfProduct",
"description": "DescriptionOfProduct",
"status": "ACTIVE",
"pricingPlans": [
{
"referenceCode": "7b0e7912-c1c4-44a6-ac41-403809401458",
"createdDate": "2024-10-10 10:10:11",
"name": "testPlan",
"price": 30,
"paymentInterval": "WEEKLY",
"paymentIntervalCount": 1,
"trialPeriodDays": 30,
"currencyCode": "TRY",
"productReferenceCode": "e935ca98-5a8f-4c67-95c9-221eb8edb081",
"planPaymentType": "RECURRING",
"status": "ACTIVE",
"recurrenceCount": 5
}
]
}
]
}
}
Örnek Kodlar
Last updated