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:
<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>
None
mbapi
command
showXMLHeader
params
subscriptionID
The ID of the subscription to fetch. This will always select at most 1 subscription.
clientID
Client this subscription is for.
subscriptionStatus
The status of the subscriptions to get.
subscriptionDateCreated
Timestamp to search by.
subscriptionDateCreatedGreaterThan
Get dates greater than this timestamp.
subscriptionDateCreatedLeast
Get dates greater than or equal to this timestamp.
subscriptionDateCreatedLessThan
Get dates Less than this timestamp.
subscriptionDateCreatedGreatest
Get dates Less than or equal to this timestamp.
subscriptionDateModified
Modify timestamp to search by.
subscriptionDateModifiedGreaterThan
Get modify dates greater than this timestamp.
subscriptionDateModifiedLeast
Get modify dates greater than or equal to this timestamp.
subscriptionDateModifiedLessThan
Get modify dates less than this timestamp.
subscriptionDateModifiedGreatest
Get modify dates less than or equal to this timestamp.
configGroupID
Config group id of gateway.
subscriptionAccountIdentifier
Value to identify the account the payment is made to.
sortDir
sortColumn
recordOffset
numRecords