Service Web Service

Service

Click here for a complete list of operations.

ARBGetSubscription

This method is used to get an existing ARB subscription detail. 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: api2.authorize.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.authorize.net/soap/v1/ARBGetSubscription"

<?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>
    <ARBGetSubscription xmlns="https://api.authorize.net/soap/v1/">
      <merchantAuthentication>
        <name>string</name>
        <transactionKey>string</transactionKey>
      </merchantAuthentication>
      <subscriptionId>long</subscriptionId>
      <clientId>string</clientId>
    </ARBGetSubscription>
  </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>
    <ARBGetSubscriptionResponse xmlns="https://api.authorize.net/soap/v1/">
      <ARBGetSubscriptionResult>
        <subscription>
          <name>string</name>
          <paymentSchedule>
            <interval xsi:nil="true" />
            <startDate>date</startDate>
            <totalOccurrences>short</totalOccurrences>
            <trialOccurrences>short</trialOccurrences>
          </paymentSchedule>
          <amount>decimal</amount>
          <trialAmount>decimal</trialAmount>
          <status>active or expired or suspended or canceled or terminated</status>
          <profile>
            <paymentProfile xsi:nil="true" />
            <shippingProfile xsi:nil="true" />
          </profile>
          <order>
            <invoiceNumber>string</invoiceNumber>
            <description>string</description>
          </order>
        </subscription>
      </ARBGetSubscriptionResult>
    </ARBGetSubscriptionResponse>
  </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: api2.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>
    <ARBGetSubscription xmlns="https://api.authorize.net/soap/v1/">
      <merchantAuthentication>
        <name>string</name>
        <transactionKey>string</transactionKey>
      </merchantAuthentication>
      <subscriptionId>long</subscriptionId>
      <clientId>string</clientId>
    </ARBGetSubscription>
  </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>
    <ARBGetSubscriptionResponse xmlns="https://api.authorize.net/soap/v1/">
      <ARBGetSubscriptionResult>
        <subscription>
          <name>string</name>
          <paymentSchedule>
            <interval xsi:nil="true" />
            <startDate>date</startDate>
            <totalOccurrences>short</totalOccurrences>
            <trialOccurrences>short</trialOccurrences>
          </paymentSchedule>
          <amount>decimal</amount>
          <trialAmount>decimal</trialAmount>
          <status>active or expired or suspended or canceled or terminated</status>
          <profile>
            <paymentProfile xsi:nil="true" />
            <shippingProfile xsi:nil="true" />
          </profile>
          <order>
            <invoiceNumber>string</invoiceNumber>
            <description>string</description>
          </order>
        </subscription>
      </ARBGetSubscriptionResult>
    </ARBGetSubscriptionResponse>
  </soap12:Body>
</soap12:Envelope>