Get Plans

get

https://pluraluat.v2.pinepg.in/ps/api/v1/public/plans

Use this API to get the list of available plans.

Environment

Use our UAT environment endpoint for testing and for integration utilize our production endpoint.

Environment	Endpoints
User Acceptance Testing [UAT]	`https://pluraluat.v2.pinepg.in/ps/api/v1/public/plans`
Production [PROD]	`https://api.pluralpay.in/ps/api/v1/public/plans`

Query Params

plan_id

string

Unique identifier for the subscription plan in the Plural database.

Example: v1-plan-4405071524-aa-qlAtAf

start_date

string

The ISO 8601 UTC Timestamp after which details should be returned.

Example: 2022-02-01T17:32:28Z

end_date

string

The ISO 8601 UTC Timestamp before which details should be returned.

Example: 2022-09-21T17:32:28Z

amount

object

An object that contains the amount details.

amount_range

string

enum

Specifies the condition used to compare the transaction amount against a defined reference value.

isMore
isLess
isEqual

Allowed:

frequency

string

Frequency of recurring transactions for this particular plan.

Day
Week
Month
Year
Bi-Monthly
Quarterly
Half-Yearly
AS (As & When Presented)
OT (One Time)
Not Applicable

Example:Day

size

int32

Number of items per page.

Example: 10

page

int32

Page number.

Example: 2

sort

string

Sorting order for results.

Example: frequency,asc

Headers

Content-Type

string

Defaults to application/json

The type of content included in the HTTP message body.

Possible value: application/json.

Authorization

string

required

Defaults to Bearer

The HTTP header where you can include your secret token for authentication.

Example: Bearer <access_token>

Note: Use the access token generated using our Generate Token API.

Request-Timestamp

string

Use ISO 8601 UTC Timestamp, to create a timestamp when the generate token is requested.

Example: 2024-07-09T07:57:08.022Z

Request-ID

string

Use a global unique identifier [GUID] for the request.

Minimum: 1 characters.
Maximum: 50 characters

Example: c17ce30f-f88e-4f81-ada1-c3b4909ed235

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Environment

200200

500500