BlueSnap.comAPI BasicsPayment APIEmbedded PaymentsReporting & ToolsSupport GuidesTest
API Reference

Retrieve Subscription History

get https://sandbox.bluesnap.com/services/2

Definition

https://sandbox.bluesnap.com/services/2/tools/shopper-subscriptions-retriever?shopperid|shopperid&sellerid

Documentation

The Retrieve Subscription History request enables you to retrieve a list of subscriptions that a specific shopper has purchased.

Request Content

Retrieve based on shopper ID in BlueSnap
Enter the shopper-id into the web service URL, in the format:
services/2/tools/shopper-subscriptions-retriever?shopperid

For example:
services/2/tools/shopper-subscriptions-retriever?shopperid=12345678

Retrieve based on seller shopper ID
Enter your unique ID that you have assigned to the shopper (the seller-shopper-id) as the value of the shopperid query parameter in the URL, and also enter your seller ID in BlueSnap as the value of the sellerid query parameter. Format:
services/2/tools/shopper-subscriptions-retriever?shopperid&sellerid

For example:
services/2/tools/shopper-subscriptions-retriever?shopperid=456789123&sellerid=397248

📘

Use fulldescription parameter to retrieve all details

If you would like to receive complete details about all subscriptions in the response, include the fulldescription parameter in the web service URL, with the value set to true.
For example:
services/2/tools/shopper-subscriptions-retriever?shopperid=12345&fulldescription=true

If you do not include this parameter, the response will include URLs that you can use to obtain information about each subscription.

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the retrieved order-history resource (see order-history).
For details about possible errors, see: General Errors, Payment & Processor Errors, and Fraud Errors.

Examples

Request Examples

curl -v -X GET https://sandbox.bluesnap.com/services/2/tools/shopper-subscriptions-retriever?shopperid=19505364  \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

curl -v -X GET https://sandbox.bluesnap.com/services/2/tools/shopper-subscriptions-retriever?shopperid=456789123&sellerid=397248 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

curl -v -X GET https://sandbox.bluesnap.com/services/2/tools/shopper-subscriptions-retriever?shopperid=19505364&fulldescription=true \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

<?xml version="1.0" encoding="UTF-8"?>
<shopper-subscriptions xmlns="http://ws.plimus.com">
  <ordering-shopper>
    <shopper-id>19505364</shopper-id>
  </ordering-shopper>
  <subscriptions>
    <url>https://sandbox.bluesnap.com/services/2/subscriptions/39469016</url>
    <url>https://sandbox.bluesnap.com/services/2/subscriptions/39486350</url>
    <url>https://sandbox.bluesnap.com/services/2/subscriptions/39486342</url>
    <url>https://sandbox.bluesnap.com/services/2/subscriptions/39486230</url>
    <url>https://sandbox.bluesnap.com/services/2/subscriptions/39486346</url>
    <url>https://sandbox.bluesnap.com/services/2/subscriptions/39486132</url>
    <url>https://sandbox.bluesnap.com/services/2/subscriptions/39486238</url>
    <url>https://sandbox.bluesnap.com/services/2/subscriptions/39486234</url>
    <url>https://sandbox.bluesnap.com/services/2/subscriptions/39486236</url>
    <url>https://sandbox.bluesnap.com/services/2/subscriptions/39486348</url>
  </subscriptions>
</shopper-subscriptions>

<?xml version="1.0" encoding="UTF-8"?>
<shopper-subscriptions xmlns="http://ws.plimus.com">
  <ordering-shopper>
    <seller-shopper-id>456789123</seller-shopper-id>
  </ordering-shopper>
  <subscriptions>
    <url>https://sandbox.bluesnap.com/services/2/subscriptions/39469016</url>
    <url>https://sandbox.bluesnap.com/services/2/subscriptions/39484454</url>
    <url>https://sandbox.bluesnap.com/services/2/subscriptions/39486350</url>
  </subscriptions>
</shopper-subscriptions>

<?xml version="1.0" encoding="UTF-8"?>
<shopper-subscriptions xmlns="http://ws.plimus.com">
  <ordering-shopper>
    <shopper-id>19505364</shopper-id>
  </ordering-shopper>
  <subscriptions>
    <subscription>
      <subscription-id>39469016</subscription-id>
      <status>A</status>
      <underlying-sku-id>2178834</underlying-sku-id>
      <shopper-id>19505364</shopper-id>
      <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>
      </credit-card>
      <catalog-recurring-charge>
        <currency>USD</currency>
        <amount>5.00</amount>
      </catalog-recurring-charge>
      <charge-frequency>MONTHLY</charge-frequency>
      <next-charge-date>30-Sep-17</next-charge-date>
      <auto-renew>true</auto-renew>
      <last-charge-result>
        <result-code>SUCCESS</result-code>
      </last-charge-result>
      <subscription-charges />
    </subscription>
    <subscription>
      <subscription-id>39486350</subscription-id>
      <status>A</status>
      <underlying-sku-id>2178914</underlying-sku-id>
      <shopper-id>19505364</shopper-id>
      <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>
      </credit-card>
      <catalog-recurring-charge>
        <currency>USD</currency>
        <amount>1.00</amount>
      </catalog-recurring-charge>
      <charge-frequency>ONDEMAND</charge-frequency>
      <auto-renew>true</auto-renew>
      <last-charge-result>
        <result-code>SUCCESS</result-code>
      </last-charge-result>
      <subscription-charges>
        <subscription-charge>
          <charge-info />
          <charge-invoice-info>
            <date-created>11-Nov-15</date-created>
            <invoice-id>38442304</invoice-id>
            <invoice-amount>5.00</invoice-amount>
            <invoice-currency>USD</invoice-currency>
          </charge-invoice-info>
        </subscription-charge>
        <subscription-charge>
          <charge-info>
            <charge-description>some text</charge-description>
          </charge-info>
          <charge-invoice-info>
            <date-created>11-Nov-15</date-created>
            <invoice-id>38442336</invoice-id>
            <invoice-amount>1.00</invoice-amount>
            <invoice-currency>USD</invoice-currency>
          </charge-invoice-info>
        </subscription-charge>
        <subscription-charge>
          <charge-info>
            <charge-description>some text</charge-description>
          </charge-info>
          <charge-invoice-info>
            <date-created>11-Nov-15</date-created>
            <invoice-id>38442334</invoice-id>
            <invoice-amount>1.00</invoice-amount>
            <invoice-currency>USD</invoice-currency>
          </charge-invoice-info>
        </subscription-charge>
      </subscription-charges>
    </subscription>
    <subscription>
      <subscription-id>39486342</subscription-id>
      <status>A</status>
      <underlying-sku-id>2178914</underlying-sku-id>
      <shopper-id>19505364</shopper-id>
      <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>
      </credit-card>
      <catalog-recurring-charge>
        <currency>USD</currency>
        <amount>1.00</amount>
      </catalog-recurring-charge>
      <charge-frequency>ONDEMAND</charge-frequency>
      <auto-renew>true</auto-renew>
      <last-charge-result>
        <result-code>SUCCESS</result-code>
      </last-charge-result>
      <subscription-charges />
    </subscription>
    <subscription>
      <subscription-id>39486230</subscription-id>
      <status>A</status>
      <underlying-sku-id>2178914</underlying-sku-id>
      <shopper-id>19505364</shopper-id>
      <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>
      </credit-card>
      <catalog-recurring-charge>
        <currency>USD</currency>
        <amount>1.00</amount>
      </catalog-recurring-charge>
      <charge-frequency>ONDEMAND</charge-frequency>
      <auto-renew>true</auto-renew>
      <last-charge-result>
        <result-code>SUCCESS</result-code>
      </last-charge-result>
      <subscription-charges />
    </subscription>
    <subscription>
      <subscription-id>39486346</subscription-id>
      <status>A</status>
      <underlying-sku-id>2178914</underlying-sku-id>
      <shopper-id>19505364</shopper-id>
      <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>
      </credit-card>
      <catalog-recurring-charge>
        <currency>USD</currency>
        <amount>1.00</amount>
      </catalog-recurring-charge>
      <charge-frequency>ONDEMAND</charge-frequency>
      <auto-renew>true</auto-renew>
      <last-charge-result>
        <result-code>SUCCESS</result-code>
      </last-charge-result>
      <subscription-charges />
    </subscription>
    <subscription>
      <subscription-id>39486132</subscription-id>
      <status>A</status>
      <underlying-sku-id>2178834</underlying-sku-id>
      <shopper-id>19505364</shopper-id>
      <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>
      </credit-card>
      <catalog-recurring-charge>
        <currency>USD</currency>
        <amount>5.00</amount>
      </catalog-recurring-charge>
      <charge-frequency>MONTHLY</charge-frequency>
      <next-charge-date>10-Jan-17</next-charge-date>
      <auto-renew>true</auto-renew>
      <last-charge-result>
        <result-code>SUCCESS</result-code>
      </last-charge-result>
      <subscription-charges />
    </subscription>
  </subscriptions>
</shopper-subscriptions>

Back to Top
Language
Credentials
:
Click Try It! to start a request and see the response here!