Create Portal Link Sharing Session

POST

billing

customer-session

create

portal-link-sharing

curl -X POST https://api.alguna.io/billing/customer-session/create/portal-link-sharing \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "acc_abc123"
  }'

const session = await alguna.billingSessions.createPortalLink({
  accountId: 'acc_abc123'
});

// Share session.sessionUrl with customer

{
  "id": "sess_def456",
  "sessionToken": "tok_def456...",
  "sessionUrl": "https://portal.alguna.io/hs/tok_def456..."
}

Create a shareable customer portal session link. The link can be sent to customers to access their billing portal.

accountId

string

required

The account ID.

curl -X POST https://api.alguna.io/billing/customer-session/create/portal-link-sharing \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "acc_abc123"
  }'

const session = await alguna.billingSessions.createPortalLink({
  accountId: 'acc_abc123'
});

// Share session.sessionUrl with customer

{
  "id": "sess_def456",
  "sessionToken": "tok_def456...",
  "sessionUrl": "https://portal.alguna.io/hs/tok_def456..."
}

string

Session identifier.

sessionToken

string

Token for the session.

sessionUrl

string

Shareable URL for the customer portal.

Portal visibility settings (plan overview, billing details, invoice list, etc.) are inherited from your organization’s customer portal configuration.

⌘I

curl -X POST https://api.alguna.io/billing/customer-session/create/portal-link-sharing \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "acc_abc123"
  }'

const session = await alguna.billingSessions.createPortalLink({
  accountId: 'acc_abc123'
});

// Share session.sessionUrl with customer

{
  "id": "sess_def456",
  "sessionToken": "tok_def456...",
  "sessionUrl": "https://portal.alguna.io/hs/tok_def456..."
}

API Reference

Examples

API Reference

Create Portal Link Sharing Session