Перейти к документации
API

Включить или выключить оплату по факту

Переключатель в разделе «Тарифы и оплата» и карта, которая нужна ему в первый раз.

PATCH/billing/pay-as-you-go

Выполняет любой из 2 запросов в вашем рабочем пространстве.

PATCH /billing/pay-as-you-go

Переключатель в разделе «Тарифы и оплата» и карта, которая нужна ему в первый раз.

Пример

Требуется billing:write. Выключение действует сразу, и использование останавливается на лимитах. Включение действует сразу, если карта сохранена. В первый раз checkoutUrl это ссылка, по которой человек добавляет карту, и оплата по факту начинается, когда он это сделал. theme и locale задают вид страницы, которую открывает ссылка.

curl
curl -X PATCH "$OE/billing/pay-as-you-go" -H "$AUTH" -H 'content-type: application/json' \  -d '{ "enabled": true, "locale": "de" }'
Ответ
{  "object": "pay_as_you_go_switch",  "enabled": false,  "suspended": false,  "activating": false,  "checkoutUrl": "https://checkout.example.com/c/7Yw2kq9RzX4mB1vN?locale=de"}

Через API ничего не оплачивается. Ссылка открывает страницу платёжного провайдера, где человек платит, меняет карту или отменяет, как и из приложения.

Токену доступа OAuth для этого вызова нужен код подтверждения. Пока приложение не подтвердило код за последние 60 минут, вызов отвечает 403 step_up_required и ничего не меняет. У API-ключа его никогда не спрашивают. Страница «Аутентификация» показывает, как запросить код и подтвердить его.

После оплаты

Требуется billing:write. Когда человек добавил карту, POST /billing/pay-as-you-go/confirm сверяется с платёжным провайдером и записывает это, как делает приложение, когда человек возвращается. enabled говорит, включена ли сейчас оплата по факту, и вызывать его повторно безопасно.

curl
curl -X POST "$OE/billing/pay-as-you-go/confirm" -H "$AUTH"
Ответ
{ "object": "pay_as_you_go_confirmation", "enabled": true }

activating: true от переключателя означает, что карту только что сохранили и оплата по факту включается, поэтому прочитайте её снова чуть позже.

Токену доступа OAuth для этого вызова нужен код подтверждения. Пока приложение не подтвердило код за последние 60 минут, вызов отвечает 403 step_up_required и ничего не меняет. У API-ключа его никогда не спрашивают. Страница «Аутентификация» показывает, как запросить код и подтвердить его.

Справочник