CCC API v8.4.0.0

<back to all web services

CreateSku

The following routes are available for this service:
POST/api/partners/{PartnerGuid}/skusCreate a new Sku.
CreateSku Parameters:
NameParameterData TypeRequiredDescription
PartnerGuidpathGuidYesGuid of the Partner
SkuBundleGuidqueryGuidNoGuid of the parent SkuBundle
NamebodyStringNoThe name of the Sku
BillingMetricbodyStringNoThe billing metric applied to the Sku during 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
DescriptionbodyStringNo Description of the Sku
StatusbodyStringNoThe Status of a Sku. Defaults to Active

Allowable Values

  • Active
  • Disabled
CreateSkuResponse Parameters:
NameParameterData TypeRequiredDescription
SkuGuidbodyGuidNo
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/partners/{PartnerGuid}/skus HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{
  "partnerGuid": "00000000000000000000000000000000",
  "skuBundleGuid": "00000000000000000000000000000000",
  "name": "String",
  "billingMetric": "String",
  "unitPrice": 0,
  "quantity": 0,
  "description": "String",
  "status": "String"
}

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

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