CCC API v8.4.0.0

<back to all web services

GetServiceSku

The following routes are available for this service:
GET/api/services/skus/{ServiceSkuGuid}/Get a ServiceSku.
GetServiceSku Parameters:
NameParameterData TypeRequiredDescription
ServiceSkuGuidpathGuidYesGuid of the ServiceSku.
ServiceSkuResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ServiceSku Parameters:
NameParameterData TypeRequiredDescription
ServiceSkuGuidbodyGuidNo
ServiceSkuBundleGuidbodyGuidNo
SkuGuidbodyGuidNo
NameformstringNo
AssignedDatebodyDateTimeNo
EndedDatebodyDateTimeNo
BillingMetricformstringNo

Allowable Values

  • NoMetric
  • ProUsersCount
  • NumberOfMessagesEntitlement
  • NumberOfMessagesOverage
  • DataTransfer50GbEntitlement
  • DataTransferAmountInGbEntitlement
  • DataTransferAmountPerUserInGbEntitlement
  • DataTransferAmountInGbOverage
  • MftDataTransfer50GbEntitlement
  • MftDataTransferAmountInGbEntitlement
  • MftDataTransferAmountPerUserInGbEntitlement
  • MftDataTransferAmountInGbOverage
QuantitybodyIntegerNo
UnitPricebodyDecimalNo
DescriptionformstringNo
IsEditablebodyBooleanNo

Allowable Values

  • true
  • false

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/services/skus/{ServiceSkuGuid}/ HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  },
  "serviceSkuGuid": "00000000000000000000000000000000",
  "serviceSkuBundleGuid": "00000000000000000000000000000000",
  "skuGuid": "00000000000000000000000000000000",
  "name": "String",
  "assignedDate": "0001-01-01T00:00:00Z",
  "endedDate": "0001-01-01T00:00:00Z",
  "billingMetric": "String",
  "quantity": 0,
  "unitPrice": 0,
  "description": "String",
  "isEditable": false
}