Skip to navigation

Start a subscription

Creates a Stripe Checkout session and returns its URL. Open that URL in a browser or in-app browser tab; Stripe takes the payment details, and the subscription is reconciled by webhook when checkout completes. Do not collect card details yourself.

For new subscribers only. An organisation that already has a live subscription gets 409 and should be sent to POST /api/v1/billing/change-plan or the customer portal instead.

Broker admins only, and refuses API-token auth.

Authentication

AuthorizationBearer

JWT access token obtained from POST /api/v1/auth/login, or a finput_sk_... API token

Request

This endpoint expects an object.
planenumOptional
Allowed values:

Response

Send the user to url.

urlstringOptionalformat: "uri"
session_idstringOptional

Errors

400
Bad Request Error
403
Forbidden Error
409
Conflict Error