Retrieve Specific Plan

The Retrieve Specific Plan request enables you to retrieve details about one existing subscription billing plan.



You can test out a request that hits our sandbox in real-time. Follow the instructions here to use the "Try It!" feature on the right side.

Request Content

Enter the planId into the web service URL, in the format:

For example:

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the retrieved plan object.


Request Examples

curl -v -X GET \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '

Response Examples

    "chargeFrequency": "MONTHLY",
    "gracePeriodDays": 10,
    "trialPeriodDays": 14,
    "initialChargeAmount": 100,
    "name": "Gold Plan",
    "planId": 2283845,
    "currency": "USD",
    "maxNumberOfCharges": 12,
    "recurringChargeAmount": 29.99,
    "chargeOnPlanSwitch": true,
    "status": "ACTIVE"

Back to Top

API Explorer

To test out a call, enter an existing plan ID (e.g 2283845) in the planId field. This will automatically insert the ID into the request URL.

Click Try It! to start a request and see the response here!