Select
Subscriptions
Access to subscriptions
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
orgId | path | string | true | organization name |
subscriptionId | path | integer(int64) | true | subscription identifier |
query | query | Query | false | Use ‘include’ to get
|
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | successful operation | Subscription |
400 | Bad Request | Invalid request body | ErrorMessage |
404 | Not Found | Resource not found | ErrorMessage |
405 | Method Not Allowed | Method not allowed | None |
200 - instance of Subscription
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
id | integer(int64) | false | ID of subscription to return |
subscription_status | Status | false | none |
sell_date | string(date-time) | false | none |
activated_date | string(date-time) | false | none |
end_date | string(date-time) | false | none |
subscription_type | SubscriptionType | false | none |
origin | Origin | false | to get origin use in url object query with include = origin. /subscriptions/{id}?query={“include”:[“origin”]} |
historical_status | [HistoricalStatus] | false | none |
dealer_id | string¦null | false | Dealer id (in some cases this field can be null) |
shop_id | string¦null | false | Shop id (in some cases this field can be null) |
path | string¦null | false | Contract path (in some cases this field can be null) |
filename | string¦null | false | Contract filename (in some cases this field can be null) |
identification_nr | integer(int32) | false | Phone number associated to subscription |
imsi | integer(int64)¦null | false | IMSI associated to mobile subscription (in some cases this field can be null) |
iccid | string¦null | false | Mobile online icc id (in some cases this field can be null) |
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
orgId | path | string | true | organization name |
subscriptionId | path | integer(int64) | true | subscription identifier |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | returns list of terminals of a subscription | SubscriptionDevices |
400 | Bad Request | Invalid request body | ErrorMessage |
404 | Not Found | Resource not found | ErrorMessage |
405 | Method Not Allowed | Method not allowed | None |
200 - instance of SubscriptionDevices
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
devices | [DeviceResponse] | false | none |
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
orgId | path | string | true | organization name |
subscriptionId | path | integer(int64) | true | subscription identifier |
x-ip-address | header | string(ipv4) | false | origin ip address |
body | body | AddDeviceToSubscriptionRequest | true | Add device to subscription |
Request body - instance of AddDeviceToSubscriptionRequest
|
|
Name | Type | Required | Description |
---|---|---|---|
delivery_info | DeviceDeliveryInfo | false | none |
sell | Sell | true | none |
client | DeviceClient | true | none |
device | Device | true | none |
subscription_offer_segment | string | true | none |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
201 | Created | successful operation | AddDeviceToSubscriptionResponse |
202 | Accepted | check risk decision | AddDeviceToSubscriptionResponse |
400 | Bad Request | Invalid request body | ErrorMessage |
404 | Not Found | Resource not found | ErrorMessage |
405 | Method Not Allowed | Method not allowed | None |
201 - instance of AddDeviceToSubscriptionResponse
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
risk_decision | string | false | none |
subscription_terminal_id | number(int64) | false | none |
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
orgId | path | string | true | organization name |
subscriptionId | path | integer(int64) | true | subscription identifier |
x-ip-address | header | string(ipv4) | false | origin ip address |
body | body | SimReplacement | true | Contains dealer id, shop id (if present), offline/online value and new icc |
Request body - instance of SimReplacement
|
|
Name | Type | Required | Description |
---|---|---|---|
dealer_id | string | true | Dealer ID |
shop_id | string | false | Shop ID |
logistic | boolean | true | Online/offline operation |
new_icc | string | false | New icc |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
201 | Created | successful operation | SimReplacementResponse |
202 | Accepted | successful operation | SimReplacementResponse |
400 | Bad Request | Invalid request body | ErrorMessage |
404 | Not Found | Resource not found | ErrorMessage |
405 | Method Not Allowed | Method not allowed | None |
201 - instance of SimReplacementResponse
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
risk_decision | string | false | none |
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
orgId | path | string | true | organization name |
subscriptionId | path | integer(int64) | true | subscription identifier |
start_date | query | string(date) | false | start date query with format yyyy-mm-dd |
end_date | query | string(date) | false | end date query with format yyyy-mm-dd |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | successful operation | SubscriptionDetailRecharge |
400 | Bad Request | Invalid request body | ErrorMessage |
404 | Not Found | Resource not found | ErrorMessage |
405 | Method Not Allowed | Method not allowed | None |
200 - instance of SubscriptionDetailRecharge
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
subscription_id | integer(int64) | false | identification subscription |
identification_nr | integer(int32) | false | number of identification |
period_date | PeriodDate | false | none |
recharges | [DetailRechargeEvent] | false | [recharge detail record] |
Endpoints
Signups
Users
Accounts
Invoices
Terms
Payment info
Account migrations
Subscriptions
Products
Services
Bonuses
Promotions
Barrings
Consumption
Workorders
Penalties