# Get Total Postpaid Fee

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

# 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 boolean
  • Use True for individual client to order the SIM card, or using eSIM.
  • Otherwise use False.
  • Note: if it's a bulk corporate ordering SIM Cards, please contact PhoneBox Account managers for SIM cards ordering.
PlanId int Select the plan that is activation, use planID returned from Get Postpaid Plans
CountryId int Service country ID, must use 42.
ProvinceCode string Use the Two-Letter Postal Abbreviation for Canadian provinces (opens new window), e.g., BC, QC.
start 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

https://phoneboxapi.azurewebsites.net/api/Activation/GetTotalPostpaid?orderSimCard=True&PlanID=1343&CountryId=42&ProvinceCode=BC&start=2025-10-31&promocode=MyPromoCode

# cURL

curl --location --request GET 'https://phoneboxapi.azurewebsites.net/api/Activation/GetTotalPostpaid?orderSimCard=True&PlanID=1343&CountryId=42&ProvinceCode=BC&start=2025-10-31&promocode=MyPromoCode' \
--header 'client: 1234' \
--header 'apitoken: foqxcFJ82EhecRXnIZbeQbb8m9/dFFHO'

# Python - Requests

import requests
url = "https://phoneboxapi.azurewebsites.net/api/Activation/GetTotalPostpaid"

params = {
        'orderSimCard': 'True', 
        'PlanID': '1343',
        'CountryId': '42',
        'ProvinceCode': 'BC',
        'start': '2025-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 = "https://phoneboxapi.azurewebsites.net/api/Activation/GetTotalPostpaid"

axios
    .get(
        url,
        {
            headers: {
                client: '1234',
                apitoken: 'foqxcFJ82EhecRXnIZbeQbb8m9/dFFHO'
            },
            params: {
                orderSimCard: 'True', 
                PlanID: '1343',
                CountryId: '42',
                ProvinceCode: 'BC',
                start: '2025-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": 30,
    "prorate_Duration": "Oct 31, 2025~Nov 01, 2025",
    "charge_Duration": "Nov 02, 2025~Dec 01, 2025",
    "prorate_Amt": 2,
    "simcard_amt": 0,
    "subtotal": 32,
    "gst_rate": 5,
    "pst_rate": 7,
    "gst_Amt": 1.6,
    "pst_Amt": 2.24,
    "promo_Amt": 0,
    "total": 35.84,
    "prorate_Start": "Oct 31, 2025",
    "prorate_End": "Nov 01, 2025",
    "prorate_DataCap": "136.53 MB",
    "firstmonth_DataCap": "136.53 MB",
    "charge_Start": "Nov 02, 2025",
    "dataaddon_Fee": 0,
    "prorate_Pct": 0.07,
    "shipping_Fee": 0
  }
]

# Fail

Failed Authorization

reason: wrong login credential

{
    "Message": "Authorization has been denied for this request."
}
LastUpdated: 5/30/2024, 1:34:33 PM