Skip to main content
POST
/
licenses
/
{licenseId}
/
cancel
Error
A valid request URL is required to generate request examples
{
  "licenseId": "<string>",
  "status": "PENDING",
  "type": "<string>",
  "customer": {
    "customerId": "<string>",
    "name": "<string>"
  },
  "productOffering": {
    "productOfferingId": "<string>",
    "name": "<string>",
    "price": {
      "currency": "USD",
      "discount": 5,
      "netPrice": 5,
      "priceType": "ONE_TIME",
      "boundMonths": 12,
      "billingCycle": {
        "period": "MONTHLY",
        "interval": 1
      }
    },
    "productOfferingGroupId": "<string>",
    "group": {
      "productOfferingGroupId": "<string>",
      "name": "<string>",
      "category": "SUBSCRIPTION_CELL"
    }
  },
  "activatedAt": "2023-12-25",
  "assignedTo": {
    "type": "SUBSCRIPTION",
    "subscriptionId": "<string>",
    "subscriptionDisplay": "<string>"
  },
  "details": {},
  "pendingStatus": {
    "status": "PENDING",
    "scheduledAt": "2023-12-25"
  },
  "pendingProductOffering": {
    "scheduledAt": "2023-12-25",
    "product": {
      "productOfferingId": "<string>",
      "name": "<string>",
      "price": {
        "currency": "USD",
        "discount": 5,
        "netPrice": 5,
        "priceType": "ONE_TIME",
        "boundMonths": 12,
        "billingCycle": {
          "period": "MONTHLY",
          "interval": 1
        }
      },
      "productOfferingGroupId": "<string>",
      "group": {
        "productOfferingGroupId": "<string>",
        "name": "<string>",
        "category": "SUBSCRIPTION_CELL"
      }
    }
  },
  "cancelledAt": "2023-12-25",
  "pausedAt": "2023-12-25",
  "metadata": {}
}

Authorizations

​
X-Api-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Headers

​
X-Idempotency-Key
string

A unique key to ensure idempotency of requests. If a request with the same key has already been processed, the same result will be returned. The key must be unique for each distinct operation. Keys are expired after 24 hours, but we recommend using a new key for each request.

Modified requests with the same idempotency keys are rejected with a 409 Conflict status code.

Maximum string length: 256

Path Parameters

​
licenseId
string
required

The unique identifier of the license.

Body

application/json

Request to cancel a license.

​
scheduledAt
string<date>

The date when the license should be cancelled. If not provided, the license will be cancelled immediately or according to the default schedule.

Example:

"2024-03-01"

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

Response

License cancellation scheduled successfully.

A license represents a permission to use a software product with embedded customer and product offering details.

​
licenseId
string
required

The unique identifier for the license.

​
status
enum<string>
required

The status of the license.

Available options:
PENDING,
ACTIVE,
PAUSED,
CANCELLED,
BLOCKED
​
type
string
required

The type of license, categorizing the software product or service into various telecommunications license types.

​
customer
object
required

Customer information embedded in responses. Sensitive details require separate API calls with appropriate authorization.

​
productOffering
object
required

Embedded representation of a product offering.

​
activatedAt
string<date>
required

The date and time when the license was activated.

​
assignedTo
Subscription · object

Assignment details for a license, indicating what entity the license is assigned to. This embedded version includes additional display information for each assignment type.

​
details
object

Additional license details specific to certain license types.

​
pendingStatus
object

Details about when a pending status change is scheduled for this license.

​
pendingProductOffering
object

Pending product offering change.

​
cancelledAt
string<date>

The date and time when the license was cancelled (if applicable).

​
pausedAt
string<date>

The date and time when the license was paused (if applicable).

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.