Skip to main content

​
Overview

The suspend operation allows you to temporarily disable specific services or all services of a subscription. You can suspend:
  • Local minutes
  • International minutes
  • Roaming minutes
  • Local SMS
  • International SMS
  • Roaming SMS
  • Data
  • All usage
Each service can be suspended independently or all at once.

​
API Endpoint

https://gateway.telgea.com:5111/v1/suspend

​
Request

​
Request Body

{
  "suspend_all": false,
  "suspend_local_minutes": false,
  "suspend_international_minutes": false,
  "suspend_roaming_minutes": false,
  "suspend_local_sms": false,
  "suspend_international_sms": false,
  "suspend_roaming_sms": false,
  "suspend_data": false,
  "details": {}
}

​
Response

​
Success Response

{
  "status": "success",
  "message": "Subscription suspended successfully",
  "data": {
    "subscriptionId": "string",
    "status": "suspended",
    "suspendedAt": "string",
    "suspendedServices": {
      "local_minutes": true,
      "international_minutes": false,
      "roaming_minutes": false,
      "local_sms": false,
      "international_sms": false,
      "roaming_sms": false,
      "data": false
    }
  }
}

​
Error Response

{
  "status": "error",
  "message": "Error message",
  "code": "ERROR_CODE"
}

​
Operations

​
Suspend local minutes

Provider API operations: 
POST /api/v1/transatel/subscriptions/{subscriptionId}/suspend
{
  "type": "local_minutes",
  "reason": "Customer request"
}

​
Suspend international minutes

Provider API operations: 
POST /api/v1/transatel/subscriptions/{subscriptionId}/suspend
{
  "type": "international_minutes",
  "reason": "Customer request"
}

​
Suspend roaming minutes

Provider API operations: 
POST /api/v1/transatel/subscriptions/{subscriptionId}/suspend
{
  "type": "roaming_minutes",
  "reason": "Customer request"
}

​
Suspend local SMS

Provider API operations: 
POST /api/v1/transatel/subscriptions/{subscriptionId}/suspend
{
  "type": "local_sms",
  "reason": "Customer request"
}

​
Suspend international SMS

Provider API operations: 
POST /api/v1/transatel/subscriptions/{subscriptionId}/suspend
{
  "type": "international_sms",
  "reason": "Customer request"
}

​
Suspend roaming SMS

Provider API operations: 
POST /api/v1/transatel/subscriptions/{subscriptionId}/suspend
{
  "type": "roaming_sms",
  "reason": "Customer request"
}

​
Suspend data

Provider API operations: 
POST /api/v1/transatel/subscriptions/{subscriptionId}/suspend
{
  "type": "data",
  "reason": "Customer request"
}

​
Suspend all usage

Provider API operations: 
POST /api/v1/transatel/subscriptions/{subscriptionId}/suspend
{
  "type": "all",
  "reason": "Customer request"
}

​
Notes

  • Additional implementation details will be added here
  • Any specific requirements or limitations will be documented here