Returns what adding one more number to the account costs today. When the account already pays for a free number slot, included is true and amount due now is…
GET/v2/api/partner/accounts/{id}/numbers/price
Returns what adding one more number to the account costs today. Call it before Add number to show or check the price.
included is true when the account already pays for a number slot that no number uses. The next number then costs nothing, and amount_due_now is 0.
amount_due_now is what Allo charges when you add the number: the rest of the account's current billing period, with the subscription's discount applied, tax included.
unit_amount_before_discount is the price of one number for a full billing period, before any discount.
Amounts are in the smallest unit of currency (cents for EUR and USD). currency is lowercase, for example eur.
interval is the billing interval of the account's subscription: MONTHLY or YEARLY.
An account your API key did not create, or one already deactivated, returns 404 PARTNER_ACCOUNT_NOT_FOUND.
The price changes over the billing period, because the charge covers only the days left. Read it again right before you add the number.
Authorization
Authorizationstring · headerrequired
Api-Key ak_live_…
Path parameters
idstringrequired
The account id returned by Create account (usr-*).
Responses
200Price of one more number
dataobject
5 fields
includedboolean
true when the account already pays for a number slot that no number uses: the next number costs nothing.
unit_amount_before_discountinteger<int64>
The price of one number for a full billing period, before discount, in the smallest currency unit.
amount_due_nowinteger<int64>
What Allo charges when you add the number: prorated to the end of the current period, net of the subscription's discount, tax included. 0 when included is true.
currencystring
Lowercase ISO 4217 code of the account's subscription.
intervalenum<string>
Billing interval of the account's subscription.
MONTHLYYEARLY
401402The account has no subscription Allo can bill (PARTNER_SUBSCRIPTION_NOT_BILLABLE).
errorobject
403The API key lacks the PARTNER scope.
errorobject
404No account with this id was provisioned by your API key, or the account is deactivated (PARTNER_ACCOUNT_NOT_FOUND).
errorobject
429500Billing is temporarily unavailable (PARTNER_BILLING_UNAVAILABLE). Retry in a few seconds.