Обновление информации о бюджете расходов

Метод используется для обновления бюджета расходов, созданного в результате вызова метода Создание бюджета расходов, по активной подписке с оплатой по мере потребления (pay-as-you-go, PAYG) для аккаунта, к которому есть доступ у текущего пользователя, а также настроек связанных уведомлений.

PATCH {reseller_domain}/internal_api/accounts/{account_id}/spending_budgets/{spending_budget_id}

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе и созданной асинхронной задачи
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
account_id	path	integer	Обязательный	ID аккаунта, которому принадлежит подписка
spending_budget_id	path	integer	Обязательный	ID бюджета расходов
budget_amount	form	number	Опциональный	Величина бюджета расходов по подписке: от 0.01 до 2147483647.00 в валюте реселлера
notification_threshold	form	number	Опциональный	Процент бюджета расходов `budget_amount` для отправки дополнительного уведомления: от 0.00 до 100. Если `notification_threshold = 0`, дополнительное уведомление не отправляется
recipients	form	array	Опциональный	Список ID тех активных пользователей аккаунта (см. Получение списка активных пользователей ), которым платформа пришлет уведомление при достижении заданного бюджета расходов `budget_amount`, а также дополнительное уведомление при достижении заданного процента бюджета расходов `notification_threshold > 0`
period	form	string	Опциональный	Период, на который устанавливается бюджет расходов: month — месяц. quarter — квартал. year — год. В текущей версии поддерживается только `period = month`

Модель ответа

Модель ответа соответствует методу Создание бюджета расходов.

Пример запроса

Bash

curl --location --request PATCH 'https://test.activeplatform.com/internal_api/accounts/1938/spending_budgets/2' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample' \
--data-raw '{
  "data": {
    "attributes": {
      "budget_amount": 20000,
      "notification_threshold": 80,
      "recipients": [
        982
      ],
      "period": "month"
    }
  }
}'

Пример ответа

JSON

{
    "data": {
        "id": "2",
        "type": "spending_budgets",
        "attributes": {
            "spending_budget_id": 2,
            "budget_amount": 20000,
            "notification_threshold": 80,
            "recipients": [
                982
            ],
            "period": "month",
            "target_type": "subscription",
            "target_id": 5202
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}