Generate Shared Invite

Generate a short-lived token granting temporary customer self-service billing page access.

POST /v1/customers/{id}/share

TypeScript SDK

TypeScript

import { Solifyn } from 'solifyn';

const solifyn = new Solifyn({ apiKey: 'your_private_api_key_here' });

// Generate user dashboard invite link
const link = await solifyn.customers.generateInviteLink('cust_019e56a1...');
console.log('Customer Invite Link:', link.inviteUrl);

201

{
  "token": "2jb5bp8bq0jfucv7rtt9a8",
  "expiresAt": "2025-01-02T12:00:00Z",
  "url": "http://localhost:3000/shared/2jb5bp8bq0jfucv7rtt9a8"
}

Authorizations

Authorization · string · header · required

Authenticate requests using your standard bearer API key (e.g. YOUR_API_KEY).

Path Parameters

id · string · required

Customer ID

Example:

"user_123"

Response

201 - application/json

Self-service billing portal invite token created.

token · string · required

The generated invite token

Example:

"2jb5bp8bq0jfucv7rtt9a8"

expiresAt · string<date-time> · required

The expiration timestamp of the token

Example:

"2025-01-02T12:00:00Z"

url · string

The self-service shared portal URL

Example:

"http://localhost:3000/shared/2jb5bp8bq0jfucv7rtt9a8"