Endpointler

HTTP metodu URL Açıklama
GET /payment/v2/subscription Abonelikleri filtreli ve sayfalı olarak listeler.
GET /payment/v2/subscription/{subscriptionId} Bir aboneliği kimliğiyle getirir.

merchantId kimlik doğrulama katmanı tarafından belirlenir; istemci tarafından değiştirilmemelidir.

Listeleme parametreleri

Query alanı Tip Zorunlu Varsayılan Açıklama
page integer Hayır 0 Sıfır tabanlı sayfa numarası.
size integer Hayır 10 Sayfadaki kayıt sayısı.
subscriptionId long Hayır — Abonelik kimliği filtresi.
status string Hayır — ACTIVE, PASSIVE, PENDING, DELETED, PROCESSING, ANOMALY veya WAITING.
periodType string/integer Hayır — WEEK/7, MONTH/30 veya YEAR/365.

Örnek: GET /payment/v2/subscription?page=0&size=20&status=ACTIVE&periodType=MONTH

Response modeli

Tekil sorguda data bir abonelik nesnesidir. Liste sorgusunda data.items abonelikleri; page, size ve totalSize sayfalama bilgisini içerir.

Alan Tip Açıklama
id long Abonelik kimliği.
paymentPlanCode string Plan kodu.
externalCustomerId string Üye işyeri müşteri kimliği.
merchantId long Üye işyeri kimliği.
buyerId long Alıcı kimliği.
cardUserKey string Saklı kart kullanıcı anahtarı.
cardToken string Saklı kart tokenı.
price decimal Geçerli dönem tutarı.
nextPrice decimal Planlanmış sonraki tutar.
nextPriceStartPeriod integer Sonraki tutarın başlayacağı dönem.
variablePayment boolean Değişken tutarlı plan bilgisi.
variablePaymentTriggerType string SCHEDULED veya EXTERNAL.
periodType string WEEK, MONTH veya YEAR.
description string Abonelik açıklaması.
noChargeDayCount integer Ücretsiz gün sayısı.
nextPaymentDate date-time Sonraki tahsilat zamanı.
status string Abonelik durumu.
paidCount integer Tamamlanan tahsilat sayısı.
currentPeriod integer Geçerli dönem numarası. 
{
  "data": {
    "id": 4821,
    "paymentPlanCode": "PREMIUM-MONTHLY",
    "externalCustomerId": "customer-42",
    "merchantId": 1001,
    "buyerId": 9007,
    "price": 99.90,
    "variablePayment": false,
    "periodType": "MONTH",
    "description": "Aylık premium üyelik",
    "noChargeDayCount": 0,
    "nextPaymentDate": "2026-11-01T10:00:00",
    "status": "ACTIVE",
    "paidCount": 2,
    "currentPeriod": 3
  }
}