CloudCockpit API documentation

Cancel a Subscription.

DELETE /v1/customers/{customerId}/subscriptions/{subscriptionId}

Cancels a customer subscription. This process is asynchronous, therefore it will start executing after the request is submitted and may take some time.

Headers

X-Tenant string Required

This header identifies which tenant to access with this request. This value should be an existent domain for the specified tenant.
Authorization string Required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Default value is Bearer eyJ0eXAiO....
X-Correlation-Id string(UUID)

This header is optional and by setting it you can correlate the audit logs made by this request.

Path parameters

customerId string(uuid) Required

GUID Unique identifier for the customer. The subscription must belong to this customer, otherwise this request will fail.
subscriptionId string(uuid) Required

GUID Unique identifier for the subscription.

Responses

• 202

Accepted
• 400

text/plain

text/plain application/json text/json

Bad Request
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
• 401

Unauthorized
• 403

Forbidden
• 409

text/plain

text/plain application/json text/json

Conflict
Hide response attributes Show response attributes object
- portalSubscription object
  
  The viewmodel for checking subscription conflict.
  
  Hide portalSubscription attributes Show portalSubscription attributes
  
  name string | null Required
  
  The name of the subscription. This may be up to 255 characters.
  
  quantity integer(int32) Required
  
  The quantity.
  
  nextBillingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide nextBillingFrequency attributes Show nextBillingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  autoRenewEnabled boolean
  
  true if [automatic renew enabled]; otherwise, false.
  
  autoRenewSettings object
  
  Hide autoRenewSettings attributes Show autoRenewSettings attributes
  
  term object Required
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Hide term attributes Show term attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  billingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequency attributes Show billingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  quantity integer(int32) | null Required
  
  The quantity
  
  customTermEndDate string(date-time) | null
  
  The custom term end date
  
  Additional properties are NOT allowed
  
  endDate string(date-time) Required
  
  End date of subscription.
  
  status object Required
  
  Hide status attributes Show status attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- providerSubscription object
  
  The viewmodel for checking subscription conflict.
  
  Hide providerSubscription attributes Show providerSubscription attributes
  
  name string | null Required
  
  The name of the subscription. This may be up to 255 characters.
  
  quantity integer(int32) Required
  
  The quantity.
  
  nextBillingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide nextBillingFrequency attributes Show nextBillingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  autoRenewEnabled boolean
  
  true if [automatic renew enabled]; otherwise, false.
  
  autoRenewSettings object
  
  Hide autoRenewSettings attributes Show autoRenewSettings attributes
  
  term object Required
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Hide term attributes Show term attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  billingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequency attributes Show billingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  quantity integer(int32) | null Required
  
  The quantity
  
  customTermEndDate string(date-time) | null
  
  The custom term end date
  
  Additional properties are NOT allowed
  
  endDate string(date-time) Required
  
  End date of subscription.
  
  status object Required
  
  Hide status attributes Show status attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- portalSubscription object
  
  The viewmodel for checking subscription conflict.
  
  Hide portalSubscription attributes Show portalSubscription attributes
  
  name string | null Required
  
  The name of the subscription. This may be up to 255 characters.
  
  quantity integer(int32) Required
  
  The quantity.
  
  nextBillingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide nextBillingFrequency attributes Show nextBillingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  autoRenewEnabled boolean
  
  true if [automatic renew enabled]; otherwise, false.
  
  autoRenewSettings object
  
  Hide autoRenewSettings attributes Show autoRenewSettings attributes
  
  term object Required
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Hide term attributes Show term attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  billingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequency attributes Show billingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  quantity integer(int32) | null Required
  
  The quantity
  
  customTermEndDate string(date-time) | null
  
  The custom term end date
  
  Additional properties are NOT allowed
  
  endDate string(date-time) Required
  
  End date of subscription.
  
  status object Required
  
  Hide status attributes Show status attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- providerSubscription object
  
  The viewmodel for checking subscription conflict.
  
  Hide providerSubscription attributes Show providerSubscription attributes
  
  name string | null Required
  
  The name of the subscription. This may be up to 255 characters.
  
  quantity integer(int32) Required
  
  The quantity.
  
  nextBillingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide nextBillingFrequency attributes Show nextBillingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  autoRenewEnabled boolean
  
  true if [automatic renew enabled]; otherwise, false.
  
  autoRenewSettings object
  
  Hide autoRenewSettings attributes Show autoRenewSettings attributes
  
  term object Required
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Hide term attributes Show term attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  billingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequency attributes Show billingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  quantity integer(int32) | null Required
  
  The quantity
  
  customTermEndDate string(date-time) | null
  
  The custom term end date
  
  Additional properties are NOT allowed
  
  endDate string(date-time) Required
  
  End date of subscription.
  
  status object Required
  
  Hide status attributes Show status attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- portalSubscription object
  
  The viewmodel for checking subscription conflict.
  
  Hide portalSubscription attributes Show portalSubscription attributes
  
  name string | null Required
  
  The name of the subscription. This may be up to 255 characters.
  
  quantity integer(int32) Required
  
  The quantity.
  
  nextBillingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide nextBillingFrequency attributes Show nextBillingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  autoRenewEnabled boolean
  
  true if [automatic renew enabled]; otherwise, false.
  
  autoRenewSettings object
  
  Hide autoRenewSettings attributes Show autoRenewSettings attributes
  
  term object Required
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Hide term attributes Show term attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  billingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequency attributes Show billingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  quantity integer(int32) | null Required
  
  The quantity
  
  customTermEndDate string(date-time) | null
  
  The custom term end date
  
  Additional properties are NOT allowed
  
  endDate string(date-time) Required
  
  End date of subscription.
  
  status object Required
  
  Hide status attributes Show status attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- providerSubscription object
  
  The viewmodel for checking subscription conflict.
  
  Hide providerSubscription attributes Show providerSubscription attributes
  
  name string | null Required
  
  The name of the subscription. This may be up to 255 characters.
  
  quantity integer(int32) Required
  
  The quantity.
  
  nextBillingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide nextBillingFrequency attributes Show nextBillingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  autoRenewEnabled boolean
  
  true if [automatic renew enabled]; otherwise, false.
  
  autoRenewSettings object
  
  Hide autoRenewSettings attributes Show autoRenewSettings attributes
  
  term object Required
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Hide term attributes Show term attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  billingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequency attributes Show billingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  quantity integer(int32) | null Required
  
  The quantity
  
  customTermEndDate string(date-time) | null
  
  The custom term end date
  
  Additional properties are NOT allowed
  
  endDate string(date-time) Required
  
  End date of subscription.
  
  status object Required
  
  Hide status attributes Show status attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
• 404

text/plain

text/plain application/json text/json

Not Found
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
• 500

text/plain

text/plain application/json text/json

Server Error
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed

DELETE /v1/customers/{customerId}/subscriptions/{subscriptionId}

curl \
 -X DELETE https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/customers/{customerId}/subscriptions/{subscriptionId} \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"

Response examples (400)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (400)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (409)

{
  "portalSubscription": {
    "name": "string",
    "quantity": 42,
    "nextBillingFrequency": {
      "name": "string"
    },
    "autoRenewEnabled": true,
    "autoRenewSettings": {
      "term": {
        "name": "string"
      },
      "billingFrequency": {
        "name": "string"
      },
      "quantity": 42,
      "customTermEndDate": "2024-05-04T09:42:00+00:00"
    },
    "endDate": "2024-05-04T09:42:00+00:00",
    "status": {
      "name": "string"
    }
  },
  "providerSubscription": {
    "name": "string",
    "quantity": 42,
    "nextBillingFrequency": {
      "name": "string"
    },
    "autoRenewEnabled": true,
    "autoRenewSettings": {
      "term": {
        "name": "string"
      },
      "billingFrequency": {
        "name": "string"
      },
      "quantity": 42,
      "customTermEndDate": "2024-05-04T09:42:00+00:00"
    },
    "endDate": "2024-05-04T09:42:00+00:00",
    "status": {
      "name": "string"
    }
  }
}

Response examples (409)

{
  "portalSubscription": {
    "name": "string",
    "quantity": 42,
    "nextBillingFrequency": {
      "name": "string"
    },
    "autoRenewEnabled": true,
    "autoRenewSettings": {
      "term": {
        "name": "string"
      },
      "billingFrequency": {
        "name": "string"
      },
      "quantity": 42,
      "customTermEndDate": "2024-05-04T09:42:00+00:00"
    },
    "endDate": "2024-05-04T09:42:00+00:00",
    "status": {
      "name": "string"
    }
  },
  "providerSubscription": {
    "name": "string",
    "quantity": 42,
    "nextBillingFrequency": {
      "name": "string"
    },
    "autoRenewEnabled": true,
    "autoRenewSettings": {
      "term": {
        "name": "string"
      },
      "billingFrequency": {
        "name": "string"
      },
      "quantity": 42,
      "customTermEndDate": "2024-05-04T09:42:00+00:00"
    },
    "endDate": "2024-05-04T09:42:00+00:00",
    "status": {
      "name": "string"
    }
  }
}

Response examples (404)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (404)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (500)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (500)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}