Skip to main content
POST
/
v0
/
subscriptions
/
{id}
/
portal
Generate Portal Link
curl --request POST \
  --url https://api.paygentic.io/v0/subscriptions/{id}/portal \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expiresIn": "<string>"
}
'
{
  "object": "subscriptionPortal",
  "expiresAt": "2024-03-15T23:59:59Z",
  "url": "https://portal.paygentic.com/sub/sub_z1a2b3c4d5e6f7g8?token=xyz789abc123def456"
}

Authorizations

​
Authorization
string
header
required

API key authentication

Path Parameters

​
id
string
required

The subscription ID

Body

application/json
​
expiresIn
string<duration>

Token lifetime as an ISO 8601 duration. Defaults to PT10M (10 minutes). Maximum is P7D (7 days). Examples: PT10M, PT1H, P1D, P7D.

Response

Portal link generated successfully

​
object
enum<string>
required
Available options:
subscriptionPortal
​
expiresAt
string<date-time>
required

Portal link expiration timestamp in ISO 8601 format. Sample values: '2024-01-15T23:59:59Z', '2024-02-01T12:00:00Z'

​
url
string<uri>
required

Secure portal access URL for customer subscription management. Sample values: 'https://portal.paygentic.com/sub/abc123?token=xyz789', 'https://customer.example.com/portal/sub_456def'