RevKeen Docs
Api reference

Create a customer portal session

Create a temporary portal session URL for a customer. The customer can use this URL to access their portal without requiring them to sign in with a magic link.


Related endpoints

  • GET /customers/{customerId}/invoices — List customer invoices
  • GET /customers/{customerId}/subscriptions — List customer subscriptions
  • GET /customers/{customerId}/orders — List customer orders
  • GET /customers/{customerId}/payments — List customer payments
  • PUT /customers/external/batch — Batch upsert customers by external ID
  • POST /customers — Create a new customer
  • GET /customers — List customers
  • GET /customers/{id} — Get customer by ID

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

POST
/customers/{id}/portal-sessions
x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Path Parameters

id*string

Customer UUID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://api.revkeen.com/v2/customers/00000000-0000-0000-0000-000000000000/portal-sessions" \  -H "x-api-key: $REVKEEN_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "return_url": "https://example.com"  }'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
    "url": "http://example.com",
    "expiresAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}
Empty
Empty