---
title: "Create a consumer portal session"
method: POST
path: "/api/v2/consumer_portal/sessions"
tags: ["Consumer Portal Sessions"]
---

# Create a consumer portal session

`POST /api/v2/consumer_portal/sessions`

Creates a short-lived, single-use portal session token for a merchant-owned consumer. The returned URL can be used to redirect the consumer or embed the portal in an iframe.

## Request body

- CreatePortalSessionRequest
  - `organization_consumer_id` string, uuid, required
  - `subscription_id` string, uuid, nullable — Optional subscription to deep-link to. Must belong to the same organization_consumer_id. Forwarded to the portal as a URL query param so the SPA can route directly to that subscription on load.
  - `metered_subscription_id` string, uuid, nullable — Optional metered subscription to deep-link to. Must belong to the same organization_consumer_id. Forwarded to the portal as a URL query param so the SPA can route directly to that metered subscription on load.

## Response `201`

Successful Response

- PortalSessionResponse
  - `id` string
  - `url` string
  - `created_at` string, date-time
  - `expires_at` string, date-time

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/streampay/apis/stream-app.md) · [All operations](https://skmtc.dev/streampay/apis/stream-app/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/streampay/stream-app/revisions/515eeea7d260/schema)