Skip to content
SegmentationAPI

Create a billing portal session

POST
/v1/billing/portal
curl --request POST \
  --url https://api.segmentationapi.com/v1/billing/portal \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: example'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
>= 1 characters <= 128 characters

Responses

Section titled “Responses”

201

Section titled “201”

Portal URL

Media typeapplication/json
object
url
required
string format: uri
Examplegenerated
{
  "url": "https://example.com"
}

401

Section titled “401”

Authentication is missing, invalid, or expired

Media typeapplication/json
object
error
required
string
message
string
remainingTokens
integer
requestedTokens
integer
>= 1
expiresAt
string format: date-time
activeJobId
string
upgradeUrl
string format: uri
retryAfterSeconds
integer
>= 1
Examplegenerated
{
  "error": "example",
  "message": "example",
  "remainingTokens": 1,
  "requestedTokens": 1,
  "expiresAt": "2026-04-15T12:00:00Z",
  "activeJobId": "example",
  "upgradeUrl": "https://example.com",
  "retryAfterSeconds": 1
}