GET
/
api
/
v1
/
server-to-server-interface
/
subscription
/
list
curl --request GET \
  --url https://api-dev.paymentoptions.com/api/v1/api/v1/server-to-server-interface/subscription/list \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "status_code": 200,
  "is_live": false,
  "subscription_details": [
    {
      "id": "2048b01c-1512-45b9-98fc-27aac4deabce",
      "type": "CYCLE",
      "max_cycle_count": 10,
      "status": "ACTIVE",
      "completed_payment_cycle": 1,
      "next_payment_date": "2024-12-01T00:00:00.000Z",
      "next_payment_cycle": 2,
      "subscription_plan_details": {
        "name": "Three weeks plan",
        "desc": "Billed every two days",
        "billing_cycle_type": "DAYS",
        "billing_cycle_interval": 2,
        "amount": 1000,
        "ccy": "JPY",
        "trial_period_duration": "",
        "trial_period_duration_type": "NONE",
        "plan_discount_percentage": 10,
        "plan_discount_duration": 2
      },
      "subscription_transaction_details": [
        {
          "id": "00a33a30-be2d-4d5a-8d4f-659a6999d2ff",
          "ref": 69400,
          "cycle": 1,
          "status": "SUCCESSFUL",
          "transaction_date": "2024-11-30T00:00:00.000Z",
          "amount": 900,
          "ccy": "JPY",
          "event": "CAPTURED"
        }
      ]
    }
  ]
}

​
Notes

There is no request payload required for this API. Simply ensure that the correct authentication details (API key, etc.) are included in the request headers.

HeaderDescription
x-api-keyProvided along with credentials.
AuthorizationLive API Key obtained from merchant details on PO Gateway.
Content-TypeIndicates that all response attributes will be in JSON format (set to application/json).

​
Key Points

​
Retrieve Subscription Data

  • The Subscription List API helps merchants track the status of all subscriptions plans, including active, cancelled, or expired subscriptions.

​
Subscription Data - Each subscription record includes

  • Subscription ID

  • Plan Name and Description

  • Current Status (active, expired, or canceled)

  • Start Date and End Date

  • Cycle Interval and Next Billing Date

  • Trial and Discount Information (if applicable).

Authorizations

​
Authorization
string
header
required

API Key for Authorization. Format: 'Basic YOUR_API_KEY_HERE'

​
x-api-key
string
header
required

API Key specific to x-api-key.

Response

200 - application/json
A successful response containing subscription details.
​
success
boolean

Indicates whether the transaction was successful.

Example:

true

​
status_code
integer

The HTTP status code of the response.

Example:

200

​
is_live
boolean

Indicates if the transaction is live or a test transaction.

Example:

false

​
subscription_details
object[]

A list of subscription details.