Allo

Obtenir le prix d'un numéro

Renvoie ce que coûte aujourd'hui un numéro de plus sur le compte. Appelez-le avant Ajouter un numéro pour afficher ou vérifier le prix.

GET/v2/api/partner/accounts/{id}/numbers/price

Renvoie ce que coûte aujourd'hui un numéro de plus sur le compte. Appelez-le avant Ajouter un numéro pour afficher ou vérifier le prix.

  • included vaut true quand le compte paie déjà un emplacement de numéro qu'aucun numéro n'occupe. Le prochain numéro ne coûte alors rien, et amount_due_now vaut 0.
  • amount_due_now est le montant qu'Allo débite à l'ajout du numéro : le reste de la période de facturation en cours du compte, avec la remise de l'abonnement appliquée, taxes comprises.
  • unit_amount_before_discount est le prix d'un numéro pour une période de facturation complète, avant toute remise.
  • Les montants sont exprimés dans la plus petite unité de currency (centimes pour EUR et USD). currency est en minuscules, par exemple eur.
  • interval est la périodicité de facturation de l'abonnement du compte : MONTHLY ou YEARLY.
  • Un compte que votre API key n'a pas créé, ou déjà désactivé, renvoie 404 PARTNER_ACCOUNT_NOT_FOUND.

Le prix évolue au fil de la période de facturation, car le montant ne couvre que les jours restants. Relisez-le juste avant d'ajouter le numéro.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

idstringrequis

The account id returned by Create account (usr-*).

Réponses

200Price of one more number
dataobject
5 champs
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

401
402The 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
429
500Billing is temporarily unavailable (PARTNER_BILLING_UNAVAILABLE). Retry in a few seconds.
errorobject