Add Customer Screen

​

Overview

​

Authentication

​

Authorization

• ADMIN: Full access to modify any customer’s screens
• MASTER: Full access to modify any customer’s screens
• RESALE: Can modify screens for customers under their management

​

Path Parameters

​

Request Body

​

Response

curl -X PATCH "https://api.vpn.tv/customer/addscreen/user123" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "passId": 54321
  }'

{
  "success": true,
  "customer": {
    "id": "user123",
    "email": "[email protected]",
    "username": "customer_user",
    "screens": 4,
    "previousScreens": 3,
    "passId": 54321,
    "maxConcurrentSessions": 4,
    "updatedAt": "2024-01-20T14:45:00.000Z"
  },
  "message": "Screen added successfully to customer account"
}

​

Error Handling

​

Implementation Notes

​

Screen Limits

• Enterprise: Higher limits available for enterprise customers
• Validation: System validates against customer’s plan limits
• Override: Administrators can override limits with proper justification

​

Pass ID Requirements

• Valid Pass ID: Must correspond to an existing pass in the system
• Active Pass: Pass must be active and not expired
• Billing: Pass ID is used for billing and usage tracking
• Audit Trail: All screen additions are linked to specific pass IDs

​

Concurrent Sessions

• Screen count directly affects maximum concurrent VPN sessions
• Each screen allows one simultaneous connection
• System enforces connection limits in real-time
• Excess connections are automatically terminated

​

Business Rules

• Screen additions are immediate and effective immediately
• Billing adjustments are handled automatically
• Customer notifications are sent for plan upgrades
• Changes are logged for compliance and auditing

​

Performance Considerations

• Screen additions are atomic database operations
• Customer session limits are cached for fast access
• Real-time connection enforcement prevents overuse
• System monitors for abuse patterns

​

Security Features

• Role-based access control prevents unauthorized modifications
• All screen additions are logged with user attribution
• Pass ID validation prevents fraudulent additions
• Rate limiting prevents bulk abuse

​

Related Endpoints

• Get Customer by ID - Check current screen count
• List Customers - Find customers for upgrades
• Extend Customer Date - Manage subscription duration
• Create Transaction - Process screen addition payments
• Get VPN Sessions - Monitor concurrent connections

​

Best Practices

​

Before Adding Screens

1. Verify Customer Plan: Check if customer’s plan supports additional screens
2. Validate Pass ID: Ensure the pass ID is valid and active
3. Check Limits: Verify customer hasn’t reached maximum allowed screens
4. Customer Consent: Ensure customer has requested or authorized the addition

​

After Adding Screens

1. Update Billing: Process any required payment adjustments
2. Notify Customer: Send confirmation of plan upgrade
3. Monitor Usage: Track if customer utilizes additional screens
4. Document Changes: Record reason for screen addition

​

Error Recovery

• Invalid pass IDs should be checked before submission
• Maximum screen limits should be validated client-side
• Failed additions should trigger appropriate user notifications
• Retry mechanisms should be implemented for network failures