Meta Info
Last updated
Last updated
A subscription owner can display information about consumed and remaining traffic, subscription expiration date, display announcements, and set up to two links for icons in the metadata display bar.
All data can be provided in either plain text or base64 format.
Metadata can be transmitted in two ways:
Through the HTTP header of the subscription page.
Through the subscription body by prefixing the parameter with the # symbol (e.g., #profile-title).
profile-title (string):
The profile name. It can be provided as plain text or in base64 (UTF-8).
Limit: Maximum length — 25 characters.
subscription-userinfo (string):
Contains information for displaying traffic usage and subscription expiration date.
The left side of the progress bar shows the total consumed traffic (upload + download), while the right side after the / sign displays the total allowance (total).
The subscription expiration date is specified in the expire parameter.
Note: All data is included in a single header and separated by the ; character.
support-url (string):
A support link.
Displayed as a blue icon on the right side of the bar.
The clickable area is highlighted with a green rectangle.
profile-web-page-url (string):
A link to the profile web page.
If this parameter is specified, the icon becomes blue (similar to support-url).
The clickable area is also highlighted with a green rectangle.
announce (string):
Announcement text. It can be provided in plain text or base64 format.
Limit: The maximum length of displayed text is 200 characters.
profile-update-interval (int): The interval for automatic subscription updates, specified in hours. If the user has set an interval in the app settings, this parameter will be ignored.
To ensure proper metadata display, make sure the data format meets the requirements (plain text or base64 UTF-8).
Parameters specified in the subscription body take precedence over those passed through HTTP headers.
If some parameters are received via HTTP headers and others through the subscription body, all parameters should be merged, respecting their priority, and displayed correctly.
