app.chronosky.plan.redeemTicket Documentation (EN)

main procedure

Redeem a ticket code and assign a plan to the authenticated user

Input

Encodingapplication/json

code string Required

Ticket redemption code

maxLength: 100 bytesminLength: 1 bytes

Output

Encodingapplication/json

assignment object Required

No description available.

message string Required

Success message

Errors

TicketNotFound Ticket code not found

TicketAlreadyRedeemed Ticket has already been redeemed

TicketExpired Ticket has expired

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "code"
      ],
      "properties": {
        "code": {
          "type": "string",
          "maxLength": 100,
          "minLength": 1,
          "description": "Ticket redemption code"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "TicketNotFound",
      "description": "Ticket code not found"
    },
    {
      "name": "TicketAlreadyRedeemed",
      "description": "Ticket has already been redeemed"
    },
    {
      "name": "TicketExpired",
      "description": "Ticket has expired"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "assignment",
        "message"
      ],
      "properties": {
        "message": {
          "type": "string",
          "maxLength": 1000,
          "description": "Success message"
        },
        "assignment": {
          "type": "object",
          "required": [
            "id",
            "planId",
            "activatedAt",
            "expiresAt",
            "status"
          ],
          "properties": {
            "id": {
              "type": "string",
              "maxLength": 100,
              "description": "Plan assignment ID"
            },
            "planId": {
              "type": "string",
              "maxLength": 100,
              "description": "Plan ID"
            },
            "status": {
              "enum": [
                "ACTIVE",
                "EXPIRED",
                "CANCELLED"
              ],
              "type": "string",
              "maxLength": 20,
              "description": "Plan assignment status"
            },
            "expiresAt": {
              "type": "string",
              "format": "datetime",
              "maxLength": 100,
              "description": "Plan expiration timestamp"
            },
            "activatedAt": {
              "type": "string",
              "format": "datetime",
              "maxLength": 100,
              "description": "Plan activation timestamp"
            }
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Redeem a ticket code and assign a plan to the authenticated user"
}