Pay an open purchase with a shared payment token.

Callable by any active identity of the workspace. The mandate is read from the instrument at Stripe. A successful charge answers status payment_received with activated false; the webhook activates the period. Paying an already active purchase changes nothing.

post/purchases/{id}/pay

Request

  • Base URL: https://forbiz.io/api/public/agent
  • URL: https://forbiz.io/api/public/agent/purchases/{id}/pay
  • Auth: HTTP bearer

Path parameters

idstring required

Headers

Idempotency-Keystring

Recommended on every mutating request. A replay with the same key is NOT applied twice: the server answers { ok, idempotent_replay: true, first_seen_at, status } describing the first attempt.

Request body

Response

Payment received; the webhook activates the period

object required

Changes

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