Рекуррентные платежи

Доступность изменения

Показывает, можно ли сейчас запросить изменение суммы или расписания подписки

GET/integration/subscriptions/{uuid}/update-supported

Передавайте UUID подписки Cashera и X-Api-Key её владельца. Тело запроса и Idempotency-Key не нужны. При известном идентификаторе подписки у провайдера метод запрашивает его текущее решение и ничего не изменяет. Если создание ещё не получило такой идентификатор, возвращаетсяsupported: false без внешнего запроса. Чужая или неизвестная подписка возвращает 404.

200 OK
curl 'https://api.cashera.cash/api/v1/integration/subscriptions/31dc7faa-c380-4ec7-a258-3202a2211e76/update-supported' \
-H "X-Api-Key: $CASHERA_API_KEY" \
-H 'Accept: application/json'

Как использовать результат

  • true: можно предложить пользователю изменить условия, но окончательная проверка выполняется при POST
  • false: изменение сейчас недоступно, например, привязка ещё не активна, запрошена отмена или выполняется списание
  • HTTP-ошибка: доступность не удалось определить. Не подменяйте её значением true

Проверка необязательна. Ваш сервер может сразу вызвать метод изменения условий и обработать его ответ. Между GET и POST состояние может измениться, поэтому supported: trueне гарантирует успешное обновление. Результат не стоит кешировать как постоянное свойство подписки.

Это не проверка доступности списания

Не используйте supported как разрешение на внеочередное списание. У этого действия собственные проверки привязки и состояния подписки. Значение false также не означает отмену подписки.

Ошибки

401: проверьте API-ключ; 404: UUID и владельца подписки;429: уменьшите частоту запросов; 5xx: проверка у провайдера временно не удалась. GET можно безопасно повторить с паузой. Не превращайте ошибку проверки в вызов списания. Общий порядок описан в инструкции по восстановлению.