Skip to navigation

Create a Hosted Billing Portal Session

View as Markdown

Open the authenticated user’s hosted billing portal for payment methods, invoices, and billing details. The body is optional; flow PAYMENT_METHOD_UPDATE opens straight to updating the card.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Request

This endpoint expects an object.
flowenumOptional

PAYMENT_METHOD_UPDATE opens straight to adding or replacing the card and returns to returnUrl when done, or subscription settings when returnUrl is omitted. Omit flow to open the portal home. Plan changes use POST /v1/billing/plan-changes and cancellation uses PATCH /v1/billing/subscription.

Allowed values:
returnUrlstring or nullOptional

Root-relative public-site return path, including query and fragment, for leaving the portal or completing a card update. Resolved only against the configured public-site origin. Absolute URLs, authority references, and malformed URI syntax are refused. Omit or pass null to return to /settings/subscription.

Response headers

X-RateLimit-LimitintegerOptional

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-RemainingintegerOptional

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-ResetintegerOptional

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

Created
urlstringformat: "uri"

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error