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.

1. Ürün Oluşturma

2. Ürün Güncelleme

3. Ürün Silme

4. Ürün Detayı

5. Ürün Listeleme

NOT: Bir ürün kendisine bağlı bir plan olmadıkça silinebilir. Eğer bir plana bağlı ürün silinmek istenirse, önce bağlı plan silinmelidir.

Ürün Oluşturma

post

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.

Header parameters

AuthorizationstringRequired

Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.

Content-TypestringRequired

İstek gövdesinin içerik tipi.

Example: application/json

Body

application/json

localestringOptional

iyzico yanıt metinlerinin dili. Varsayılan tr; en desteklenir.

Example: tr

conversationIdstringOptional

İstek/yanıt eşleşmesi için kullanılabilecek referans değeri.

Example: 123456789

namestringRequired

Ürün adı.

Example: Kahve Paketi

descriptionstringOptional

Ürün açıklaması.

Example: Türk Kahvesi

Responses

200

Başarılı yanıt

application/json

400

Hatalı istek

application/json

post

/v2/subscription/products

HTTPcurl

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

PHP

Java

Node.JS

.Net

Ürün Güncelleme

post

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.

Path parameters

productReferenceCodestringRequired

Ürüne ait eşsiz referans kodu.

Header parameters

AuthorizationstringRequired

Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.

Content-TypestringRequired

İstek gövdesinin içerik tipi.

Example: application/json

Body

application/json

localestringOptional

Yanıt dili (tr/en).

Example: tr

conversationIdstringOptional

İstek/yanıt eşleştirme değeri.

Example: 123456789

namestringRequired

Ürüne verilecek yeni isim.

Example: Ürün Güncelleme

descriptionstringOptional

Ürüne verilecek yeni açıklama.

Example: Yeni açıklama

Responses

200

Başarılı yanıt

application/json

400

Hatalı istek

application/json

post

/v2/subscription/products/{productReferenceCode}

HTTPcurl

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

PHP

Java

Node.JS

.Net

Ürün Silme

delete

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.

Path parameters

productReferenceCodestringRequired

Ürüne ait eşsiz referans kodu.

Header parameters

AuthorizationstringRequired

Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.

Content-TypestringRequired

İstek gövdesinin içerik tipi.

Example: application/json

Responses

200

Başarılı yanıt

application/json

400

Hatalı istek

application/json

delete

/v2/subscription/products/{productReferenceCode}

HTTPcurl

DELETE https://api.iyzipay.com/v2/subscription/products/{productReferenceCode}
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "status": "success",
  "systemTime": 1755553111881
}

Örnek Kodlar

PHP

Java

Node.JS

.Net

Ürün Detayı

get

Bir ürünün detaylarına API isteği ile ulaşılabilir. Bunun için gönderilen istekte ürün refereans kodunu belirtmek yeterlidir.

Path parameters

productReferenceCodestringRequired

Ürüne ait eşsiz referans kodu.

Header parameters

AuthorizationstringRequired

Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.

Content-TypestringRequired

İstek gövdesinin içerik tipi.

Example: application/json

Responses

200

Başarılı yanıt

application/json

400

Hatalı istek

application/json

get

/v2/subscription/products/{productReferenceCode}

HTTPcurl

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

PHP

Java

Node.JS

.Net

Ürün Listeleme

get

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.

Header parameters

AuthorizationstringRequired

Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.

Content-TypestringRequired

İstek gövdesinin içerik tipi.

Example: application/json

Body

application/json

pageintegerOptional

Belirtilen sayfa için tüm ürünleri getirir.

Example: 1

countintegerOptional

Sayfa başına kaç ürün listeleneceğini belirtir.

Example: 20

Responses

200

Başarılı yanıt

application/json

400

Hatalı istek

application/json

get

/v2/subscription/products

HTTPcurl

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

PHP

Node.JS

.Net