Api Reference

Create invoice

post

Creates a new invoice with the specified rate and period for the authenticated application.

Authorizations

X-API-Key

X-API-KeystringRequired

API Key needed to access the endpoints

Body

application/jsontext/jsonapplication/*+json

messagestring · nullableOptional

ratenumber · doubleOptional

periodstring · enumOptionalPossible values:

metadataobject · nullableOptionalExample: {}

Responses

200

Invoice created successfully

application/json

idinteger · int64Optional

ratenumber · doubleOptional

createdAtstring · date-timeOptional

botUrlstring · nullableOptional

400

Bad request - Invalid parameters

401

Unauthorized - Invalid or missing API key

500

Internal server error

post

/api/invoice

HTTPcURLJavaScriptPython

POST /api/invoice HTTP/1.1
Host: bot-api.papaya.ws
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "message": "text",
  "rate": 1,
  "period": "PerDay",
  "metadata": "{}"
}

application/jsontext/jsonapplication/*+json

{
  "id": 1,
  "rate": 1,
  "createdAt": "2026-03-11T18:45:59.229Z",
  "botUrl": "text"
}

Get invoice by id

get

Retrieves a specific invoice by its ID, ensuring it belongs to the authenticated application.

Authorizations

X-API-Key

X-API-KeystringRequired

API Key needed to access the endpoints

Path parameters

idinteger · int64Required

Responses

200

Invoice created successfully

text/plainapplication/jsontext/json

idinteger · int64Optional

recipientstring · nullableOptional

ratenumber · doubleOptional

createdAtstring · date-timeOptional

isPaidbooleanOptional

metadataobject · nullableOptionalExample: {}

botUrlstring · nullableOptional

400

Bad request - Invalid parameters

text/plainapplication/jsontext/json

401

Unauthorized - Invalid or missing API key

404

Not Found

text/plainapplication/jsontext/json

500

Internal server error

get

/api/invoice/{id}

HTTPcURLJavaScriptPython

GET /api/invoice/{id} HTTP/1.1
Host: bot-api.papaya.ws
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "recipient": "text",
  "rate": 1,
  "createdAt": "2026-03-11T18:45:59.229Z",
  "isPaid": true,
  "metadata": "{}",
  "botUrl": "text"
}

Get all subscriptions

get

Retrieves all subscriptions for the authenticated application with pagination support.

Authorizations

X-API-Key

X-API-KeystringRequired

API Key needed to access the endpoints

Query parameters

pageinteger · int32OptionalDefault: 1

limitinteger · int32OptionalDefault: 50

Responses

200

Returns paginated list of subscriptions

application/json

A paginated response containing items and pagination metadata

totalCountinteger · int32Optional

Total number of items across all pages

pageinteger · int32Optional

Current page number (1-indexed)

limitinteger · int32Optional

Number of items per page

totalPagesinteger · int32Optional

Total number of pages

401

Unauthorized - Invalid or missing API key

500

Internal server error

get

/api/subscriptions

HTTPcURLJavaScriptPython

GET /api/subscriptions HTTP/1.1
Host: bot-api.papaya.ws
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": 1,
      "chainId": 1,
      "tokenName": "text",
      "tx": "text",
      "tgUserId": 1,
      "userAddress": "text",
      "createdAt": "2026-03-11T18:45:59.229Z",
      "isActive": true
    }
  ],
  "totalCount": 1,
  "page": 1,
  "limit": 1,
  "totalPages": 1
}

Get subscription by ID

get

Retrieves a specific subscription by its ID, ensuring it belongs to the authenticated application.

Authorizations

X-API-Key

X-API-KeystringRequired

API Key needed to access the endpoints

Path parameters

idinteger · int64Required

Responses

200

Returns the requested subscription

application/json

Subscription data model for API responses

idinteger · int64Optional

Unique identifier for the subscription

chainIdinteger · int32Optional

Blockchain chain ID where the subscription is registered

tokenNamestring · nullableOptional

Name of the token used for the subscription payments

txstring · nullableOptional

Transaction hash of the subscription payment

tgUserIdinteger · int64Optional

Telegram user ID associated with the subscription

userAddressstring · nullableOptional

User's wallet address associated with the subscription

createdAtstring · date-timeOptional

Creation timestamp of the subscription

isActiveboolean · booleanOptional

Indicates whether the subscription is currently active

401

Unauthorized - Invalid or missing API key

404

Subscription not found

500

Internal server error

get

/api/subscriptions/{id}

HTTPcURLJavaScriptPython

GET /api/subscriptions/{id} HTTP/1.1
Host: bot-api.papaya.ws
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "chainId": 1,
  "tokenName": "text",
  "tx": "text",
  "tgUserId": 1,
  "userAddress": "text",
  "createdAt": "2026-03-11T18:45:59.229Z",
  "isActive": true
}