Get Total Postpaid Fee | PhoenBox Developer API Reference

# Get Total Postpaid Fee

This service is used to get the fee amount for the postpaid plan dedicated to the partner.

# Request Configuration

# Request Endpoint

/api/Activation/GetTotalPostpaid

# Request Method

GET

# Request Headers

Name	Type	Description
client	`string`	Use `bid` returned from Login
apitoken	`string`	Use `token` returned from Login

# Request Parameters:

Name	Type	Description
orderSimcard (**required)	`boolean`	If not ordering the SIM card, use `False`. If using this Service for individual client to order the SIM card, use `True`. If it's a bulk corporate ordering SIM Cards, please contact PhoneBox Account managers for SIM cards ordering.
PlanId (**required)	`int`	Select the plan that is activation, use `planID` returned from Get Postpaid Plans
CountryId (**required)	`int`	Service country ID, must use `42`.
ProvinceCode (**required)	`string`	Use the Two-Letter Postal Abbreviation for Canadian provinces (opens new window), e.g., `BC`, `QC`.
start (**required)	`DateTime`	Use format `YYYY-MM-DD` If already have a SIM Card, then use a date that is not in the past If using this Service for individual client to order the SIM card For develivery within Canada or US must use a minimum date of `currentDate` plus `7 days` For develivery outside Canada or US, must use a minimum date of `currentDate` plus `20 days`
promocode	`string`	Use `PromoCode` returned from VerifySimcard

# Request Body

None

# Sample Reqeust

# Sample Request URL

http://localhost:60904/api/Activation/GetTotalPostpaid?orderSimCard=True&PlanID=6666&CountryId=42&ProvinceCode=BC&start=2020-10-31&promocode=MyPromoCode

# cURL

curl --location --request GET 'http://localhost:60904/api/Activation/GetTotalPostpaid?orderSimCard=True&PlanID=6666&CountryId=42&ProvinceCode=BC&start=2020-10-31&promocode=MyPromoCode' \
--header 'client: 6666' \
--header 'apitoken: foqxcFJ82EhecRXnIZbeQbb8m9/dFFHO'

# Python - Requests

import requests
url = "http://localhost:60904/api/Activation/GetTotalPostpaid"

params = {
        'orderSimCard': 'True', 
        'PlanID': '66666',
        'CountryId': '247',
        'ProvinceCode': 'ON',
        'start': '2020-10-31',
        'promocode': 'MyPromoCode' 
}

headers = {
    'client': '1234',
    'apitoken': 'foqxcFJ82EhecRXnIZbeQbb8m9/dFFHO'
}
response = requests.get(url, headers=headers, params=params)

print(response.text.encode('utf8'))

# NodeJs -Axios

var axios = require('axios');

var data = {};

const url = "http://localhost:60904/api/Activation/GetTotalPostpaid"

axios
    .get(
        url,
        {
            headers: {
                client: '66666',
                apitoken: 'foqxcFJ82EhecRXnIZbeQbb8m9'
            },
            params: {
                orderSimCard: 'True', 
                PlanID: '66666',
                CountryId: '247',
                ProvinceCode: 'ON',
                start: '2020-10-31',
                promocode: 'MyPromoCode' 
            }
        }
    )
    .then(res => {
        console.log(JSON.parse(res.data));
    })
    .catch(err => {
        console.log(err);
    });

# Response

# Success

return a list of JSON containing below information

[[
    {
        "currency": "CAD",
        "plan_Amt": 45.00,
        "prorate_Duration": "Oct 31, 2020~Nov 01, 2020",
        "charge_Duration": "Nov 02, 2020~Dec 01, 2020",
        "prorate_Amt": 3.00,
        "simcard_amt": 0.0,
        "subtotal": 48.00,
        "gst_rate": 5.000,
        "pst_rate": 7.000,
        "gst_Amt": 2.40,
        "pst_Amt": 3.36,
        "promo_Amt": 0.00,
        "total": 53.76,
        "prorate_Start": "Oct 31, 2020",
        "prorate_End": "Nov 01, 2020",
        "prorate_DataCap": "204.80 MB",
        "firstmonth_DataCap": "204.80 MB",
        "charge_Start": "Nov 02, 2020",
        "dataaddon_Fee": 0.0,
        "prorate_Pct": 0.07
    }
]

# Fail

Failed Authorization

reason: wrong login credential

{
    "Message": "Authorization has been denied for this request."
}

← Get Prepaid Plans Get TotalPrepaid Fee →