Create New Subscription
Initiates the creation of a subscription
Request
URLURL
Parameters
Parameters
Request Body
SubscriptionRequest (required){
"commitment_term": "string",
"offer_name": "string",
"offer_version": "string",
"product_type": "string",
"quantity": 0,
"region": "string"
}
Old identifier for product. Deprecarted. See product and type
Frequency of the billing.
The product for which subscription needs to be created. Refer /vmc/api/orgs/{orgId}/products.
The type of the product for which the subscription needs to be created.
Response
Response BodyResponse Body
{
"correlation_id": "string",
"created": "string",
"end_resource_entity_version": 5,
"end_time": "string",
"error_message": "string",
"estimated_remaining_minutes": 4,
"id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
"localized_error_message": "string",
"org_id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
"org_type": "string",
"parent_task_id": "string",
"phase_in_progress": "string",
"progress_percent": 75,
"resource_id": "string",
"resource_type": "string",
"service_errors": [
{
"default_message": "string",
"localized_message": "string",
"original_service": "string",
"original_service_error_code": "string"
}
],
"start_resource_entity_version": 0,
"start_time": "string",
"status": "string",
"sub_status": "string",
"task_progress_phases": [
{
"id": "string",
"name": "string",
"progress_percent": 0
}
],
"task_type": "string",
"task_version": "string",
"updated": "string",
"updated_by_user_id": "string",
"updated_by_user_name": "string",
"user_id": "string",
"user_name": "string",
"version": 5
}
Unique ID for this entity
Possible values are: STARTED, CANCELING, FINISHED, FAILED, CANCELED
User id that last updated this record
User id that last updated this record
User name that last updated this record
Version of this entity
(Optional) Client provided uniqifier to make task creation idempotent. Be aware not all tasks support this. For tasks that do - supplying the same correlation Id, for the same task type, within a predefined window will ensure the operation happens at most once.
Entity version of the resource at the end of the task. This is only set for some task types.
Estimated remaining time in minute of the task execution, < 0 means no estimation for the task.
If this task was created by another task - this provides the linkage. Mostly for debugging.
The current in progress phase ID in the task execution, if none in progress, empty string returned.
Estimated progress percentage the task executed
UUID of the resource the task is acting upon
Type of resource being acted upon
Entity version of the resource at the start of the task. This is only set for some task types.
Task progress phases involved in current task execution
User name that last updated this record