PerspectPerspectDocs
Go to Admin
View as Markdown

Site Users

This reference is auto-generated from the mounted public Hono routes in perspectapiworkers. Admin and internal routes are excluded.

Base Path

/api/v2/sites/:siteName/users

Endpoints

GET /api/v2/sites/:siteName/users

List users.

Path params: siteName

GET /api/v2/sites/:siteName/users/:id

Get user by id.

Path params: siteName, id

PATCH /api/v2/sites/:siteName/users/:id

Update user by id.

Path params: siteName, id

GET /api/v2/sites/:siteName/users/:id/credits/balance

Get balance.

Path params: siteName, id

POST /api/v2/sites/:siteName/users/:id/credits/grant

Grant action.

Path params: siteName, id

GET /api/v2/sites/:siteName/users/:id/profile

Get profile.

Path params: siteName, id

GET /api/v2/sites/:siteName/users/:id/subscriptions

Get subscriptions.

Path params: siteName, id

POST /api/v2/sites/:siteName/users/:id/subscriptions/:subId/cancel

Cancel action.

Path params: siteName, id, subId

POST /api/v2/sites/:siteName/users/:id/subscriptions/:subId/change-plan

Change plan action.

Path params: siteName, id, subId

POST /api/v2/sites/:siteName/users/:id/subscriptions/:subId/charges

Charges action.

Path params: siteName, id, subId

POST /api/v2/sites/:siteName/users/:id/subscriptions/:subId/pause

Pause action.

Path params: siteName, id, subId

POST /api/v2/sites/:siteName/users/:id/subscriptions/:subId/resume

Resume action.

Path params: siteName, id, subId

GET /api/v2/sites/:siteName/users/me

Get me.

Path params: siteName

PATCH /api/v2/sites/:siteName/users/me

Update me.

Path params: siteName

GET /api/v2/sites/:siteName/users/me/credits

Get credits.

Path params: siteName

GET /api/v2/sites/:siteName/users/me/credits/balance

Get balance.

Path params: siteName

GET /api/v2/sites/:siteName/users/me/profile

Get profile.

Path params: siteName

DELETE /api/v2/sites/:siteName/users/me/profile/:key

Delete profile.

Path params: siteName, key

PUT /api/v2/sites/:siteName/users/me/profile/:key

Replace profile.

Path params: siteName, key

GET /api/v2/sites/:siteName/users/me/subscriptions

Get subscriptions.

Path params: siteName

POST /api/v2/sites/:siteName/users/me/subscriptions/:id/cancel

Cancel action.

Path params: siteName, id

POST /api/v2/sites/:siteName/users/me/subscriptions/:id/change-plan

Change plan action.

Path params: siteName, id

POST /api/v2/sites/:siteName/users/me/subscriptions/:id/pause

Pause action.

Path params: siteName, id

POST /api/v2/sites/:siteName/users/me/subscriptions/:id/resume

Resume action.

Path params: siteName, id

POST /api/v2/sites/:siteName/users/request-otp

Request otp action.

Path params: siteName

POST /api/v2/sites/:siteName/users/verify-otp

Verify otp action.

Path params: siteName

Path Parameters

Parameter
siteName
id
subId
key

This page is generated from the actual public Hono route table. Do not edit it by hand.