GitHubFeedback FormAPI Reference - Beta

Ürün

Ürün Oluşturma

post

Yeni bir abonelik ürünü oluşturur.

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
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
post
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": []
  }
}

Ürün Güncelleme

post

Abonelik ürününü günceller.

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
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
post
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
      }
    ]
  }
}

Ürün Detayı

get

Belirli bir abonelik ürününü getirir.

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
get
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
      }
    ]
  }
}

Ürün Listeleme

get

Abonelik ürünlerini listeler (sayfalama destekler).

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
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
get
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
          }
        ]
      }
    ]
  }
}

Ürün Silme

delete

Abonelik ürününü siler. Aktif ödeme planı varsa silinemez.

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
delete
DELETE https://api.iyzipay.com/v2/subscription/products/{productReferenceCode}
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

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

Last updated