Service


Click here for a complete list of operations.

ARBCreateSubscription

This method is used to create a new ARB subscription. 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/ARBCreateSubscription"

<?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>
    <ARBCreateSubscription xmlns="https://api.authorize.net/soap/v1/">
      <merchantAuthentication>
        <name>string</name>
        <transactionKey>string</transactionKey>
      </merchantAuthentication>
      <subscription>
        <name>string</name>
        <paymentSchedule>
          <interval>
            <length>short</length>
            <unit>days or months</unit>
          </interval>
          <startDate>date</startDate>
          <totalOccurrences>short</totalOccurrences>
          <trialOccurrences>short</trialOccurrences>
        </paymentSchedule>
        <amount>decimal</amount>
        <trialAmount>decimal</trialAmount>
        <payment />
        <order>
          <invoiceNumber>string</invoiceNumber>
          <description>string</description>
        </order>
        <customer>
          <type>individual or business</type>
          <id>string</id>
          <email>string</email>
          <phoneNumber>string</phoneNumber>
          <faxNumber>string</faxNumber>
          <driversLicense>
            <number>string</number>
            <dateOfBirth>string</dateOfBirth>
          </driversLicense>
          <taxId>string</taxId>
        </customer>
        <billTo>
          <firstName>string</firstName>
          <lastName>string</lastName>
          <company>string</company>
          <address>string</address>
          <city>string</city>
          <state>string</state>
          <zip>string</zip>
          <country>string</country>
        </billTo>
        <shipTo>
          <firstName>string</firstName>
          <lastName>string</lastName>
          <company>string</company>
          <address>string</address>
          <city>string</city>
          <state>string</state>
          <zip>string</zip>
          <country>string</country>
        </shipTo>
      </subscription>
      <clientId>string</clientId>
    </ARBCreateSubscription>
  </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>
    <ARBCreateSubscriptionResponse xmlns="https://api.authorize.net/soap/v1/">
      <ARBCreateSubscriptionResult>
        <subscriptionId>long</subscriptionId>
      </ARBCreateSubscriptionResult>
    </ARBCreateSubscriptionResponse>
  </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>
    <ARBCreateSubscription xmlns="https://api.authorize.net/soap/v1/">
      <merchantAuthentication>
        <name>string</name>
        <transactionKey>string</transactionKey>
      </merchantAuthentication>
      <subscription>
        <name>string</name>
        <paymentSchedule>
          <interval>
            <length>short</length>
            <unit>days or months</unit>
          </interval>
          <startDate>date</startDate>
          <totalOccurrences>short</totalOccurrences>
          <trialOccurrences>short</trialOccurrences>
        </paymentSchedule>
        <amount>decimal</amount>
        <trialAmount>decimal</trialAmount>
        <payment />
        <order>
          <invoiceNumber>string</invoiceNumber>
          <description>string</description>
        </order>
        <customer>
          <type>individual or business</type>
          <id>string</id>
          <email>string</email>
          <phoneNumber>string</phoneNumber>
          <faxNumber>string</faxNumber>
          <driversLicense>
            <number>string</number>
            <dateOfBirth>string</dateOfBirth>
          </driversLicense>
          <taxId>string</taxId>
        </customer>
        <billTo>
          <firstName>string</firstName>
          <lastName>string</lastName>
          <company>string</company>
          <address>string</address>
          <city>string</city>
          <state>string</state>
          <zip>string</zip>
          <country>string</country>
        </billTo>
        <shipTo>
          <firstName>string</firstName>
          <lastName>string</lastName>
          <company>string</company>
          <address>string</address>
          <city>string</city>
          <state>string</state>
          <zip>string</zip>
          <country>string</country>
        </shipTo>
      </subscription>
      <clientId>string</clientId>
    </ARBCreateSubscription>
  </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>
    <ARBCreateSubscriptionResponse xmlns="https://api.authorize.net/soap/v1/">
      <ARBCreateSubscriptionResult>
        <subscriptionId>long</subscriptionId>
      </ARBCreateSubscriptionResult>
    </ARBCreateSubscriptionResponse>
  </soap12:Body>
</soap12:Envelope>