Verifies a customer's credentials against their activation. Accepts xtream or editor credentials. Returns full account data for the customer portal. An expired line signs in too, so its owner can renew it — check status and expiration_date; only suspended and deleted lines are refused (401).
Request Parameters
Field
Type
Required
Description
username
string
Required
Xtream or editor username
password
string
Required
Xtream or editor password
plugin_id
integer
Optional
Look on one service only. The same username can exist on two services; pass this when you know which one. Ignored unless it is a connected service.
customer_ip
string
Optional
The visitor's own address. Failed attempts are throttled per account and per visitor; too many in a row answer 429 "Too many attempts"
Response Fields
Field
Type
Description
activation_id
integer
Activation ID
username
string
Xtream username
customer_email
string
Customer email address
customer_name
string|null
Customer full name
status
string
active, trial_active, expired, or suspended
expiration_date
string|null
Expiration datetime UTC
activated_at
string|null
Activation datetime UTC
connection_type
string
m3u or mac
plugin_id
integer|null
The service this line is on. Two services may hand out the same username, so this is what tells them apart.
plugin_name
string|null
What the store owner calls that service
bouquet_mode
string
How this service shapes bouquets — see get_bouquets
xtream_host
string
Resolved host URL
xtream_username
string
Xtream panel username
xtream_password
string
Xtream panel password
editor_username
string
Editor credential username — empty string if not configured
editor_password
string
Editor credential password — empty string if not configured
m3u_url
string
Generated M3U playlist URL
epg_url
string
Generated EPG URL
product
object|null
Linked product — see product fields below
bouquets
array
Array of assigned bouquet objects — see bouquet fields below
eligible_products
array
Products available for renewal based on current connection count, excluding the free trial product — see product fields below. Only plans from the same service as the line — a renewal cannot cross services
referral
object|null
Present when referrals are on: balance, code, and account_required — true means this line’s owner has no email login yet, so steer them to register_customer
Product Object
Field
Type
Description
id
integer
Product ID
name
string
Product name
alternate_name
string|null
Alternate display name
price_decimal
float
Product price
currency
string
Currency code e.g. USD
duration_months
integer
Subscription duration in months
connections
integer
Number of simultaneous connections
Bouquet Object
Field
Type
Description
id
integer
Bouquet ID
name
string
Bouquet name
display_name
string|null
Customer-facing display name — use over name when available
