masstack

V1
V1-rfm
V1-sales
V2
API Overview Resources Schemas

Schemas

HealthResponse

1
2
3
4

{
  "persistence": "pass",
  "global": "pass"
}
Name Type Required Description
persistence string false Database connectivity status
global string false Overall service health status
Property Values
persistence one of [pass, fail]
global one of [pass, fail]

ErrorResponse

1
2
3
4
5
6
7

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Error message",
    "reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
  }
}
Name Type Required Description
error ErrorDetails true none

ErrorDetails

1
2
3
4
5

{
  "code": "ERROR_CODE",
  "message": "Error message",
  "reference": "https://developers.masstack.com/en/guides/subscriptions/errorcatalogue"
}
Name Type Required Description
code string true Error code
message string true Human-readable error message
reference string(uri) true Link to error documentation

CreateCreditLimitsRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "subscription_type": "MOBILE",
  "credit_limits": [
    {
      "credit_limit_id": "MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT",
      "credit_limit_value": 300,
      "reason": "rfm krt migration"
    }
  ]
}
Name Type Required Description
subscription_type string true Type of subscription
credit_limits [CreditLimit] true Array of credit limits to create
Property Values
subscription_type one of [MOBILE, LANDLINE]

CreditLimit

1
2
3
4
5

{
  "credit_limit_id": "MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT",
  "credit_limit_value": 300,
  "reason": "rfm krt migration"
}
Name Type Required Description
credit_limit_id string true Type of credit limit
credit_limit_value number(double) true Credit limit value in currency units
reason string true Reason for setting this credit limit
Property Values
credit_limit_id one of [MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_PREMIUM_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_INTERNATIONAL_VOICE_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_ROAMING_VOICE_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_INTERNATIONAL_VOICE_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_PREMIUM_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT]
Schemas