Retrieve Specific Subscription

The Retrieve Specific Subscription request enables you to retrieve details about one existing subscription.


❗️

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 subscription-id into the web service URL, in the format:
services/2/recurring/subscriptions/{subscription-id}
For example:
services/2/recurring/subscriptions/2111111

network-transaction-info   object   optional. You can only include the inner element 'original-network-transaction-id' (refer to network-transaction-info)

Response Details

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


Examples

Request Examples

curl -v -X GET https://sandbox.bluesnap.com/services/2/recurring/subscriptions/8491535 \
-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"?>
<recurring-subscription xmlns="http://ws.plimus.com">
  <subscription-id>8491535</subscription-id>
  <plan-id>2283845</plan-id>
  <vaulted-shopper-id>21188039</vaulted-shopper-id>
  <status>ACTIVE</status>
  <quantity>1</quantity>
  <soft-descriptor>Example descriptor</soft-descriptor>
  <charge-frequency>MONTHLY</charge-frequency>
  <trial-period-days>14</trial-period-days>
  <recurring-charge-amount>29.99</recurring-charge-amount>
  <currency>USD</currency>
  <initial-charge-amount>100.00</initial-charge-amount>
  <auto-renew>true</auto-renew>
  <next-charge-date>2021-08-15</next-charge-date>
  <payer-info>
    <first-name>John</first-name>
    <last-name>Doe</last-name>
  </payer-info>
  <payment-source>
    <credit-card-info>
      <billing-contact-info>
        <first-name>John</first-name>
        <last-name>Doe</last-name>
      </billing-contact-info>
      <credit-card>
        <card-last-four-digits>1111</card-last-four-digits>
        <card-type>VISA</card-type>
        <card-sub-type>CREDIT</card-sub-type>
        <card-category>CLASSIC</card-category>
        <expiration-month>07</expiration-month>
        <expiration-year>2023</expiration-year>
      </credit-card>
    </credit-card-info>
  </payment-source>
</recurring-subscription>

Back to Top


API Explorer

To test out a call, enter an existing subscription ID (e.g 8491535) in the subscription-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!