Service


Click here for a complete list of operations.

ARBGetSubscriptionList

This method is used to get existing ARB subscriptions. The merchant must be signed up for the ARB service to use it.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /soap/v1/Service.asmx HTTP/1.1
Host: apitest.authorize.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.authorize.net/soap/v1/ARBGetSubscriptionList"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ARBGetSubscriptionList xmlns="https://api.authorize.net/soap/v1/">
      <merchantAuthentication>
        <name>string</name>
        <transactionKey>string</transactionKey>
      </merchantAuthentication>
      <request>
        <searchType>cardExpiringThisMonth or subscriptionActive or subscriptionExpiringThisMonth or subscriptionInactive</searchType>
        <sorting>
          <orderBy>id or name or status or createTimeStampUTC or lastName or firstName or accountNumber or amount or pastOccurrences</orderBy>
          <orderDescending>boolean</orderDescending>
        </sorting>
        <paging>
          <limit>int</limit>
          <offset>int</offset>
        </paging>
      </request>
      <clientId>string</clientId>
    </ARBGetSubscriptionList>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ARBGetSubscriptionListResponse xmlns="https://api.authorize.net/soap/v1/">
      <ARBGetSubscriptionListResult>
        <totalNumInResultSet>int</totalNumInResultSet>
        <subscriptionDetails>
          <subscriptionDetail>
            <id>int</id>
            <name>string</name>
            <status>active or expired or suspended or canceled or terminated</status>
            <createTimeStampUTC>dateTime</createTimeStampUTC>
            <firstName>string</firstName>
            <lastName>string</lastName>
            <totalOccurrences>int</totalOccurrences>
            <pastOccurrences>int</pastOccurrences>
            <paymentMethod>creditCard or eCheck or payPal</paymentMethod>
            <accountNumber>string</accountNumber>
            <invoice>string</invoice>
            <amount>decimal</amount>
            <currencyCode>string</currencyCode>
            <customerProfileId>int</customerProfileId>
            <customerPaymentProfileId>int</customerPaymentProfileId>
            <customerShippingProfileId>int</customerShippingProfileId>
          </subscriptionDetail>
          <subscriptionDetail>
            <id>int</id>
            <name>string</name>
            <status>active or expired or suspended or canceled or terminated</status>
            <createTimeStampUTC>dateTime</createTimeStampUTC>
            <firstName>string</firstName>
            <lastName>string</lastName>
            <totalOccurrences>int</totalOccurrences>
            <pastOccurrences>int</pastOccurrences>
            <paymentMethod>creditCard or eCheck or payPal</paymentMethod>
            <accountNumber>string</accountNumber>
            <invoice>string</invoice>
            <amount>decimal</amount>
            <currencyCode>string</currencyCode>
            <customerProfileId>int</customerProfileId>
            <customerPaymentProfileId>int</customerPaymentProfileId>
            <customerShippingProfileId>int</customerShippingProfileId>
          </subscriptionDetail>
        </subscriptionDetails>
      </ARBGetSubscriptionListResult>
    </ARBGetSubscriptionListResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /soap/v1/Service.asmx HTTP/1.1
Host: apitest.authorize.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ARBGetSubscriptionList xmlns="https://api.authorize.net/soap/v1/">
      <merchantAuthentication>
        <name>string</name>
        <transactionKey>string</transactionKey>
      </merchantAuthentication>
      <request>
        <searchType>cardExpiringThisMonth or subscriptionActive or subscriptionExpiringThisMonth or subscriptionInactive</searchType>
        <sorting>
          <orderBy>id or name or status or createTimeStampUTC or lastName or firstName or accountNumber or amount or pastOccurrences</orderBy>
          <orderDescending>boolean</orderDescending>
        </sorting>
        <paging>
          <limit>int</limit>
          <offset>int</offset>
        </paging>
      </request>
      <clientId>string</clientId>
    </ARBGetSubscriptionList>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ARBGetSubscriptionListResponse xmlns="https://api.authorize.net/soap/v1/">
      <ARBGetSubscriptionListResult>
        <totalNumInResultSet>int</totalNumInResultSet>
        <subscriptionDetails>
          <subscriptionDetail>
            <id>int</id>
            <name>string</name>
            <status>active or expired or suspended or canceled or terminated</status>
            <createTimeStampUTC>dateTime</createTimeStampUTC>
            <firstName>string</firstName>
            <lastName>string</lastName>
            <totalOccurrences>int</totalOccurrences>
            <pastOccurrences>int</pastOccurrences>
            <paymentMethod>creditCard or eCheck or payPal</paymentMethod>
            <accountNumber>string</accountNumber>
            <invoice>string</invoice>
            <amount>decimal</amount>
            <currencyCode>string</currencyCode>
            <customerProfileId>int</customerProfileId>
            <customerPaymentProfileId>int</customerPaymentProfileId>
            <customerShippingProfileId>int</customerShippingProfileId>
          </subscriptionDetail>
          <subscriptionDetail>
            <id>int</id>
            <name>string</name>
            <status>active or expired or suspended or canceled or terminated</status>
            <createTimeStampUTC>dateTime</createTimeStampUTC>
            <firstName>string</firstName>
            <lastName>string</lastName>
            <totalOccurrences>int</totalOccurrences>
            <pastOccurrences>int</pastOccurrences>
            <paymentMethod>creditCard or eCheck or payPal</paymentMethod>
            <accountNumber>string</accountNumber>
            <invoice>string</invoice>
            <amount>decimal</amount>
            <currencyCode>string</currencyCode>
            <customerProfileId>int</customerProfileId>
            <customerPaymentProfileId>int</customerPaymentProfileId>
            <customerShippingProfileId>int</customerShippingProfileId>
          </subscriptionDetail>
        </subscriptionDetails>
      </ARBGetSubscriptionListResult>
    </ARBGetSubscriptionListResponse>
  </soap12:Body>
</soap12:Envelope>