Invoice Class
extends BaseContains basic information about an invoice.
Properties
client: Client
currency: Currency
description: string
startParameter: string
title: string
totalAmount: number
Methods
{ "id": 1410, "name": "Invoice", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Contains basic information about an invoice." } ] }, "children": [ { "id": 1411, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/tgkit/src/structures/Invoice.ts", "line": 30, "character": 1 } ], "signatures": [ { "id": 1412, "name": "new Invoice", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/tgkit/src/structures/Invoice.ts", "line": 30, "character": 1 } ], "parameters": [ { "id": 1413, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1, "name": "Client", "package": "tgkit", "qualifiedName": "default" } }, { "id": 1414, "name": "data", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "target": 1410, "name": "Invoice", "package": "tgkit", "qualifiedName": "default" }, "overwrites": { "type": "reference", "target": -1, "name": "Base.constructor" } } ], "overwrites": { "type": "reference", "target": -1, "name": "Base.constructor" } }, { "id": 1420, "name": "client", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/tgkit/src/structures/Base.ts", "line": 4, "character": 1 } ], "type": { "type": "reference", "target": 1, "name": "Client", "package": "tgkit", "qualifiedName": "default" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "Base.client" } }, { "id": 1418, "name": "currency", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Three-letter ISO 4217 currency code, or \"XTR\" for payments in Telegram Stars" } ], "blockTags": [ { "tag": "@see", "content": [ { "kind": "inline-tag", "tag": "@link", "text": "https://core.telegram.org/bots/payments#supported-currencies", "target": "https://core.telegram.org/bots/payments#supported-currencies" } ] } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Invoice.ts", "line": 20, "character": 1 } ], "type": { "type": "reference", "target": 2088, "name": "Currency", "package": "tgkit" } }, { "id": 1416, "name": "description", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Product description" } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Invoice.ts", "line": 11, "character": 1 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1417, "name": "startParameter", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unique bot deep-linking parameter that can be used to generate this invoice" } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Invoice.ts", "line": 14, "character": 1 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1415, "name": "title", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Product name" } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Invoice.ts", "line": 8, "character": 1 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1419, "name": "totalAmount", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Total price in the *smallest units* of the currency (integer, **not** float/double).\nFor example, for a price of " }, { "kind": "code", "text": "`US$ 1.45`" }, { "kind": "text", "text": " pass " }, { "kind": "code", "text": "`totalAmount: 145`" }, { "kind": "text", "text": ".\nSee the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json),\nit shows the number of digits past the decimal point for each currency (2 for the majority of currencies)." } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Invoice.ts", "line": 28, "character": 1 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Constructors", "children": [ 1411 ] }, { "title": "Properties", "children": [ 1420, 1418, 1416, 1417, 1415, 1419 ] } ], "sources": [ { "fileName": "packages/tgkit/src/structures/Invoice.ts", "line": 6, "character": 21 } ], "extendedTypes": [ { "type": "reference", "target": { "sourceFileName": "packages/tgkit/src/structures/Base.ts", "qualifiedName": "default" }, "name": "default", "package": "tgkit" } ] }