{
"id": 2522,
"name": "InvoiceLinkCreateOptions",
"variant": "declaration",
"kind": 256,
"flags": {},
"children": [
{
"id": 2527,
"name": "currency",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Three-letter ISO 4217 currency code"
}
],
"blockTags": [
{
"tag": "@see",
"content": [
{
"kind": "text",
"text": "https://core.telegram.org/bots/payments#supported-currencies"
}
]
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1405,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2524,
"name": "description",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Product description, 1-255 characters"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1393,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2542,
"name": "isFlexible",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true*, if the final price depends on the shipping method"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1448,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2529,
"name": "maxTipAmount",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "The maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float). For example, for a maximum tip of "
},
{
"kind": "code",
"text": "`US$ 1.45`"
},
{
"kind": "text",
"text": " pass "
},
{
"kind": "code",
"text": "`maxTipAmount: 145`"
},
{
"kind": "text",
"text": ". See the *exp* parameter in [currencieson](https://core.telegram.org/bots/payments/currencieson), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1412,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2538,
"name": "needEmail",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true*, if you require the user's email address to complete the order"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1440,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2536,
"name": "needName",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true*, if you require the user's full name to complete the order"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1436,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2537,
"name": "needPhoneNumber",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true*, if you require the user's phone number to complete the order"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1438,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2539,
"name": "needShippingAddress",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true*, if you require the user's shipping address to complete the order"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1442,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2525,
"name": "payload",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Bot-defined invoice payload, 1-128 bytes.\nThis will not be displayed to the user, use for your internal processes."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1398,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2535,
"name": "photoHeight",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Photo height"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1434,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2533,
"name": "photoSize",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Photo size in bytes"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1430,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2532,
"name": "photoUrl",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.\nPeople like it better when they see what they are paying for."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1428,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2534,
"name": "photoWidth",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Photo width"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1432,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2528,
"name": "prices",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Price breakdown, a list of components\n(e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1410,
"character": 1
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"target": 2550,
"name": "LabeledPrice",
"package": "tgkit"
}
}
},
{
"id": 2531,
"name": "providerData",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "JSON-serialized data about the invoice, which will be shared with the payment provider.\nA detailed description of required fields should be provided by the payment provider."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1423,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2526,
"name": "providerToken",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Payments provider token, obtained via [@BotFather](https://t.me/botfather)"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1400,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2541,
"name": "sendEmailToProvider",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true*, if user's email address should be sent to provider"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1446,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2540,
"name": "sendPhoneNumberToProvider",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Pass *true*, if user's phone number should be sent to provider"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1444,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 2530,
"name": "suggestedTipAmounts",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "An array of suggested amounts of tip in the *smallest units* of the currency (integer, **not** float).\nAt most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive,\npassed in a strictly increased order and must not exceed *maxTipAmount*."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1418,
"character": 1
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "number"
}
}
},
{
"id": 2523,
"name": "title",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Product name, 1-32 characters"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1391,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [
2527,
2524,
2542,
2529,
2538,
2536,
2537,
2539,
2525,
2535,
2533,
2532,
2534,
2528,
2531,
2526,
2541,
2540,
2530,
2523
]
}
],
"sources": [
{
"fileName": "packages/tgkit/src/types.ts",
"line": 1389,
"character": 17
}
]
}