Customers

Vouchers collection

Get all vouchers.

get/admin/customers/prepaid-cards

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/customers/prepaid-cards
  • Auth: HTTP basic

Response

idnumber required

Voucher ID

typestring

Card type

statusstring

Voucher Status: "active", "used", "disabled", "expired", "new", "online"

pricenumber

Voucher price

pool_idnumber

IPv4 Pool ID, "-1" for "Router will assign IP", "0" - Any

partner_idnumber

Partner ID (0 - Any)

location_idnumber

Location ID (0 - Any)

speed_downloadnumber

Download speed kbps

speed_uploadnumber

Upload speed kbps

traffic_in_totalnumber

Traffic In total

traffic_in_usednumber

Traffic In used

traffic_in_used_mbnumber

Traffic In used Mb

traffic_out_totalnumber

Traffic Out total

traffic_out_usednumber

Traffic Out used

traffic_out_used_mbnumber

Traffic Out used Mb

traffic_all_totalnumber

Traffic All total

traffic_all_usednumber

Traffic All used

traffic_all_used_mbnumber

Traffic All used Mb

prefixstring

Serie Prefix

short_loginstring

Voucher Login (unique)

loginstring

Voucher Login with Prefix (unique)

passwordstring

Vaucher password

seller_namestring

Vaucher seller name

full_namestring

Full name

emailstring

email

phonestring

Phone

remarkstring

Remark

activated_atstring

Voucher activation datetime

time_onlinenumber

Time online

time_online_selectorstring

Time online selector: "minutes", "hours", "days"

time_online_usednumber

Used time online

valid_tillstring

Valid till

time_expirednumber

Expired time

macstring

MAC address

customer_idnumber

Customer ID

tariff_idnumber

Tariff ID

invoice_idnumber

Invoice ID

expired_by_selectorstring
time_expired_selectorstring

Expired selector: "minutes", "hours", "days"

seriestring

Serie

changedstring

Changed: "Y", "N"

is_importstring

Card is import: "1", "0"

created_atstring

Created at

expired_bystring required

Validity method: "valid_date", "activation_time"

Example response

[
  {
    "id": 120,
    "type": "prepaid",
    "status": "new",
    "price": 5,
    "pool_id": 2,
    "partner_id": 1,
    "location_id": 2,
    "speed_download": 1024,
    "speed_upload": 1024,
    "traffic_in_total": 5000,
    "traffic_in_used": 0,
    "traffic_in_used_mb": 0,
    "traffic_out_total": 5000,
    "traffic_out_used": 0,
    "traffic_out_used_mb": 0,
    "traffic_all_total": 9000,
    "traffic_all_used": 0,
    "traffic_all_used_mb": 0,
    "prefix": "SPLCP",
    "short_login": "SomeRANdomGeneratedLogin",
    "login": "SPLCPSomeRANdomGeneratedLogin",
    "password": "dJHBdwu56R",
    "seller_name": "seller name",
    "full_name": "full name",
    "email": "test@email.box",
    "phone": "1234567",
    "remark": "remark",
    "activated_at": "0000-00-00 00:00:00",
    "time_online": 48,
    "time_online_selector": "hours",
    "time_online_used": 0,
    "valid_till": "2018-12-31",
    "time_expired": 0,
    "mac": "00:00:00:00:00:00",
    "customer_id": 1,
    "tariff_id": 1,
    "invoice_id": 1,
    "expired_by_selector": "NULL",
    "time_expired_selector": "minutes",
    "serie": "201801",
    "changed": "Y",
    "is_import": "1",
    "created_at": "2018-01-22 14:09:26",
    "expired_by": "valid_date"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.