Retrieve Plan Interface

Retrieve plan interface returns details about created plan by HTTP Get method. The response body is same as that of create plan.

Retrieve a plan

HTTP Method: GET

Path: {base_url}/api/sub/v1/merchant/plans/{planId}

ParameterDescription
merchantId
mandatory
Merchant Key received during onboarding.
Example: Ysr1r

Retrieve all plans

Retrieve plan interface returns details about created plan by HTTP Get method. The response body is same as that of create plan.

HTTP Method: GET

Path: {base_url}/api/sub/v1/merchant/plans?

ParameterDescription
merchantId
mandatory
Merchant Key received during onboarding.
Example: Ysr1r
skip
mandatory
Skip is the number of plans to be skip from the data set fetched from database for given merchantId before applying the limit on it. It should be greater than or equal to zero.
Example: 5
limit
mandatory
Number of plans to be fetch. It should be greater than zero.
Max value of limit is 50

Example: 20

Example URL:

{base_url}/api/sub/v1/merchant/plans?merchantId=Ysr1r&skip=10&limit=50

In given URL format, for merchant having key as “Ysr1r” all the plans will be returned from 11 till 60 sorted by latest date, total 50 plans

{base_url}/api/sub/v1/merchant/plans?merchantId=Ysr1r&skip=0&limit=10

In given URL format, latest 10 plans will be returned.