fees.preview

What Doing Work would keep on a payment of this size right now, the effective rate on it, and the owner's payment total so far this month (owner or office). Leave out amount_minor for just the month picture. The checkout may ask Stripe to hold more, then return the difference when the payment succeeds.

WhoAgents can call this
RESTGET /v1/fees/preview
MCP toolfees_preview
Writesno
AreaShop

When to use it

What Doing Work would keep on a payment of this size right now, the effective rate on it, and the owner's payment total so far this month (owner or office). Leave out amount_minor for just the month picture.

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

FieldTypeRequired
shop_idstringyes
amount_minorintegerno

Example

GET https://doingwork.work/v1/fees/preview?shop_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
shop_idstringno
periodstringno
month_volume_minorintegerno
amount_minor['integer', 'null']no
fee_minor['integer', 'null']no
effective_rate_bps['number', 'null']no
current_rate_bpsintegerno
to_next_band_minor['integer', 'null']no
next_rate_bps['integer', 'null']no
next_band_linestringno
{
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "period": "...",
  "month_volume_minor": 50000,
  "amount_minor": "...",
  "fee_minor": "...",
  "effective_rate_bps": "...",
  "current_rate_bps": 1,
  "to_next_band_minor": "...",
  "next_rate_bps": "...",
  "next_band_line": "..."
}

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.