Retrieve Specific Plan

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


❗️

Important

The API Explorer Try It! feature does not currently send XML requests to our sandbox environment.

For request and response examples, refer to the Examples section.

Request Content

Enter the plan-id into the web service URL, in the format:
services/2/recurring/plans/{plan-id}

For example:
services/2/recurring/plans/2111111

Response Details

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


Examples

Request Examples

curl -v -X GET https://sandbox.bluesnap.com/services/2/recurring/plans/2283845 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

HTTP/ 1.1 200 OK

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<plan xmlns="http://ws.plimus.com">
  <plan-id>2283845</plan-id>
  <name>Gold Plan</name>
  <recurring-charge-amount>29.99</recurring-charge-amount>
  <currency>USD</currency>
  <charge-frequency>MONTHLY</charge-frequency>
  <trial-period-days>14</trial-period-days>
  <initial-charge-amount>100.00</initial-charge-amount>
  <charge-on-plan-switch>true</charge-on-plan-switch>
  <max-number-of-charges>12</max-number-of-charges>
  <grace-period-days>10</grace-period-days>
  <status>ACTIVE</status>
</plan>

Back to Top


API Explorer

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

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