Abonelik İşlemleri

Abonelik Aktifleştirme

post

Pending durumunda başlatılan bir abonelik, bu servis üzerinden aktif hale getirilir.

Path parameters

subscriptionReferenceCodestringRequired

Pending olarak başlatılan aboneliğe ait referans kodu.

Example: a2077643-bab7-4b73-85a5-7676c78d7c66

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

subscriptionReferenceCodestringOptional

Pending oalrak başlatılan aboneliğe ait referans kodu.

Example: a2077643-bab7-4b73-85a5-7676c78d7c66

Responses

200

Başarılı yanıt

application/json

400

Başarısız yanıt

application/json

post

POST https://api.iyzipay.com/v2/subscription/subscriptions/009dac1a-00dc-41e8-a92f-2c24b18e27b9/activate
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "referenceCode": "a2077643-bab7-4b73-85a5-7676c78d7c66"
}

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

Abonelik İptali

post

Aktif bir aboneliği iptal etmek için kullanılır.

Path parameters

subscriptionReferenceCodestringRequired

İptal edilmek istenen aboneliğe ait referans kodu.

Example: 009dac1a-00dc-41e8-a92f-2c24b18e27b9

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

subscriptionReferenceCodestringOptional

Abonelik referans kodu. Opsiyonel olarak body de gönderilebilir.

Example: a2077643-bab7-4b73-85a5-7676c78d7c66

Responses

200

Başarılı yanıt

application/json

400

Başarısız yanıt

application/json

post

POST https://api.iyzipay.com/v2/subscription/subscriptions/009dac1a-00dc-41e8-a92f-2c24b18e27b9/cancel
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "subscriptionReferenceCode": "a2077643-bab7-4b73-85a5-7676c78d7c66"
}

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

Abonelik Ödeme Tekrarlama

post

Eğer bir abonelikte, tekrarlayan ödemeler sırasında bir ödeme başarısız olduysa, işlemi tekrar denemek ve ödemeyi almak için retry servisi kullanılır.

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

referenceCodestringRequired

Başarısız ödemenin referans kodu. Başarısız abonelik ödemesi için gönderilen webhook bildiriminde yer alan orderReferenceCode değeridir.

Example: 009dac1a-00dc-41e8-a92f-2c24b18e27b9

Responses

200

Başarılı yanıt

application/json

400

Başarısız yanıt

application/json

post

POST https://api.iyzipay.com/v2/subscription/operation/retry
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "referenceCode": "a2077643-bab7-4b73-85a5-7676c78d7c66"
}

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

Abonelik Yükseltme

post

Abonelik süresince plan değiştirmek veya yükseltmek mümkündür. Bunun için yeni planın aynı ürüne ait olması ve ödeme aralığının (paymentInterval ve paymentIntervalCount) aynı olması gerekir. Fiyat güncellemeleri için abonelik yükseltme servisi kullanılır.

Path parameters

subscriptionReferenceCodestringRequired

Yükseltilmek istenen aboneliğe ait referans kodu.

Example: 97fb885d-69e3-49ac-8590-9d05c9c6016e

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

upgradePeriodstring · enumRequired

Aboneliğin upgrade edileceği tarih. Değerler:

NOW: Değişiklik/işlem hemen uygulanır.
NEXT_PERIOD: Değişiklik bir sonraki faturalama döneminde uygulanır.

Example: NOWPossible values:

newPricingPlanReferenceCodestringRequired

Yükseltilmek istenen ödeme planına ait referans kodu.

Example: dbffa857-40f5-48d1-9179-e9326ffb942d

useTrialbooleanOptional

Eğer true gönderilirse upgrade edilen ödeme planının deneme süreci dahil edilir.

Example: false

resetRecurrenceCountbooleanOptional

true: Yeni planın tekrar sayısına (recurrenceCount) göre abonelik bitiş tarihi yeniden hesaplanır.
false: Mevcut planın bitiş tarihi korunur ve yeni plana aktarılır.

Example: true

Responses

200

Başarılı yanıt

application/json

400

Başarısız yanıt

application/json

post

POST https://api.iyzipay.com/v2/subscription/subscriptions/97fb885d-69e3-49ac-8590-9d05c9c6016e/upgrade
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "newPricingPlanReferenceCode": "dbffa857-40f5-48d1-9179-e9326ffb942d",
  "upgradePeriod": "NEXT_PERIOD",
  "useTrial": false,
  "resetRecurrenceCount": true
}

{
  "status": "success",
  "systemTime": 1755613834401,
  "data": {
    "referenceCode": "74726a5a-cc3d-4de8-b08c-3e373ea26842",
    "parentReferenceCode": "85626e75-5043-4343-89bd-3cbbf33d15ad",
    "pricingPlanReferenceCode": "dbffa857-40f5-48d1-9179-e9326ffb942d",
    "customerReferenceCode": "279bb493-6fda-45e9-9368-2373ea43ff8d",
    "subscriptionStatus": "ACTIVE",
    "trialDays": 0,
    "createdDate": 1755613834375,
    "startDate": 1756045826566,
    "endDate": 1787581826566
  }
}

Abonelik Kart Güncelleme (Checkout Form)

post

Bu istek ile bir abonelikte kullanılan kredi kartı güncellenebilir. Ödeme hatası, kart son kullanma tarihinin geçmesi gibi durumlarda üye iş yerleri kart bilgisini kolayca güncelleyebilir. Güncelleme işlemi yalnızca iyzico ödeme formu üzerinden gerçekleştirilir. Güncellenen kredi kartının validasyonu için 1 TL’lik ödeme alınır ve hemen iadesi gerçekleşir.

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

callbackUrlstringRequired

Güncelleme sonucunun gönderileceği callback adresi.

Example: https://www.merchant.com/callback

customerReferenceCodestringRequired

Kartı güncellenecek müşteriye ait referans kodu.

Example: 279bb493-6fda-45e9-9368-2373ea43ff8d

subscriptionReferenceCodestringOptional

Bir abonelik üzerinde güncelleme sağlanacaksa, işlem yapılacak aboneliğe ait referans kodu (opsiyonel).

Example: 52c732ba-b449-460b-b553-ab21f9074300

localestring · enumOptional

İstek sonrası dönüş yapılacak yanıt dili.

Example: trPossible values:

Responses

200

Başarılı yanıt

application/json

400

Başarısız yanıt

application/json

post

POST https://api.iyzipay.com/v2/subscription/card-update/checkoutform/initialize
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "locale": "tr",
  "callbackUrl": "https://www.merchant.com/callback",
  "customerReferenceCode": "279bb493-6fda-45e9-9368-2373ea43ff8d",
  "subscriptionReferenceCode": "52c732ba-b449-460b-b553-ab21f9074300"
}

{
  "status": "success",
  "locale": "tr",
  "systemTime": 1755679946462,
  "conversationId": "04c6063d-eb03-4817-ba87-33b81e392ecf",
  "token": "83832cc6-89b6-4a83-ac9f-dd996a52b2cb",
  "checkoutFormContent": "<script type=\"text/javascript\">if (typeof iyziInit == 'undefined') {var iyziInit = {currency:\"TRY\",token:\"83832cc6-89b6-4a83-ac9f-dd996a52b2cb\",price:1.00,...}};</script>",
  "tokenExpireTime": 1800
}

Abonelik Detayı

get

Aboneliğe ait referans kod ile sorgulama yapılarak bir aboneliğin tüm detayları bu istek ile görülebilir.

Path parameters

subscriptionReferenceCodestringRequired

İlgili aboneliğe ait referans kodu.

Example: 732a16cc-2ec4-4399-9aab-656cb6f5249e

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

subscriptionReferenceCodestringOptional

Abonelik referans kodu. Opsiyonel olarak body de gönderilebilir.

Example: 732a16cc-2ec4-4399-9aab-656cb6f5249e

Responses

200

Başarılı yanıt

application/json

get

GET https://api.iyzipay.com/v2/subscription/subscriptions/732a16cc-2ec4-4399-9aab-656cb6f5249e
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

200

Başarılı yanıt

{
  "status": "success",
  "systemTime": 1755617091761,
  "data": {
    "totalCount": 1,
    "currentPage": 1,
    "pageCount": 1,
    "items": [
      {
        "referenceCode": "732a16cc-2ec4-4399-9aab-656cb6f5249e",
        "parentReferenceCode": "aa86bbf7-176f-432e-8523-7c24cc250af4",
        "pricingPlanName": "Ödeme Planı V2 TEST",
        "pricingPlanReferenceCode": "deadd767-7d0a-4ddb-96f2-565ad245773d",
        "productName": "test",
        "productReferenceCode": "40070483-1a6e-4641-99c0-be513edcf9f2",
        "customerEmail": "[email protected]",
        "customerGsmNumber": "+905554445555",
        "customerReferenceCode": "ce88a44d-a4f5-4de9-8bbb-1f170a9be219",
        "subscriptionStatus": "UNPAID",
        "trialDays": 0,
        "createdDate": 1753186413089,
        "startDate": 1753186413089,
        "endDate": 1753229613089,
        "orders": [
          {
            "referenceCode": "684279ad-5caa-40a0-ae9a-95ec097d696d",
            "price": 1.4,
            "currencyCode": "TRY",
            "startPeriod": 1753190013089,
            "endPeriod": 1753193613089,
            "orderStatus": "WAITING",
            "paymentAttempts": [
              {
                "conversationId": "90cf2fdc-bb9a-4931-be32-f65312eb379d",
                "createdDate": 1753190040185,
                "paymentStatus": "FAILED",
                "errorCode": "5034",
                "errorMessage": "buyerSurname gönderilmesi zorunludur"
              }
            ]
          },
          {
            "referenceCode": "0759e5ce-1668-40cb-9570-d0b6eda8d988",
            "price": 1.4,
            "currencyCode": "TRY",
            "startPeriod": 1753186413089,
            "endPeriod": 1753190013089,
            "orderStatus": "SUCCESS",
            "paymentAttempts": [
              {
                "conversationId": "123456789",
                "createdDate": 1753186413090,
                "paymentId": 24578296,
                "paymentStatus": "SUCCESS"
              }
            ]
          }
        ]
      }
    ]
  }
}

Last updated 17 days ago