Глоссарий и единицы
Деньги
- Суммы в API и сущностях (
amount,totalAmount, …) задаются в минорных единицах валюты (обычно центы / копейки), если явно не указано иное в поле. - При отображении пользователю делите на 100 для валют с двумя знаками после запятой.
НДС и taxPercentage
Во внутреннем представлении API:
- значение 1000 соответствует 10%;
- формула уровня «процент × сумма» реализована в утилитах биллинга (см. код
utility.ConvertTaxPercentageToInternalFloatи аналоги).
Всегда сверяйте с актуальным Swagger при изменении версии API.
Сущности (кратко)
| Термин | Значение |
|---|---|
| Merchant | Организация-продавец в BillBill |
| User / Customer | Конечный покупатель в контексте мерчанта |
| Product | Группа тарифов |
| Plan | Тариф: тип 1/2/3, цена, интервал |
| Subscription | Экземпляр подписки пользователя на план |
| Invoice | Счёт на оплату |
| Payment | Попытка списания в шлюзе |
| Metric | Определение учёта usage/лимита |
| Metric event | Факт использования, переданный в API |
Внешние идентификаторы
Часто используются поля externalPlanId, externalEventId, externalPaymentId (точный набор — в OpenAPI) для связки с вашей CRM/ERP.