Returns the UK domestic Plans: monthly plans with unlimited calls and unlimited SMS, from 1GB to unlimited data. The body is optional.
POST
/plans/search/domestic
curl \
--request POST 'https://zim.api.zimconnections.com/plans/search/domestic' \
--header "X-App-Identifier: $API_KEY" \
--header "Content-Type: application/json" \
--data '{
"planCategory": "REGULAR"
}'
Request example
{
"planCategory": "REGULAR"
}
Response examples (201)
[
{
"id": "plan_ukD01gbQwErTyUiOpAs",
"name": "United Kingdom - 1GB - Monthly",
"isRecurring": true,
"recurringInterval": "MONTHLY",
"scope": "LOCAL",
"category": "REGULAR",
"type": "VOICE_AND_DATA",
"destination": {
"name": "United Kingdom",
"isoAlpha3": "GBR"
},
"dataUnit": "GB",
"dataValue": 1,
"callUnit": "MINUTES",
"callValue": -1,
"smsUnit": "SMS",
"smsValue": -1,
"prices": [
{
"currencyISO": "gbp",
"value": 450,
"minorUnitsExponent": 2
}
]
},
{
"id": "plan_ukD03gbAsDfGhJkLzXc",
"name": "United Kingdom - 3GB - Monthly",
"isRecurring": true,
"recurringInterval": "MONTHLY",
"scope": "LOCAL",
"category": "REGULAR",
"type": "VOICE_AND_DATA",
"destination": {
"name": "United Kingdom",
"isoAlpha3": "GBR"
},
"dataUnit": "GB",
"dataValue": 3,
"callUnit": "MINUTES",
"callValue": -1,
"smsUnit": "SMS",
"smsValue": -1,
"prices": [
{
"currencyISO": "gbp",
"value": 650,
"minorUnitsExponent": 2
}
]
},
{
"id": "plan_ukD05gbZxCvBnMqWeRt",
"name": "United Kingdom - 5GB - Monthly",
"isRecurring": true,
"recurringInterval": "MONTHLY",
"scope": "LOCAL",
"category": "REGULAR",
"type": "VOICE_AND_DATA",
"destination": {
"name": "United Kingdom",
"isoAlpha3": "GBR"
},
"dataUnit": "GB",
"dataValue": 5,
"callUnit": "MINUTES",
"callValue": -1,
"smsUnit": "SMS",
"smsValue": -1,
"prices": [
{
"currencyISO": "gbp",
"value": 800,
"minorUnitsExponent": 2
}
]
},
{
"id": "plan_ukD10gbPoIuYtReWqLk",
"name": "United Kingdom - 10GB - Monthly",
"isRecurring": true,
"recurringInterval": "MONTHLY",
"scope": "LOCAL",
"category": "REGULAR",
"type": "VOICE_AND_DATA",
"destination": {
"name": "United Kingdom",
"isoAlpha3": "GBR"
},
"dataUnit": "GB",
"dataValue": 10,
"callUnit": "MINUTES",
"callValue": -1,
"smsUnit": "SMS",
"smsValue": -1,
"prices": [
{
"currencyISO": "gbp",
"value": 1000,
"minorUnitsExponent": 2
}
]
},
{
"id": "plan_ukD20gbMnBvCxZlKjHg",
"name": "United Kingdom - 20GB - Monthly",
"isRecurring": true,
"recurringInterval": "MONTHLY",
"scope": "LOCAL",
"category": "REGULAR",
"type": "VOICE_AND_DATA",
"destination": {
"name": "United Kingdom",
"isoAlpha3": "GBR"
},
"dataUnit": "GB",
"dataValue": 20,
"callUnit": "MINUTES",
"callValue": -1,
"smsUnit": "SMS",
"smsValue": -1,
"prices": [
{
"currencyISO": "gbp",
"value": 1200,
"minorUnitsExponent": 2
}
]
},
{
"id": "plan_ukD50gbGfDsApOiUyTr",
"name": "United Kingdom - 50GB - Monthly",
"isRecurring": true,
"recurringInterval": "MONTHLY",
"scope": "LOCAL",
"category": "REGULAR",
"type": "VOICE_AND_DATA",
"destination": {
"name": "United Kingdom",
"isoAlpha3": "GBR"
},
"dataUnit": "GB",
"dataValue": 50,
"callUnit": "MINUTES",
"callValue": -1,
"smsUnit": "SMS",
"smsValue": -1,
"prices": [
{
"currencyISO": "gbp",
"value": 1350,
"minorUnitsExponent": 2
}
]
},
{
"id": "plan_ukDunlYtReWqAsDfGhJ",
"name": "United Kingdom - Unlimited - Monthly",
"isRecurring": true,
"recurringInterval": "MONTHLY",
"scope": "LOCAL",
"category": "UNLIMITED",
"type": "VOICE_AND_DATA",
"destination": {
"name": "United Kingdom",
"isoAlpha3": "GBR"
},
"dataUnit": "GB",
"dataValue": -1,
"callUnit": "MINUTES",
"callValue": -1,
"smsUnit": "SMS",
"smsValue": -1,
"prices": [
{
"currencyISO": "gbp",
"value": 1500,
"minorUnitsExponent": 2
}
]
}
]
Response examples (400)
{
"statusCode": 400,
"message": [
"property foo should not exist"
],
"error": "Bad Request"
}