PgBeam Docs
Analytics

Submit cancellation feedback

Records optional feedback when a user cancels their subscription.

At a glance

ItemValue
MethodPOST
Path/v1/organizations/{org_id}/cancellation-feedback
AuthAuthorization: Bearer <token-or-api-key>

Quick request

Use this as a starting point. Replace the placeholder IDs, set PGBEAM_TOKEN, and create body.json from the schema below.

curl -X POST \
  "$PGBEAM_API_URL/v1/organizations/<org_id>/cancellation-feedback" \
  -H "Authorization: Bearer $PGBEAM_TOKEN" \
  -H "Content-Type: application/json" \
  --data @body.json
POST
/v1/organizations/{org_id}/cancellation-feedback
AuthorizationBearer <token>

JWT issued by Better Auth. Verified via JWKS.

In: header

Path Parameters

org_id*string

Unique organization identifier.

Match^[a-zA-Z0-9_.-]+$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.pgbeam.com/v1/organizations/string/cancellation-feedback" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "code": "string",
    "message": "string"
  }
}