CCC API v8.4.0.0

<back to all web services

CreateServiceSku

The following routes are available for this service:
POST/api/services/{ServiceGuid}/skusCreate a new Sku.
CreateServiceSku Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidpathGuidYesGuid of the Service this Sku applies to.
ServiceSkuBundleGuidbodyGuidNo Guid of the parent SkuBundle
NamebodyStringNoName of the ServiceSku
EndedDatebodyDateTimeNoThe date the ServiceSku should no longer be applied to the Service. Defaults to null
BillingMetricbodyStringNoThe billing metric that is applied to the Sku during monthly reporting. Defaults to NoMetric

Allowable Values

  • NoMetric
  • ProUsersCount
  • NumberOfMessagesEntitlement
  • NumberOfMessagesOverage
  • DataTransfer50GbEntitlement
  • DataTransferAmountInGbEntitlement
  • DataTransferAmountPerUserInGbEntitlement
  • DataTransferAmountInGbOverage
  • MftDataTransfer50GbEntitlement
  • MftDataTransferAmountInGbEntitlement
  • MftDataTransferAmountPerUserInGbEntitlement
  • MftDataTransferAmountInGbOverage
UnitPricebodyDecimalNoUnit Price of the Sku. Defaults to 0
QuantitybodyIntegerNoQuantity of the Sku. Defaults to 0
DescriptionbodyStringNoDescription of the Sku
AssignServiceSkuResponse Parameters:
NameParameterData TypeRequiredDescription
ServiceSkuGuidbodyGuidNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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.

POST /api/services/{ServiceGuid}/skus HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{
  "serviceGuid": "00000000000000000000000000000000",
  "serviceSkuBundleGuid": "00000000000000000000000000000000",
  "name": "String",
  "endedDate": "0001-01-01T00:00:00Z",
  "billingMetric": "String",
  "unitPrice": 0,
  "quantity": 0,
  "description": "String"
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "serviceSkuGuid": "00000000000000000000000000000000",
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}