ProBusinessTools


Click here for a complete list of operations.

GetBillPlanList

Recurring Billing Module Users Only: This method returns an object array of "Bill Plans" based on search elements provided via the SearchBillPlanRequest structure.

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 /publicwebservices/probusinesstools.asmx HTTP/1.1
Host: secure.probusinesstools.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://secure.probusinesstools.com/publicWebServices/GetBillPlanList"

<?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>
    <GetBillPlanList xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <bpRequest>
        <InternalPlanID>string</InternalPlanID>
        <PlanName>string</PlanName>
        <UnitDesc>string</UnitDesc>
        <UnitPrice>string</UnitPrice>
      </bpRequest>
    </GetBillPlanList>
  </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>
    <GetBillPlanListResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <GetBillPlanListResult>
        <SearchBillPlanResponse>
          <InternalID>string</InternalID>
          <PlanName>string</PlanName>
          <CreationDate>string</CreationDate>
          <TerminationDate>string</TerminationDate>
          <UnitTypes>
            <BillPlanUnits xsi:nil="true" />
            <BillPlanUnits xsi:nil="true" />
          </UnitTypes>
        </SearchBillPlanResponse>
        <SearchBillPlanResponse>
          <InternalID>string</InternalID>
          <PlanName>string</PlanName>
          <CreationDate>string</CreationDate>
          <TerminationDate>string</TerminationDate>
          <UnitTypes>
            <BillPlanUnits xsi:nil="true" />
            <BillPlanUnits xsi:nil="true" />
          </UnitTypes>
        </SearchBillPlanResponse>
      </GetBillPlanListResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </GetBillPlanListResponse>
  </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 /publicwebservices/probusinesstools.asmx HTTP/1.1
Host: secure.probusinesstools.com
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>
    <GetBillPlanList xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <bpRequest>
        <InternalPlanID>string</InternalPlanID>
        <PlanName>string</PlanName>
        <UnitDesc>string</UnitDesc>
        <UnitPrice>string</UnitPrice>
      </bpRequest>
    </GetBillPlanList>
  </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>
    <GetBillPlanListResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <GetBillPlanListResult>
        <SearchBillPlanResponse>
          <InternalID>string</InternalID>
          <PlanName>string</PlanName>
          <CreationDate>string</CreationDate>
          <TerminationDate>string</TerminationDate>
          <UnitTypes>
            <BillPlanUnits xsi:nil="true" />
            <BillPlanUnits xsi:nil="true" />
          </UnitTypes>
        </SearchBillPlanResponse>
        <SearchBillPlanResponse>
          <InternalID>string</InternalID>
          <PlanName>string</PlanName>
          <CreationDate>string</CreationDate>
          <TerminationDate>string</TerminationDate>
          <UnitTypes>
            <BillPlanUnits xsi:nil="true" />
            <BillPlanUnits xsi:nil="true" />
          </UnitTypes>
        </SearchBillPlanResponse>
      </GetBillPlanListResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </GetBillPlanListResponse>
  </soap12:Body>
</soap12:Envelope>