List Subscriptions

GET/ps/api/v1/public/subscriptions

Retrieves all subscriptions. Supports filtering by plan_id, status, amount, date range, frequency, and pagination.

View as Markdown Open in ChatGPT Open in Claude Open in Perplexity

Requires Bearer token. Get token →

Header Parameters

Field	Details
`Request-Timestamp` `string`date-time	ISO 8601 UTC timestamp of the request. Used for idempotency and audit.
`Request-ID` `string`	Use a global unique identifier [GUID] for the request. Constraints Minimum length: 1 characterMaximum length: 50 characters

Query Parameters

Field	Details
`plan_id` `string`	Filter by plan ID.
`status` `string`	Filter by subscription status.
`amount` `integer`	Filter by amount value.
`amount_range` `string`	Amount comparison operator. Allowed values: `isMoreisLessisEqual`
`start_date` `string`date-time	Filter subscriptions with start date after this value.
`end_date` `string`date-time	Filter subscriptions with end date before this value.
`size` `integer`	Number of items per page.
`page` `integer`	Page number.
`sort` `string`	Sort field and direction.
`frequency` `string`	Filter by billing frequency.

Response

Field	Details
`links` `object`4 nested fields	Pagination links for navigation.
`first` `object`nullable1 nested field
`self` `object`nullable1 nested field
`next` `object`nullable1 nested field
`last` `object`nullable1 nested field
`page` `object`4 nested fields	Page information for paginated responses.
`subscriptions` `SubscriptionDetail[]`19 nested fields	List of subscription records.

Status Codes

`200`	Subscriptions retrieved successfully.
`500`	An unexpected error occurred on the server.

Run

Request

curl --request GET \
  --url 'https://pluraluat.v2.pinepg.in/ps/api/v1/public/subscriptions?plan_id=v1-plan-4405071524-aa-qlAtAf&status=ACTIVE&amount=100&amount_range=isMore&start_date=2022-02-01T17%3A32%3A28Z&end_date=2025-12-31T23%3A59%3A59Z&size=10&page=0&sort=id%2Casc&frequency=Month' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Request-ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
  --header 'Request-Timestamp: 2024-10-01T10:30:00Z'

Status:

{
  "links": {
    "first": {
      "href": "https://api.pluralpay.in/api/v1/public/{resource}/?size=10&page=0&sort=id,asc"
    },
    "self": {
      "href": "https://api.pluralpay.in/api/v1/public/{resource}/?size=10&page=0&sort=id,asc"
    },
    "next": {
      "href": "https://api.pluralpay.in/api/v1/public/{resource}/?size=10&page=0&sort=id,asc"
    },
    "last": {
      "href": "https://api.pluralpay.in/api/v1/public/{resource}/?size=10&page=0&sort=id,asc"
    }
  },
  "page": {
    "size": 10,
    "total_elements": 50,
    "total_pages": 5,
    "number": 1
  },
  "subscriptions": [
    {
      "order_id": "v1-4405071524-aa-qlAtAf",
      "subscription_id": "v1-sub-4405071524-aa-qlAtAf",
      "merchant_subscription_reference": "1234567890",
      "enable_notification": true,
      "plan_details": {
        "plan_id": "v1-plan-4405071524-aa-qlAtAf",
        "status": "ACTIVE",
        "plan_name": "Monthly Plan",
        "plan_description": "Diwali dhammaka plan intended to attract customers on diwali time",
        "frequency": "Day",
        "amount": {
          "value": 100,
          "currency": "INR"
        },
        "max_limit_amount": {
          "value": 100,
          "currency": "INR"
        },
        "trial_period_in_days": 1,
        "start_date": "2022-02-01T17:32:28Z",
        "end_date": "2022-10-21T17:32:28Z",
        "merchant_metadata": {
          "key1": "DD",
          "key2": "XOF"
        },
        "merchant_plan_reference": "1234567890",
        "created_at": "2022-10-21T17:32:28Z",
        "modified_at": "2022-10-21T17:32:28Z"
      },
      "quantity": 1,
      "start_date": "2022-07-21T17:32:28Z",
      "end_date": "2022-09-21T17:32:28Z",
      "customer_id": "123456",
      "payment_mode": "UPI",
      "allowed_payment_methods": [
        "UPI"
      ],
      "integration_mode": "SEAMLESS",
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      },
      "status": "ACTIVE",
      "is_tpv_enabled": true,
      "bank_account": {
        "account_number": "123456789012345",
        "name": "Gaurav Kumar",
        "ifsc": "HDFC0001234"
      },
      "created_at": "2022-10-21T17:32:28Z",
      "modified_at": "2022-10-21T17:32:28Z"
    }
  ]
}