GetSubscriptions

Description

This class retrieves subscription information and optinonally product and order form information. This class should only be instantiated by dispatchMBAPI() found in include/mbapi/mbapi.php. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetSubscriptions command:

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Andy Christ

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<subscriptionID><!-- int --></subscriptionID>
			<clientID><!-- int --></clientID>
			<subscriptionStatus><!-- int --></subscriptionStatus>
			<subscriptionDateCreated><!-- int --></subscriptionDateCreated>
			<subscriptionDateCreatedGreaterThan><!-- int --></subscriptionDateCreatedGreaterThan>
			<subscriptionDateCreatedLeast><!-- int --></subscriptionDateCreatedLeast>
			<subscriptionDateCreatedLessThan><!-- int --></subscriptionDateCreatedLessThan>
			<subscriptionDateCreatedGreatest><!-- int --></subscriptionDateCreatedGreatest>
			<subscriptionDateModified><!-- int --></subscriptionDateModified>
			<subscriptionDateModifiedGreaterThan><!-- int --></subscriptionDateModifiedGreaterThan>
			<subscriptionDateModifiedLeast><!-- int --></subscriptionDateModifiedLeast>
			<subscriptionDateModifiedLessThan><!-- int --></subscriptionDateModifiedLessThan>
			<subscriptionDateModifiedGreatest><!-- int --></subscriptionDateModifiedGreatest>
			<configGroupID><!-- int --></configGroupID>
			<subscriptionAccountIdentifier><!-- string --></subscriptionAccountIdentifier>
			<sortDir><!-- None --></sortDir>
			<sortColumn><!-- None --></sortColumn>
			<recordOffset><!-- None --></recordOffset>
			<numRecords><!-- None --></numRecords>
		</params>
	</mbapi>

		

Example Response

None
		

Request Elements

mbapi
Type
None
Description
None
Children
command
Type
None
Description
None
showXMLHeader
Type
None
Description
None
params
Type
None
Description
None
Children
subscriptionID
Type
int
Description

The ID of the subscription to fetch. This will always select at most 1 subscription.

clientID
Type
int
Description

Client this subscription is for.

subscriptionStatus
Type
int
Description

The status of the subscriptions to get.

subscriptionDateCreated
Type
int
Description

Timestamp to search by.

subscriptionDateCreatedGreaterThan
Type
int
Description

Get dates greater than this timestamp.

subscriptionDateCreatedLeast
Type
int
Description

Get dates greater than or equal to this timestamp.

subscriptionDateCreatedLessThan
Type
int
Description

Get dates Less than this timestamp.

subscriptionDateCreatedGreatest
Type
int
Description

Get dates Less than or equal to this timestamp.

subscriptionDateModified
Type
int
Description

Modify timestamp to search by.

subscriptionDateModifiedGreaterThan
Type
int
Description

Get modify dates greater than this timestamp.

subscriptionDateModifiedLeast
Type
int
Description

Get modify dates greater than or equal to this timestamp.

subscriptionDateModifiedLessThan
Type
int
Description

Get modify dates less than this timestamp.

subscriptionDateModifiedGreatest
Type
int
Description

Get modify dates less than or equal to this timestamp.

configGroupID
Type
int
Description

Config group id of gateway.

subscriptionAccountIdentifier
Type
string
Description

Value to identify the account the payment is made to.

sortDir
Type
None
Description
None
sortColumn
Type
None
Description
None
recordOffset
Type
None
Description
None
numRecords
Type
None
Description
None

Response Elements

None