Endpoints

HTTP method URL Description
GET /payment/v2/subscription Returns a filtered, paginated subscription list.
GET /payment/v2/subscription/{subscriptionId} Retrieves one subscription by identifier.

merchantId is resolved by the authentication layer and must not be changed by the client.

List parameters

Query field Type Required Default Description
page integer No 0 Zero-based page number.
size integer No 10 Number of records per page.
subscriptionId long No — Filters by subscription identifier.
status string No — ACTIVE, PASSIVE, PENDING, DELETED, PROCESSING, ANOMALY, or WAITING.
periodType string/integer No — WEEK/7, MONTH/30, or YEAR/365.

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

Response model

For retrieval, data is a subscription object. For search, data.items contains subscriptions and page, size, and totalSize contain pagination metadata.

Field Type Description
id long Subscription identifier.
paymentPlanCode string Payment plan code.
externalCustomerId string Customer identifier in the merchant system.
merchantId long Merchant identifier.
buyerId long Buyer identifier.
cardUserKey string Stored-card user key.
cardToken string Stored-card token.
price decimal Current period amount.
nextPrice decimal Scheduled next amount.
nextPriceStartPeriod integer First period for the next amount.
variablePayment boolean Whether the plan uses variable amounts.
variablePaymentTriggerType string SCHEDULED or EXTERNAL.
periodType string WEEK, MONTH, or YEAR.
description string Subscription description.
noChargeDayCount integer Number of free days.
nextPaymentDate date-time Next charge timestamp.
status string Subscription status.
paidCount integer Number of completed charges.
currentPeriod integer Current period number. 
{
  "data": {
    "id": 4821,
    "paymentPlanCode": "PREMIUM-MONTHLY",
    "externalCustomerId": "customer-42",
    "merchantId": 1001,
    "buyerId": 9007,
    "price": 99.90,
    "variablePayment": false,
    "periodType": "MONTH",
    "description": "Monthly premium membership",
    "noChargeDayCount": 0,
    "nextPaymentDate": "2026-11-01T10:00:00",
    "status": "ACTIVE",
    "paidCount": 2,
    "currentPeriod": 3
  }
}