Products

Product operations. Products exist in three types:

• digital - Digital product. Any Telegram message with optional attachments

• custom - Custom product. On-demand content, e.g., personalized video greetings

• physical - Physical product. Merchandise with shipping, e.g., printed t-shirts

All amounts are in smallest currency units (cents/kopecks)

Get Products List

get

Returns a paginated list of products

Authorizations

Api-KeystringRequired

API key for authentication.

Query parameters

pageinteger · min: 1Optional

Page number

Default: 1

sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

typestring · enumOptional

Filter by product type

Possible values:

descbooleanOptional

Sort by ID descending

Default: false

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized (invalid API key)

application/json

get/products

GET /api/v1/products HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "rows": [
    {
      "id": 2548,
      "type": "digital",
      "name": "VPN Access - 1 Month",
      "description": "High-speed VPN service with unlimited bandwidth and 50+ server locations worldwide",
      "amount": 499,
      "currency": "usd",
      "starsAmount": 100,
      "starsAmountEnabled": true,
      "status": "approved",
      "isCustom": false,
      "acceptCards": true,
      "acceptWalletPay": false,
      "protectContent": true,
      "created": "2025-08-25T10:30:00Z",
      "updated": "2025-08-25T10:30:00Z",
      "pendingOrders": 3,
      "imageUrl": "https://cdn.example.com/image.jpg",
      "link": "https://t.me/tribute_bot/app?startapp=pf6",
      "webLink": "https://web.tribute.tg/p/f6"
    }
  ],
  "meta": {
    "total": 1,
    "offset": 1,
    "limit": 1
  }
}

Get Product by ID

get

Returns a single product by its ID

Authorizations

Api-KeystringRequired

API key for authentication.

Path parameters

idintegerRequired

Product ID

Responses

200

Successful response

application/json

idintegerRequired

Product ID

Example: 2548

typestring · enumRequired

Product type

Example: digitalPossible values:

namestringRequired

Product name

Example: VPN Access - 1 Month

descriptionstringOptional

Product description

Example: High-speed VPN service with unlimited bandwidth and 50+ server locations worldwide

amountinteger · int64Required

Product price in smallest currency units (cents for USD/EUR, kopecks for RUB). For physical products this is the starting price, taken from the cheapest variant.

Example: 499

currencystring · enumRequired

Currency code

Example: usdPossible values:

starsAmountintegerOptional

Price in Telegram Stars

Example: 100

starsAmountEnabledbooleanOptional

Whether payment with Stars is enabled

Example: true

statusstring · enumRequired

Product status

Example: approvedPossible values:

isCustombooleanRequired

Whether this is a custom product

Example: false

acceptCardsbooleanRequired

Whether card payments are accepted

Example: true

acceptWalletPaybooleanRequired

Whether wallet payments are accepted

Example: false

protectContentbooleanRequired

Whether content protection is enabled

Example: true

createdstring · date-timeRequired

Product creation date

Example: 2025-08-25T10:30:00Z

updatedstring · date-timeRequired

Product last update date

Example: 2025-08-25T10:30:00Z

pendingOrdersintegerOptional

Number of pending orders (for custom products)

Example: 3

imageUrlstring · uriOptional

Product image URL

Example: https://cdn.example.com/image.jpg

linkstring · uriRequired

Direct link to product in Telegram app

Example: https://t.me/tribute_bot/app?startapp=pf6

webLinkstring · uriRequired

Web link to product

Example: https://web.tribute.tg/p/f6

400

Bad request (invalid product ID format)

application/json

401

Unauthorized (invalid API key)

application/json

403

Access denied

application/json

404

Product not found

application/json

get/products/{id}

GET /api/v1/products/{id} HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "id": 2548,
  "type": "digital",
  "name": "VPN Access - 1 Month",
  "description": "High-speed VPN service with unlimited bandwidth and 50+ server locations worldwide",
  "amount": 499,
  "currency": "usd",
  "starsAmount": 100,
  "starsAmountEnabled": true,
  "status": "approved",
  "isCustom": false,
  "acceptCards": true,
  "acceptWalletPay": false,
  "protectContent": true,
  "created": "2025-08-25T10:30:00Z",
  "updated": "2025-08-25T10:30:00Z",
  "pendingOrders": 3,
  "imageUrl": "https://cdn.example.com/image.jpg",
  "link": "https://t.me/tribute_bot/app?startapp=pf6",
  "webLink": "https://web.tribute.tg/p/f6"
}

Cancel Digital Product Purchase

post

Cancels a digital product purchase and refunds the payment.

Important: This endpoint only supports refunds for purchases paid with Telegram Stars. Purchases paid with other payment methods cannot be refunded via this endpoint.

Authorizations

Api-KeystringRequired

API key for authentication.

Path parameters

purchaseIdintegerRequired

Digital product purchase ID (ProductPurchase.ID)

Example: 12345

Responses

200

Purchase successfully cancelled and payment refunded

application/json

successbooleanRequired

Operation success status

Example: true

purchaseIdintegerRequired

Cancelled purchase ID

Example: 12345

messagestringRequired

Success message

Example: purchase cancelled and payment refunded

400

Bad request

application/json

401

Unauthorized (invalid API key)

application/json

403

Access denied (not the product owner)

application/json

404

Purchase or user not found

application/json

500

Internal server error

application/json

post/products/purchases/{purchaseId}/cancel

POST /api/v1/products/purchases/{purchaseId}/cancel HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "purchaseId": 12345,
  "message": "purchase cancelled and payment refunded"
}