getSubscriptionDetails¶
Request Method: GET
Description: Retrieve the subscription details for the account
URL: https://api.iovox.com:444/Subscriptions?v=3&method=getSubscriptionDetails
The following parameters can be sent in the querystring
Parameter | Description | Default Value | Data Type | Mandatory |
v | API version to use | INTEGER | YES | |
output | Specifying XML or JSON returns data in XML or JSON format | XML | STRING | NO |
Result¶
Error Result¶
HTTP Code | Error String | Resolution |
400 | API Version Empty | Add a value for the v parameter in the query string |
400 | API Version Invalid | Correct v parameter |
400 | Request Method must be GET. x attempted | Switch request method x to GET |
400 | Output Type Invalid | Correct output parameter |
500 | Internal Server Error | Retry later |
Success Result¶
<?xml version="1.0" encoding="utf-8"?>
<response>
<subscription_details>
<subscription_detail>
<recurring_credit>1000</recurring_credit>
<voxnumber_quantity>10</voxnumber_quantity>
<subscriber_location>
<subscriber_country>UNITED KINGDOM</subscriber_country>
<subscriber_city>LONDON</subscriber_city>
<subscriber_state/>
</subscriber_location>
<contract_start>2015-01-05</contract_start>
<contract_end>2015-05-05</contract_end>
</subscription_detail>
<subscription_detail>
<recurring_credit>700</recurring_credit>
<voxnumber_quantity>7</voxnumber_quantity>
<subscriber_location>
<subscriber_country>UNITED KINGDOM</subscriber_country>
<subscriber_city>LONDON</subscriber_city>
<subscriber_state/>
</subscriber_location>
</subscription_detail>
<contract_start>2015-05-05</contract_start>
<contract_end></contract_end>
</subscription_details>
</response>