New ARB Call -- ARBGetSubscriptionStatus Available on 8/24

Michelle — Fri, 20 Aug 2010 22:08:01 GMT

One of the top-requested features we have received for our Automated Recurring Billing™ (ARB) feature is a way to check the status of a subscription using the API. Well we are pleased to announce that on August 24, 2010, that functionality will be available. Wahoo!! :smileyvery-happy:

To give you a head start, we thought we'd post the code for you here. Now remember, this will not work until 8/24, but here you go:

Example ARBGetSubscriptionStatusRequest

<?xml version="1.0" encoding="utf-8"?>
<ARBGetSubscriptionStatusRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd">
  <merchantAuthentication>
    <name>mytestacct</name>
    <transactionKey>112223344</transactionKey>
  </merchantAuthentication>
  <refId>Sample</refId>
  <subscriptionId>100748</subscriptionId>
</ARBGetSubscriptionStatusRequest>

Example ARBGetSubscriptionStatusResponse

<ARBGetSubscriptionStatusResponse 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd">
  <refId>Sample</refId>
  <messages>
    <resultCode>Ok</resultCode>
    <message>
      <code>I00001</code>
      <text>Successful.</text>
    </message>
  </messages>
  <status>active</status>
</ARBGetSubscriptionStatusResponse>

The possible values for a subscription's status are:

active
expired
suspended
canceled
terminated

We hope this new function will help with your ARB solutions.

Thanks,

Michelle

Developer Community Manager

topic New ARB Call -- ARBGetSubscriptionStatus Available on 8/24 in News and Announcements

New ARB Call -- ARBGetSubscriptionStatus Available on 8/24