Get 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 →

Query Parameters

Name	Type	Description
`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`	Filter subscriptions with start date after this value.
`end_date`	`string`	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

Name	Type	Description
`links`	`object`	Pagination links for navigation.
`first`	`objectnull`
`self`	`objectnull`
`next`	`objectnull`
`last`	`objectnull`
`page`	`object`	Page information for paginated responses.
`size`	`integer`	Number of items per page.
`total_elements`	`integer`	Total number of elements.
`total_pages`	`integer`	Total number of pages.
`number`	`integer`	Page number.
`subscriptions`	`SubscriptionDetail[]`	List of subscription records.
`order_id`	`string`	Unique identifier of the order in the Pine Labs Online database.
`subscription_id`	`string`	Unique identifier for the subscription.
`merchant_subscription_reference`	`string`	Unique identifier of the merchant subscription reference.
`enable_notification`	`boolean`	Indicates if notifications are enabled.
`plan_details`	`object`	Plan object returned in create, get, and update responses.
`quantity`	`integer`	The quantity of the subscription for the selected plan.
`start_date`	`string`	The ISO 8601 UTC Timestamp when the subscription starts.
`end_date`	`string`	The ISO 8601 UTC Timestamp when the subscription expires.
`customer_id`	`string`	Unique identifier of the customer.
`payment_mode`	`string`	Payment methods allowed for subscription. Allowed values: `CARDUPI`
`allowed_payment_methods`	`string[]`	The type of payment methods offered to customers.
`integration_mode`	`string`	Type of integration. Allowed values: `SEAMLESSREDIRECT`
`merchant_metadata`	`object`	Key-value pairs for additional information.
`status`	`string`	Status of the Subscription. Allowed values: `CREATEDTRIALACTIVEPAUSEDRESUMINGRESUMEDDEBIT_FAILEDUPDATINGCOMPLETEDEXPIREDCANCELLEDCANCELLINGHALTEDINACTIVE`
`is_tpv_enabled`	`boolean`	Indicates if Third-Party Validation (TPV) is enabled.
`bank_account`	`object`	Bank account details for Third-Party Validation (TPV).
`created_at`	`string`	ISO 8601 UTC Timestamp when the subscription was created.
`modified_at`	`string`	ISO 8601 UTC Timestamp when the subscription was last updated.
`order_amount`	`object`	This is the recurring mandate amount, that would be charged for each frequency. For instance 200 every month. This field is not needed if the mandate frequency is AS

Status Codes

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

Request

curl --request GET \
  --url https://pluraluat.v2.pinepg.in/ps/api/v1/public/subscriptions \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Run this request

Bearer token

Query parameters

plan_id

status

amount

amount_range

start_date

end_date

size

page

sort

frequency

Status:

200 OK

{
  "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"
    }
  ]
}