# Ödeme Planı

## Ödeme Planı Oluşturma

> Belirli bir ürün için yeni bir ödeme planı oluşturur.

```json
{"openapi":"3.0.3","info":{"title":"Subscription Pricing Plan","version":"1.0.0"},"servers":[{"url":"https://api.iyzipay.com","description":"iyzico API"}],"paths":{"/v2/subscription/products/{productReferenceCode}/pricing-plans":{"post":{"summary":"Ödeme Planı Oluşturma","description":"Belirli bir ürün için yeni bir ödeme planı oluşturur.","tags":["Ödeme Planı"],"parameters":[{"$ref":"#/components/parameters/AuthHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"},{"name":"productReferenceCode","in":"path","required":true,"schema":{"type":"string"},"description":"Planın ilişkilendirileceği ürünün referans kodu."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePricingPlanRequest"}}}},"responses":{"200":{"description":"Başarılı yanıt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePricingPlanResponse"}}}},"400":{"description":"Başarısız yanıt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"parameters":{"AuthHeader":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"description":"Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir."},"ContentTypeHeader":{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"},"description":"İstek içeriğinin formatı."}},"schemas":{"CreatePricingPlanRequest":{"type":"object","required":["name","price","currencyCode","paymentInterval","planPaymentType"],"properties":{"name":{"type":"string","description":"Plan adı."},"price":{"type":"decimal","description":"Ödeme periyotlarında karttan çekilecek tutar."},"currencyCode":{"type":"string","enum":["TRY","USD","EUR"],"description":"Para birimi. (Yabancı para biriminde sadece yabancı kart kullanılabilir.)"},"paymentInterval":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","YEARLY"],"description":"Tekrarlı ödemenin alınacağı periyot."},"planPaymentType":{"type":"string","enum":["RECURRING"],"description":"Abonelik tipi."},"paymentIntervalCount":{"type":"integer","description":"Ödeme periodunun hangi sıklıkta olacağını belirler. Örneğin haftalık bir ödeme planı için 2 gönderilirse, ödemeler 2 haftada bir alınır."},"recurrenceCount":{"type":"integer","description":"Kaç kez tekrarlanacağını belirtir (ör. 12 => 12 ay). Gönderilmezse abonelik iptal edilene kadar devam eder."},"trialPeriodDays":{"type":"integer","description":"Gün bazında deneme/ücretsiz kullanım süresi. Gönderilirse ilk ödeme bu sürenin sonunda alınır."},"locale":{"type":"string","enum":["tr","en"],"description":"Yanıt ve hata mesajlarının dili."},"conversationId":{"type":"string","description":"İsteğe özel takip değeri."}}},"CreatePricingPlanResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success","failure"],"description":"İşlem sonucu."},"systemTime":{"type":"integer","description":"İşlem zamanı (epoch ms)."},"data":{"type":"object","properties":{"referenceCode":{"type":"string","description":"Oluşturulan plana ait referans kodu."},"createdDate":{"type":"integer","description":"Plan oluşturulma zamanı (epoch ms)."},"name":{"type":"string","description":"Plan adı."},"productReferenceCode":{"type":"string","description":"Ürün referans kodu."},"price":{"type":"decimal","description":"Abonelik fiyatı."},"currencyCode":{"type":"string","enum":["TRY","USD","EUR"],"description":"Para birimi."},"paymentInterval":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","YEARLY"],"description":"Ödeme aralığı."},"paymentIntervalCount":{"type":"integer","description":"Ödeme periyot sayısı."},"planPaymentType":{"type":"string","enum":["RECURRING"],"description":"Abonelik tipi."},"recurrenceCount":{"type":"integer","description":"Tekrarlama sayısı."},"trialPeriodDays":{"type":"integer","description":"Deneme süresi (gün)."},"status":{"type":"string","enum":["ACTIVE"],"description":"Plan durumu."}}}}},"ErrorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["failure"]},"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"systemTime":{"type":"integer"}}}}}}
```

## Ödeme Planı Güncelleme

> Bu metod sadece \*\*name\*\* ve \*\*trialPeriodDays\*\* parametrelerinin güncellenmesine izin verir. Güncelleme için planın referans kodu path parametresi olarak gönderilmelidir. Güncellemenin hem API hem de iyzico merchant paneli üzerinden yapılması mümkündür. Aktif abonelikler ektilenmez.<br>

```json
{"openapi":"3.0.3","info":{"title":"Subscription Pricing Plan","version":"1.0.0"},"servers":[{"url":"https://api.iyzipay.com","description":"iyzico API"}],"paths":{"/v2/subscription/pricing-plans/{pricingPlanReferenceCode}":{"post":{"summary":"Ödeme Planı Güncelleme","description":"Bu metod sadece **name** ve **trialPeriodDays** parametrelerinin güncellenmesine izin verir. Güncelleme için planın referans kodu path parametresi olarak gönderilmelidir. Güncellemenin hem API hem de iyzico merchant paneli üzerinden yapılması mümkündür. Aktif abonelikler ektilenmez.\n","tags":["Ödeme Planı"],"parameters":[{"$ref":"#/components/parameters/AuthHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"},{"name":"pricingPlanReferenceCode","in":"path","required":true,"schema":{"type":"string"},"description":"Güncellenecek ödeme planının referans kodu."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePricingPlanRequest"}}}},"responses":{"200":{"description":"Başarılı yanıt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePricingPlanResponse"}}}},"400":{"description":"Başarısız yanıt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"parameters":{"AuthHeader":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"description":"Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir."},"ContentTypeHeader":{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"},"description":"İstek içeriğinin formatı."}},"schemas":{"UpdatePricingPlanRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Güncellenmiş plan adı."},"trialPeriodDays":{"type":"integer","description":"Güncellenmiş deneme süresi (gün)."}}},"UpdatePricingPlanResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success","failure"],"description":"İşlem sonucu."},"systemTime":{"type":"integer","description":"İşlem zamanı (epoch ms)."},"data":{"type":"object","properties":{"referenceCode":{"type":"string","description":"Güncellenen planın referans kodu."},"createdDate":{"type":"integer","description":"Plan oluşturulma zamanı (epoch ms)."},"name":{"type":"string","description":"Güncellenmiş plan adı."},"price":{"type":"decimal","description":"Plan fiyatı."},"paymentInterval":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","YEARLY"],"description":"Ödeme aralığı."},"paymentIntervalCount":{"type":"integer","description":"Ödeme periyot sayısı."},"trialPeriodDays":{"type":"integer","description":"Güncellenmiş deneme süresi (gün)."},"currencyCode":{"type":"string","enum":["TRY","USD","EUR"],"description":"Para birimi."},"productReferenceCode":{"type":"string","description":"Ürün referans kodu."},"planPaymentType":{"type":"string","enum":["RECURRING"],"description":"Abonelik tipi."},"status":{"type":"string","enum":["ACTIVE"],"description":"Plan durumu."},"recurrenceCount":{"type":"integer","description":"Tekrarlama sayısı."}}}}},"ErrorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["failure"]},"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"systemTime":{"type":"integer"}}}}}}
```

## Ödeme Planı Detayı Alma

> Bir ödeme planının detaylarını getirir. Üye işyerleri bir planın tüm detaylarını hem merchant panelinden hem de API istekleri üzerinden görebilir.

```json
{"openapi":"3.0.3","info":{"title":"Subscription Pricing Plan","version":"1.0.0"},"servers":[{"url":"https://api.iyzipay.com","description":"iyzico API"}],"paths":{"/v2/subscription/pricing-plans/{pricingPlanReferenceCode}":{"get":{"summary":"Ödeme Planı Detayı Alma","description":"Bir ödeme planının detaylarını getirir. Üye işyerleri bir planın tüm detaylarını hem merchant panelinden hem de API istekleri üzerinden görebilir.","tags":["Ödeme Planı"],"parameters":[{"$ref":"#/components/parameters/AuthHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"},{"name":"pricingPlanReferenceCode","in":"path","required":true,"schema":{"type":"string"},"description":"Ödeme planının referans kodu."}],"responses":{"200":{"description":"Başarılı yanıt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricingPlanDetailResponse"}}}},"400":{"description":"Başarısız yanıt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"parameters":{"AuthHeader":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"description":"Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir."},"ContentTypeHeader":{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"},"description":"İstek içeriğinin formatı."}},"schemas":{"PricingPlanDetailResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success","failure"]},"systemTime":{"type":"integer"},"data":{"$ref":"#/components/schemas/CreatePricingPlanResponse/properties/data"}}},"CreatePricingPlanResponse":{"properties":{"data":{"type":"object","properties":{"referenceCode":{"type":"string","description":"Oluşturulan plana ait referans kodu."},"createdDate":{"type":"integer","description":"Plan oluşturulma zamanı (epoch ms)."},"name":{"type":"string","description":"Plan adı."},"productReferenceCode":{"type":"string","description":"Ürün referans kodu."},"price":{"type":"decimal","description":"Abonelik fiyatı."},"currencyCode":{"type":"string","enum":["TRY","USD","EUR"],"description":"Para birimi."},"paymentInterval":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","YEARLY"],"description":"Ödeme aralığı."},"paymentIntervalCount":{"type":"integer","description":"Ödeme periyot sayısı."},"planPaymentType":{"type":"string","enum":["RECURRING"],"description":"Abonelik tipi."},"recurrenceCount":{"type":"integer","description":"Tekrarlama sayısı."},"trialPeriodDays":{"type":"integer","description":"Deneme süresi (gün)."},"status":{"type":"string","enum":["ACTIVE"],"description":"Plan durumu."}}}}},"ErrorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["failure"]},"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"systemTime":{"type":"integer"}}}}}}
```

## Ödeme Planı Listeleme

> Belirli bir ürüne ait tüm ödeme planlarını listeler. Cevap sayfalar halinde iletilir

```json
{"openapi":"3.0.3","info":{"title":"Subscription Pricing Plan","version":"1.0.0"},"servers":[{"url":"https://api.iyzipay.com","description":"iyzico API"}],"paths":{"/v2/subscription/products/{productReferenceCode}/pricing-plans":{"get":{"summary":"Ödeme Planı Listeleme","description":"Belirli bir ürüne ait tüm ödeme planlarını listeler. Cevap sayfalar halinde iletilir","tags":["Ödeme Planı"],"parameters":[{"$ref":"#/components/parameters/AuthHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"},{"name":"productReferenceCode","in":"path","required":true,"schema":{"type":"string"},"description":"Ürün referans kodu."},{"name":"page","in":"query","schema":{"type":"integer"},"description":"Listelenecek sayfa numarası."},{"name":"count","in":"query","schema":{"type":"integer"},"description":"Sayfa başına kayıt sayısı."}],"responses":{"200":{"description":"Başarılı yanıt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPricingPlanResponse"}}}},"400":{"description":"Başarısız yanıt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"parameters":{"AuthHeader":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"description":"Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir."},"ContentTypeHeader":{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"},"description":"İstek içeriğinin formatı."}},"schemas":{"ListPricingPlanResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success","failure"]},"systemTime":{"type":"integer"},"data":{"type":"object","properties":{"totalCount":{"type":"integer","description":"Toplam kayıt sayısı."},"currentPage":{"type":"integer"},"pageCount":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CreatePricingPlanResponse/properties/data"}}}}}},"CreatePricingPlanResponse":{"properties":{"data":{"type":"object","properties":{"referenceCode":{"type":"string","description":"Oluşturulan plana ait referans kodu."},"createdDate":{"type":"integer","description":"Plan oluşturulma zamanı (epoch ms)."},"name":{"type":"string","description":"Plan adı."},"productReferenceCode":{"type":"string","description":"Ürün referans kodu."},"price":{"type":"decimal","description":"Abonelik fiyatı."},"currencyCode":{"type":"string","enum":["TRY","USD","EUR"],"description":"Para birimi."},"paymentInterval":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","YEARLY"],"description":"Ödeme aralığı."},"paymentIntervalCount":{"type":"integer","description":"Ödeme periyot sayısı."},"planPaymentType":{"type":"string","enum":["RECURRING"],"description":"Abonelik tipi."},"recurrenceCount":{"type":"integer","description":"Tekrarlama sayısı."},"trialPeriodDays":{"type":"integer","description":"Deneme süresi (gün)."},"status":{"type":"string","enum":["ACTIVE"],"description":"Plan durumu."}}}}},"ErrorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["failure"]},"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"systemTime":{"type":"integer"}}}}}}
```

## Ödeme Planı Silme

> Ödeme planı referans kodu kullanılarak, belirtilen ödeme planını siler. Üzerinde aktif abonelik bulunan veya güncelleme (update) kaydı olan ödeme planları silinemez.

```json
{"openapi":"3.0.3","info":{"title":"Subscription Pricing Plan","version":"1.0.0"},"servers":[{"url":"https://api.iyzipay.com","description":"iyzico API"}],"paths":{"/v2/subscription/pricing-plans/{pricingPlanReferenceCode}":{"delete":{"summary":"Ödeme Planı Silme","description":"Ödeme planı referans kodu kullanılarak, belirtilen ödeme planını siler. Üzerinde aktif abonelik bulunan veya güncelleme (update) kaydı olan ödeme planları silinemez.","tags":["Ödeme Planı"],"parameters":[{"$ref":"#/components/parameters/AuthHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"},{"name":"pricingPlanReferenceCode","in":"path","required":true,"schema":{"type":"string"},"description":"Silinecek ödeme planının referans kodu."}],"responses":{"200":{"description":"Başarılı yanıt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePricingPlanResponse"}}}},"400":{"description":"Başarısız yanıt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"parameters":{"AuthHeader":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"description":"Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir."},"ContentTypeHeader":{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"},"description":"İstek içeriğinin formatı."}},"schemas":{"DeletePricingPlanResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success","failure"]},"systemTime":{"type":"integer"}}},"ErrorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["failure"]},"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"systemTime":{"type":"integer"}}}}}}
```