Open the Stripe customer portal

Returns a URL for the Stripe-hosted portal, where the user can update their payment method, read full invoice history, change plan or cancel. Open it in a browser; do not attempt to render it in-app.

Pass flow: payment_method_update to land directly on the card-update screen — what a past-due prompt should link to.

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.

flowenumOptional

Deep-link to one portal screen. Omit for the portal home.

Allowed values:

Response

Send the user to url.

urlstringOptionalformat: "uri"

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

502

Bad Gateway Error