GET api/subscriptions/{subscriptionId}/balance

Retrieves the current balance of the specified subscription.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subscriptionId

The ID of the subscription for which to retrieve the balance.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

An object designating the subscription's current account balance as well as unbilled consumption balance.

SubscriptionAccountBalance
NameDescriptionTypeAdditional information
ConsumptionBalance

decimal number

None.
PrepaidBalance

decimal number

None.

Response Formats

application/json, text/json

Sample: 
{
  "ConsumptionBalance": 1.0,
  "PrepaidBalance": 2.0
}

text/html

Sample: 
{"ConsumptionBalance":1.0,"PrepaidBalance":2.0}

application/xml, text/xml

Sample: 
<SubscriptionAccountBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ConsumptionBalance>1</ConsumptionBalance>
  <PrepaidBalance>2</PrepaidBalance>
</SubscriptionAccountBalance>