Create New Subscription

Contains  SubscriptionRequest (required)

Show optional properties

{
    "commitment_term": "string",
    "offer_name": "string",
    "offer_version": "string",
    "product_type": "string",
    "quantity": 0,
    "region": "string"
}

{
    "billing_frequency": "string",
    "commitment_term": "string",
    "offer_context_id": "string",
    "offer_name": "string",
    "offer_version": "string",
    "price": 0,
    "product": "string",
    "product_charge_id": "string",
    "product_id": "string",
    "product_type": "string",
    "quantity": 0,
    "region": "string",
    "type": "string"
}

Required	Property Name	Type	Description
required	commitment_term	string	Not available
required	offer_name	string	Not available
required	offer_version	string	Not available
required	product_type	string	Old identifier for product. Deprecarted. See product and type
required	quantity	integer	Not available
required	region	string	Not available
optional	billing_frequency	string	Frequency of the billing.
optional	offer_context_id	string	Not available
optional	price	integer	Not available
optional	product	string	The product for which subscription needs to be created. Refer /vmc/api/orgs/{orgId}/products.
optional	product_charge_id	string	Not available
optional	product_id	string	Not available
optional	type	string	The type of the product for which the subscription needs to be created.

202 Accepted returns Task

{
    "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
}

Property Name	Type	Description
created	string	Not available
id	string	Unique ID for this entity
start_time	string	Not available
status	string	Not available
sub_status	string	Not available
task_type	string	Not available
updated	string	Not available
updated_by_user_id	string	User id that last updated this record
user_id	string	User id that last updated this record
user_name	string	User name that last updated this record
version	integer	Version of this entity
correlation_id	string	(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.
end_resource_entity_version	integer	Entity version of the resource at the end of the task. This is only set for some task types.
end_time	string	Not available
error_message	string	Not available
estimated_remaining_minutes	integer	Estimated remaining time in minute of the task execution, < 0 means no estimation for the task.
localized_error_message	string	Not available
org_id	string	Not available
org_type	string	Not available
params	object	Not available
parent_task_id	string	If this task was created by another task - this provides the linkage. Mostly for debugging.
phase_in_progress	string	The current in progress phase ID in the task execution, if none in progress, empty string returned.
progress_percent	integer	Estimated progress percentage the task executed
resource_id	string	UUID of the resource the task is acting upon
resource_type	string	Type of resource being acted upon
service_errors	array of ServiceError	Service errors returned from SDDC services.
start_resource_entity_version	integer	Entity version of the resource at the start of the task. This is only set for some task types.
task_progress_phases	array of TaskProgressPhase	Task progress phases involved in current task execution
task_version	string	Not available
updated_by_user_name	string	User name that last updated this record