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.

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",
    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
    "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
    "url": "http://example.com",
    "expires_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "Unauthorized"
}

{
  "error": "Not found"
}