---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Portal sessions"
description: "The `portal_sessions` collection of Sylphx Money: A Portal Session is a hosted page where a subject manages its subscriptions, payment method, and invoices."
type: reference
product: payments
summary: "A Portal Session is a hosted page where a subject manages its subscriptions, payment method, and invoices."
updated: 2026-09-28
order: 900
---

A Portal Session is a hosted page where a subject manages its subscriptions, payment method, and invoices.

**Service** Sylphx Money · **Resource type** `money.sylphx.com/PortalSession` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/portal_sessions/{portal_session}` · **Shape** `record`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/portal_sessions/{portal_session}`. |
| `uid` | `string` | `pts_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `subject` | `Subject` | Whose portal. Required. |
| `return_url` | `string` | Where the portal's back link goes. HTTPS only. Required. |
| `url` | `string` | The hosted page; valid for a few minutes. Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `POST` | [`create`](/docs/api/portal_sessions#create) | Creates a customer portal session for a subject. |
| `GET` | [`get`](/docs/api/portal_sessions#get) | Gets a portal session. |

## create

Creates a customer portal session for a subject.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/portal_sessions` · scope `billing:write` · effect `write` · [Request, response and examples](/docs/api/portal_sessions/create)

## get

Gets a portal session.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/portal_sessions/portal-session` · scope `billing:read` · effect `read` · [Request, response and examples](/docs/api/portal_sessions/get)