Penalties

Get account penalties by account id

Get account penalties by account id. Two different penalties can be obtained, for unsubscribing or for cancelling

GET /orgs/{orgId}/penalties/{accountId}

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	organization name
accountId	path	integer(int64)	true	account identifier
reason	query	AccountPenaltiesReason	true	Reason. Two values are possible, unsubscribe or cancel

Enumerated Values

Property	Values
reason	one of [unsubscribe, cancel]

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/penalties/214748364?reason='unsubscribe'?reason=unsubscribe \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	Account penalties	[ComputedPenalty]
400	Bad Request	Invalid request body	ErrorMessage

Get subscription penalties by subscription id

Get account penalties by account and subscription ids. Three different penalties can be obtained, for unsubscribing a broadband subscription, for migrating a subscription that has a device linked to it, or for mobile only unsubscribing

GET /orgs/{orgId}/penalties/{accountId}/subscriptions/{subscriptionId}

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	organization name
accountId	path	integer(int64)	true	account identifier
subscriptionId	path	integer(int64)	true	subscription identifier
reason	query	SubscriptionPenaltiesReason	true	Reason. Three values are possible, broadband_subscription, device or mobile

Enumerated Values

Property	Values
reason	one of [broadband_subscription, device, mobile]

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/penalties/214748364/subscriptions/214748364?reason='broadband_subscription'?reason=broadband_subscription \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	Subscription penalties	[ComputedPenalty]
404	Not Found	Resource not found	ErrorMessage

Get subscription penalties by subscription UUID

Get account penalties by account and subscription UUID. Three different penalties can be obtained, for unsubscribing a broadband subscription, for migrating a subscription that has a device linked to it, or for mobile only unsubscribing

GET /orgs/{orgId}/penalties/{accountId}/subscriptions/uuid/{subscriptionUUID}

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	organization name
accountId	path	integer(int64)	true	account identifier
subscriptionUUID	path	string(uuid)	true	subscription identifier

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/penalties/214748364/subscriptions/uuid/123e4567-e89b-12d3-a456-556642440000 \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	Subscription penalties	[ComputedPenalty]
404	Not Found	Resource not found	ErrorMessage

Put computed penalty

Put computed penalty to confirm penalties. Computed penalty id is obtained through the GET penalties method (account or subscription)

PUT /orgs/{orgId}/penalties/{computedPenaltyId}

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	organization name
computedPenaltyId	path	integer(int64)	true	computed penalty identifier
penalties	query	array[integer]	false	Optional array of penalties for specific calculation

Request example

1
2
3
4
5



curl -X PUT https://customers.sta.masstack.com/v2/orgs/telco/penalties/214748364?penalties=[0] \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	Successful operation	None
404	Not Found	Resource not found	ErrorMessage

404 - instance of ErrorMessage

Custom schema example

1
2
3
4
5
6


{
  "code": 0,
  "status": "string",
  "message": "string",
  "detailMsg": "string"
}

Name	Type	Required	Description
code	integer(int32)	false	Custom error code
status	string	false	Status
message	string	false	Status message
detailMsg	string	false	Detailed description of the error

Delete computed penalty

Deletes already confirmed penalty with PUT method. Computed penalty id is obtained through the GET penalties method (account or subscription)

DELETE /orgs/{orgId}/penalties/{computedPenaltyId}

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	organization name
computedPenaltyId	path	integer(int64)	true	computed penalty identifier

Request example

1
2
3
4
5



curl -X DELETE https://customers.sta.masstack.com/v2/orgs/telco/penalties/214748364 \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	Successful operation	None
404	Not Found	Resource not found	ErrorMessage

404 - instance of ErrorMessage

Custom schema example

1
2
3
4
5
6


{
  "code": 0,
  "status": "string",
  "message": "string",
  "detailMsg": "string"
}

Name	Type	Required	Description
code	integer(int32)	false	Custom error code
status	string	false	Status
message	string	false	Status message
detailMsg	string	false	Detailed description of the error