get
BillingUsage-BAN-get
The Billing Usage API enables you to view the traffic upon which your invoice is based directly from your own portal without having to log into the Verizon Enterprise Center. With this API, you can see the total gigabytes of data which are passed over a Secure Cloud Interconnect connection for a specified date range. Both ingress and egress traffic can be viewed. You are able to specify the traffic which you would like to see by providing the Billing Account Number (BAN) ID, month, and year. You have the option to enter a start date and end date in the month. The start and end dates are restricted to the 30/31 days in the month selected. If a start and end date are not provided, the data will be automatically pulled for the entire month. You will see usage detail for each Service ID under that BAN.
Resource URL
Environment | URL |
---|---|
Production |
https://digitalconnectproxy.verizon.com:443/sci /BillingUsage/{BAN} |
Test |
https://https://digitalconnectproxy.verizon.com:443/sci /BillingUsage/{BAN} |
Query Parameters
Name | Values | Description |
---|---|---|
startDay
(optional) |
A number between 1 - 31.Note :Cannot exceed current day of the month. |
|
endDay
(optional) |
A number between 1 - 31.Note : endDay should be >= startDay and cannot exceed current day of the month. |
|
month
(required) |
||
year
(required) |
Request Body Parameters
Attribute Name | Type | Description |
---|---|---|
usageData(Json Array) | ||
customerName | string | Name of the customer |
cloudType | string | Type of Cloud. Eg : VPC , Dedicated VPC,Public. |
aggregationRegion | string | Aggregated region of the SCI connection |
dataPlanName | string | SCI Connection plan name |
asOfDate | string | Usage comsumption date |
locationName | string | Location of Cloud Service Provider. |
aggregationFlag | string | Aggregation plan indicator |
overageConsumption | string | Data consumed past the data plan in GB. |
cumulativeUsage | string | Cumulative Usage of the month |
serviceId | string | Service Instance Id of the SCI Connection |
billCycleEndDate | string | Billing Cycle End Date |
billCycleStartDate | string | Billing Cycle Start Date |
cloudProvider | string | Cloud Service Provider Name |
dailyUsage | string | Usage comsumption of particular date (asOfDate) |
usageMeta(Json) | ||
timestamp | string | This is the current response time stamp of the usage data. It will be in " DD-MON-YY HH:MM:SS " format. |
ban | string | Billing Account Number of the Customer |
status | string | Status of the request ( success of failure ) |
monthYear | string | Month and Year value from the request |
Response Body Parameters
Attribute Name | Type | Description |
---|---|---|
usageData(Json Array) | ||
customerName | string | Name of the customer |
cloudType | string | Type of Cloud. Eg : VPC , Dedicated VPC,Public. |
aggregationRegion | string | Aggregated region of the SCI connection |
dataPlanName | string | SCI Connection plan name |
asOfDate | string | Usage comsumption date |
locationName | string | Location of Cloud Service Provider. |
aggregationFlag | string | Aggregation plan indicator |
overageConsumption | string | Data consumed past the data plan in GB. |
cumulativeUsage | string | Cumulative Usage of the month |
serviceId | string | Service Instance Id of the SCI Connection |
billCycleEndDate | string | Billing Cycle End Date |
billCycleStartDate | string | Billing Cycle Start Date |
cloudProvider | string | Cloud Service Provider Name |
dailyUsage | string | Usage comsumption of particular date (asOfDate) |
usageMeta(Json) | ||
timestamp | string | This is the current response time stamp of the usage data. It will be in " DD-MON-YY HH:MM:SS " format. |
ban | string | Billing Account Number of the Customer |
status | string | Status of the request ( success of failure ) |
monthYear | string | Month and Year value from the request |
Body Parameters
Sample Request
BAN Billing account number true
Please login to send the sample request and get a reponse back.
Working...