Abunəlik yaratma

Abunəlik checkout sorğusunda paymentGroup sahəsinə SUBSCRIPTION göndərilməklə yaradılır. İlk 3D Secure ödənişindən sonra növbəti ödənişlər plana əsasən icra olunur.

HTTP metodu URL
POST /payment/v1/checkout-payments/init

Plan sahələri

Sahə Növ Məcburi Açıqlama
externalCustomerId string Xeyr Tacir sistemində müştəri identifikatoru; maksimum 255 simvol.
planCode string Xeyr Plan kodu; maksimum 50 simvol.
periodType integer Bəli 7 (həftə), 30 (ay) və ya 365 (il).
price decimal Şərti Dövr üçün müsbət məbləğ.
nochargeDayCount integer Bəli İlk ödənişədək pulsuz gün sayı; standart 0.
description string Bəli Abunəliyin təsviri.
paymentCount integer Xeyr Ümumi ödəniş dövrlərinin sayı.
variablePayment boolean Xeyr Dəyişən məbləğli plan göstəricisi.
variablePaymentTriggerType string Şərti SCHEDULED və ya EXTERNAL.
paymentSteps array Xeyr Dövr üzrə qiymət və ödəniş tarixi addımları.

paymentSteps elementində startPeriod (minimum 1), periodPrice (müsbət), paymentDate (YYYY-MM-DD) və skipPaymentPeriod sahələri istifadə olunur.

{
  "price": 99.90,
  "paidPrice": 99.90,
  "currency": "AZN",
  "paymentGroup": "SUBSCRIPTION",
  "callbackUrl": "https://merchant.example.com/payment/callback",
  "conversationId": "order-2026-001",
  "items": [{ "name": "Premium üzvlük", "price": 99.90 }],
  "plan": {
    "externalCustomerId": "customer-42",
    "planCode": "PREMIUM-MONTHLY",
    "periodType": 30,
    "price": 99.90,
    "nochargeDayCount": 0,
    "description": "Aylıq premium üzvlük",
    "paymentCount": 12,
    "variablePayment": false
  }
}

Abunəlik statusları

ACTIVE (0), PASSIVE (1), PENDING (2), DELETED (3), PROCESSING (4), ANOMALY (5) və WAITING (6).