MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetProductUsagePrices

GetProductUsagePrices

Description

Command to get product ledger entries and their filter cycles and currencies.

Attributes

Product
modernbill
subProduct
mbapi
version
0.9
author
Kris Bailey

Example Request

	<mbapi>
		<command><!-- string --></command>
		<showXMLHeader><!-- boolean --></showXMLHeader>
		<params>
			<productUsagePriceID><!-- int --></productUsagePriceID>
			<productID><!-- int --></productID>
			<currencyID><!-- string --></currencyID>
			<productUsagePriceAmount><!-- double --></productUsagePriceAmount>
			<productUsagePriceAmountGreaterThan><!-- double --></productUsagePriceAmountGreaterThan>
			<productUsagePriceAmountLessThan><!-- double --></productUsagePriceAmountLessThan>
			<productUsagePriceAmountGreatest><!-- double --></productUsagePriceAmountGreatest>
			<productUsagePriceAmountLeast><!-- double --></productUsagePriceAmountLeast>
		</params>
	</mbapi>

Example Response

	<mbapi>
		<header>
			<remoteSessionID><!-- hex --></remoteSessionID>
			<errorCount><!-- int --></errorCount>
			<errors>
				<error>
					<title><!-- string --></title>
					<message><!-- string --></message>
				</error>
			</errors>
			<numResults><!-- int --></numResults>
			<numAffectedRows><!-- int --></numAffectedRows>
		</header>
		<results>
			<productUsagePrices>
				<productUsagePrice>
					<productUsagePriceID><!-- int --></productUsagePriceID>
					<productID><!-- int --></productID>
					<currencyID><!-- string --></currencyID>
					<productUsagePriceAmount><!-- double --></productUsagePriceAmount>
				</productUsagePrice>
			</productUsagePrices>
		</results>
	</mbapi>

Request Elements

mbapi
Type
group
Description

MBAPI request document root.

Children
command
Type
string
Description

Required. The string GetProductUsagePrices.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

GetProductUsagePrices parameters.

Children
productUsagePriceID
Type
int
Description

Product usage price id.

productID
Type
int
Description

Product ID to get all the ledger entries for.

currencyID
Type
string
Description

Currency ID the entry will be made in.

productUsagePriceAmount
Type
double
Description

Product usage price amount.

productUsagePriceAmountGreaterThan
Type
double
Description

Product usage price amount to be greater than.

productUsagePriceAmountLessThan
Type
double
Description

Product usage price amount to be less than.

productUsagePriceAmountGreatest
Type
double
Description

Product usage price amount to be less than or equal to.

productUsagePriceAmountLeast
Type
double
Description

Product usage price amount to be greater than or equal to.

Response Elements

mbapi
Type
group
Description

MBAPI response document root.

Children
header
Type
group
Description

Contains result meta data: data about the result itself.

Children
remoteSessionID
Type
hex
Description

A session ID that may be used for authentication instead of a remote access hash.

errorCount
Type
int
Description

The number of errors that occured.

errors
Type
group
Description

Contains any errors that occured.

Children
error
Type
group
Description

Contains information relating to a single error. Occurs header errorCount times.

Children
title
Type
string
Description

The title of the error.

message
Type
string
Description

The error message.

numResults
Type
int
Description

The number of results that have been returned. For Get commands.

numAffectedRows
Type
int
Description

The number of rows that have been affected. For Set commands.

results
Type
None
Description
None
Children
productUsagePrices
Type
None
Description
None
Children
productUsagePrice
Type
None
Description
None
Children
productUsagePriceID
Type
int
Description

Product usage price ID.

productID
Type
int
Description

Product ID to get all the ledger entries for.

currencyID
Type
string
Description

Currency ID the entry will be made in.

productUsagePriceAmount
Type
double
Description

Product usage price amount.