tools

Propose recurring kind

Use this when the user says a recurring payment should be a bill or a subscription, for example that a Zelle payment is rent. Propose marking one of the user's recurring outgoing payments as a bill or a subscription. Get the streamId first with betteroff_list_recurring. This tool changes nothing: the user opens the review link and approves it in BetterOff. Never say the change is done.

post/v1/tools/betteroff_propose_recurring_kind

Request

  • Base URL: https://api.betteroff.finance
  • URL: https://api.betteroff.finance/v1/tools/betteroff_propose_recurring_kind
  • Auth: one of:
    • OpenID Connect (https://app.betteroff.finance/api/auth/.well-known/openid-configuration, scopes: cashflow:read, corrections:prepare)
    • HTTP bearer

Request body

streamIdstring required

The streamId from betteroff_list_recurring.

kind'bill' | 'subscription' required

What the payment should be marked as.

Response

Tool result

OR

Changes

No recorded changes to this operation across all 1 revision of this API.