GitHubFeedback FormAPI Reference - Beta

Ödeme Planı

Abonelik sistemi varsayılan olarak belirtilen plan doğrultusunda çalışır. Ödeme planı tekrarlı ödeme için gerekli tüm özelliklerin belirtildiği adımdır.

Planlar eşsiz bir isim alır ve bir plan sadece bir ürüne bağlanabilir. Eğer bir plan aktif olarak bir aboneliğe bağlıysa bu plan silinemez.

Planlar üzerinde kullanılabilecek 5 farklı metod vardır.

  1. Ödeme Planı Oluşturma

  2. Ödeme Planı Güncelleme

  3. Ödeme Planı Silme

  4. Ödeme Planı Detayı

  5. Ödeme Planı Listeleme

Bir plan oluşturmak için, ürün referans numarası, isim, fiyat, para birimi, ödeme periyodu gibi aşağıda detayları paylaşılan parametrelerlerin gönderilmesi gerekir.

Bir aboneliğin deneme sürecinin olması istenirse trialPeriodDays parametresi kullanılabilir. Eğer bu parametre gönderilirse, belirtilen değer süresince abonelik başlatılmaz ve karttan hiçbir şekilde ödeme alınmaz.

İstekte belirtilen Payment Interval parametresi ödeme periyodunu belirtir. Bir plan oluştururken “WEEKLY” parametresi gönderilirse, iyzico belirtilen tutarı her hafta karttan çekecektir. Bu periyodun özelleştirilmesi de mümkündür. Örneğin ödemenin 2 haftada bir alınmasını isterseniz, PaymentInterval değerini “WEEKLY” ve paymentIntervalCount değerini 2 olarak göndermeniz gerekmektedir.

NOT : planPaymentType parametresi zorunludur ve şu an için sadece RECURRING değerini alabilir.

Ödeme Planı Oluşturma

post

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

Path parameters
productReferenceCodestringRequired

Planın ilişkilendirileceği ürünün referans kodu.

Header parameters
AuthorizationstringRequired

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

Content-TypestringRequired

İstek içeriğinin formatı.

Example: application/json
Body
namestringRequired

Plan adı.

pricedecimalRequired

Ödeme periyotlarında karttan çekilecek tutar.

currencyCodestring · enumRequired

Para birimi. (Yabancı para biriminde sadece yabancı kart kullanılabilir.)

Possible values:
paymentIntervalstring · enumRequired

Tekrarlı ödemenin alınacağı periyot.

Possible values:
planPaymentTypestring · enumRequired

Abonelik tipi.

Possible values:
paymentIntervalCountintegerOptional

Ö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.

Example: 2
recurrenceCountintegerOptional

Kaç kez tekrarlanacağını belirtir (ör. 12 => 12 ay). Gönderilmezse abonelik iptal edilene kadar devam eder.

Example: 12
trialPeriodDaysintegerOptional

Gün bazında deneme/ücretsiz kullanım süresi. Gönderilirse ilk ödeme bu sürenin sonunda alınır.

Example: 10
localestring · enumOptional

Yanıt ve hata mesajlarının dili.

Possible values:
conversationIdstringOptional

İsteğe özel takip değeri.

Responses
200

Başarılı yanıt

application/json
post
POST https://api.iyzipay.com/v2/subscription/products/8d562f84-f8d5-441a-b086-9483fc5133a0/pricing-plans
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "locale": "tr",
  "conversationId": "conv-001",
  "name": "Aylık Plan",
  "recurrenceCount": 12,
  "planPaymentType": "RECURRING",
  "trialPeriodDays": 0,
  "paymentIntervalCount": 1,
  "paymentInterval": "MONTHLY",
  "currencyCode": "TRY",
  "price": 99.99
}

{
  "status": "success",
  "systemTime": 1755561449951,
  "data": {
    "referenceCode": "08159c1d-6fe9-4934-8a55-e191bd4119e0",
    "createdDate": 1755552252531,
    "name": "Aylık Plan",
    "productReferenceCode": "8d562f84-f8d5-441a-b086-9483fc5133a0",
    "price": 99.99,
    "currencyCode": "TRY",
    "paymentInterval": "MONTHLY",
    "paymentIntervalCount": 1,
    "planPaymentType": "RECURRING",
    "recurrenceCount": 12,
    "trialPeriodDays": 0,
    "status": "ACTIVE"
  }
}

Örnek Kodlar

PHP

Java

.Net

Node.Js

Ödeme Planı Güncelleme

post

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.

Path parameters
pricingPlanReferenceCodestringRequired

Güncellenecek ödeme planının referans kodu.

Header parameters
AuthorizationstringRequired

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

Content-TypestringRequired

İstek içeriğinin formatı.

Example: application/json
Body
namestringRequired

Güncellenmiş plan adı.

trialPeriodDaysintegerOptional

Güncellenmiş deneme süresi (gün).

Responses
200

Başarılı yanıt

application/json
post
POST https://api.iyzipay.com/v2/subscription/pricing-plans/7515f763-5da3-4a35-8f7f-d425ae44ac04
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "name": "Güncel Plan",
  "trialPeriodDays": 5
}

{
  "status": "success",
  "systemTime": 1755587559228,
  "data": {
    "referenceCode": "7515f763-5da3-4a35-8f7f-d425ae44ac04",
    "createdDate": 1755587137033,
    "name": "Güncel Plan",
    "price": 99.99,
    "paymentInterval": "MONTHLY",
    "paymentIntervalCount": 1,
    "trialPeriodDays": 5,
    "currencyCode": "TRY",
    "productReferenceCode": "8d562f84-f8d5-441a-b086-9483fc5133a0",
    "planPaymentType": "RECURRING",
    "status": "ACTIVE",
    "recurrenceCount": 12
  }
}

Örnek Kodlar

PHP

Java

.Net

Node.Js

Ödeme Planı Detayı Alma

get

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.

Path parameters
pricingPlanReferenceCodestringRequired

Ödeme planının referans kodu.

Header parameters
AuthorizationstringRequired

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

Content-TypestringRequired

İstek içeriğinin formatı.

Example: application/json
Responses
200

Başarılı yanıt

application/json
get
GET https://api.iyzipay.com/v2/subscription/pricing-plans/7515f763-5da3-4a35-8f7f-d425ae44ac04
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "status": "success",
  "systemTime": 1755561449951,
  "data": {
    "referenceCode": "7515f763-5da3-4a35-8f7f-d425ae44ac04",
    "name": "Aylık Plan",
    "price": 99.99,
    "currencyCode": "TRY",
    "paymentInterval": "MONTHLY",
    "paymentIntervalCount": 1,
    "planPaymentType": "RECURRING",
    "recurrenceCount": 12,
    "trialPeriodDays": 0,
    "productReferenceCode": "8d562f84-f8d5-441a-b086-9483fc5133a0",
    "status": "ACTIVE",
    "createdDate": 1755552252531
  }
}

Örnek Kodlar

PHP

Java

.Net

Node.Js

Ödeme Planı Listeleme

get

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

Path parameters
productReferenceCodestringRequired

Ürün referans kodu.

Query parameters
pageintegerOptional

Listelenecek sayfa numarası.

countintegerOptional

Sayfa başına kayıt sayısı.

Header parameters
AuthorizationstringRequired

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

Content-TypestringRequired

İstek içeriğinin formatı.

Example: application/json
Responses
200

Başarılı yanıt

application/json
get
GET https://api.iyzipay.com/v2/subscription/products/8d562f84-f8d5-441a-b086-9483fc5133a0/pricing-plans?page=1&count=20
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "status": "success",
  "systemTime": 1755561449951,
  "data": {
    "totalCount": 2,
    "currentPage": 1,
    "pageCount": 1,
    "items": [
      {
        "referenceCode": "plan-123",
        "name": "Aylık Plan",
        "price": 99.99,
        "currencyCode": "TRY",
        "paymentInterval": "MONTHLY",
        "paymentIntervalCount": 1,
        "status": "ACTIVE"
      },
      {
        "referenceCode": "plan-456",
        "name": "Yıllık Plan",
        "price": 999.99,
        "currencyCode": "TRY",
        "paymentInterval": "YEARLY",
        "paymentIntervalCount": 1,
        "status": "ACTIVE"
      }
    ]
  }
}

Örnek Kodlar

PHP

Java

.Net

Node.Js

Ödeme Planı Silme

delete

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

Path parameters
pricingPlanReferenceCodestringRequired

Silinecek ödeme planının referans kodu.

Header parameters
AuthorizationstringRequired

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

Content-TypestringRequired

İstek içeriğinin formatı.

Example: application/json
Responses
200

Başarılı yanıt

application/json
delete
DELETE https://api.iyzipay.com/v2/subscription/pricing-plans/7515f763-5da3-4a35-8f7f-d425ae44ac04
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

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

Örnek Kodlar

PHP

Java

.Net

Node.Js

Last updated