PlanQuoteResult
catalog object
Every currency at least one plan can be bought in, base currency first.
["brl","usd","eur"]quotes object[]
The quantity fits under the plan’s cap. A plan that does not fit is quoted but never recommended.
Units charged: the billable numbers on a per-number plan, the copies on a stackable plan, 1 on any other flat plan.
What one period costs.
The same amount per month — only for comparing plans of different periods.
How many more numbers still fit, when the plan has a cap.
recommended objectnullable
The cheapest per month among the plans that fit.
The quantity fits under the plan’s cap. A plan that does not fit is quoted but never recommended.
Units charged: the billable numbers on a per-number plan, the copies on a stackable plan, 1 on any other flat plan.
What one period costs.
The same amount per month — only for comparing plans of different periods.
How many more numbers still fit, when the plan has a cap.
family objectnullable
The recommended plan’s family, with monthly and annual side by side when it sells both.
monthly objectnullable
The quantity fits under the plan’s cap. A plan that does not fit is quoted but never recommended.
Units charged: the billable numbers on a per-number plan, the copies on a stackable plan, 1 on any other flat plan.
What one period costs.
The same amount per month — only for comparing plans of different periods.
How many more numbers still fit, when the plan has a cap.
annual objectnullable
The quantity fits under the plan’s cap. A plan that does not fit is quoted but never recommended.
Units charged: the billable numbers on a per-number plan, the copies on a stackable plan, 1 on any other flat plan.
What one period costs.
The same amount per month — only for comparing plans of different periods.
How many more numbers still fit, when the plan has a cap.
selected objectnullable
The quantity fits under the plan’s cap. A plan that does not fit is quoted but never recommended.
Units charged: the billable numbers on a per-number plan, the copies on a stackable plan, 1 on any other flat plan.
What one period costs.
The same amount per month — only for comparing plans of different periods.
How many more numbers still fit, when the plan has a cap.
They depend on the account — always null on GET /plans/quote.
They depend on the account — always null on GET /plans/quote.
{
"numbers": 0,
"catalog": {
"numbers": 0,
"currencies": [
"brl",
"usd",
"eur"
],
"quotes": [
{
"planId": "string",
"slug": "string",
"name": "string",
"family": "string",
"interval": "string",
"intervalCount": 0,
"fits": true,
"quantity": 0,
"stackable": true,
"currency": "string",
"amountCents": 0,
"monthlyEquivalentCents": 0,
"headroom": 0,
"trialDays": 0
}
],
"recommended": {
"planId": "string",
"slug": "string",
"name": "string",
"family": "string",
"interval": "string",
"intervalCount": 0,
"fits": true,
"quantity": 0,
"stackable": true,
"currency": "string",
"amountCents": 0,
"monthlyEquivalentCents": 0,
"headroom": 0,
"trialDays": 0
},
"family": {
"family": "string",
"monthly": {
"planId": "string",
"slug": "string",
"name": "string",
"family": "string",
"interval": "string",
"intervalCount": 0,
"fits": true,
"quantity": 0,
"stackable": true,
"currency": "string",
"amountCents": 0,
"monthlyEquivalentCents": 0,
"headroom": 0,
"trialDays": 0
},
"annual": {
"planId": "string",
"slug": "string",
"name": "string",
"family": "string",
"interval": "string",
"intervalCount": 0,
"fits": true,
"quantity": 0,
"stackable": true,
"currency": "string",
"amountCents": 0,
"monthlyEquivalentCents": 0,
"headroom": 0,
"trialDays": 0
},
"annualSavingsCents": 0,
"annualSavingsPercent": 0
}
},
"selected": {
"planId": "string",
"slug": "string",
"name": "string",
"family": "string",
"interval": "string",
"intervalCount": 0,
"fits": true,
"quantity": 0,
"stackable": true,
"currency": "string",
"amountCents": 0,
"monthlyEquivalentCents": 0,
"headroom": 0,
"trialDays": 0
},
"subtotalCents": 0,
"discountCents": 0,
"totalCents": 0,
"currency": "string",
"coupon": {},
"trial": {}
}