Members

Preview the billing effect of inviting one more member

Whether the next invite consumes a newly-billed seat and, if so, the exact prorated charge that lands when the invitee accepts. Drives the cost warning in the invite dialog.

get/accounts/members/seat-preview

Request

  • Base URL: https://api.nippy.host
  • URL: https://api.nippy.host/accounts/members/seat-preview
  • Auth: bearer (a scheme the document does not define)

Response

addsBilledSeatboolean required

Whether inviting one more member consumes a newly-billed seat. False when a pre-paid seat is free to fill (e.g. Team’s 2-seat floor, or a seat freed by a removal this period).

immediateChargePencenumber required

Exact prorated charge (pence) added to the invoice when the seat is taken on accept; 0 when no billed seat is added.

recurringPerSeatPencenumber required

Per-seat recurring price (pence) at the current cadence.

interval'month' | 'year' required

Current billing cadence.

currencystring required

ISO currency code (e.g. gbp).

Changes

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