Update subscription
===================

Update a subscription. Subscription has to be active to be able to be updated. Before you update the state of a subscription please use the Microsoft documentation to verify that the correct state is used: `Microsoft lifecycle states <https://learn.microsoft.com/en-us/partner-center/subscription-lifecycle>`_

Prerequisites
^^^^^^^^^^^^^

- Credentials as described in :doc:`/getting-started/authentication`
- A subscription identifier
- Active subscription to update

C#
^^

To update subscription, first get the instance of **SubscriptionDetailed** by passing your subscription id to the method **Subscriptions.GetById()**.

Next, get the instance of **CrayonApiClient** and then get the client token using the instance. This client token will be passed when creating the subscription.

Finally, call **Subscriptions.Update()** method to update subscription by passing the token and the instance of updated **SubscriptionDetailed**.

Here, the code updates subscription status to suspended and quantity to 10 for example.

.. code-block:: c#
	:emphasize-lines: 9
	
	var subscriptionId = <subscription id>; 
	var client = new CrayonApiClient("https://api.crayon.com/");
	var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;

	var subscription = client.Subscriptions.GetById(token, subscriptionId).GetData();
	subscription.Status = SubscriptionStatus.Suspended;
	subscription.Quantity = 10;

	var result = client.Subscriptions.Update(token, subscription);


Request
^^^^^^^

Request Syntax:

+---------+-------------------------------------------------------+
| Method  | Request URI                                           |
+=========+=======================================================+
| PUT     | *https://api.crayon.com/api/v1/subscriptions/{id}/*   |
+---------+-------------------------------------------------------+

Request Body:

+---------------+-----------------------------------------+-----------------------------------+
| Name          | Type                                    | Description                       |
+===============+=========================================+===================================+
| subscription	| :doc:`/resources/SubscriptionDetailed`  | The subscription to update        |
+---------------+-----------------------------------------+-----------------------------------+

Request Headers:

The following HTTP request headers are supported

+------------------+----------------+-----------------------------------------------------------------+
| Header           | Type           | Description                                                     |
+==================+================+=================================================================+
| Authorization    | string         | Required. The authorization token in the form Bearer <token>.   |
+------------------+----------------+----------------------------------------------+------------------+
| Accept           | string         | Specifies the request and response type, "application/json".    |
+------------------+----------------+----------------------------------------------+------------------+
| Content-Type     | string         | Specifies the media type of the resource, "application/json".   |
+------------------+----------------+----------------------------------------------+------------------+

Request Example:

::

	PUT $"https://api.crayon.com/api/v1/subscriptions/{id}/"
	Accept: application/json
	Content-Type: application/json 
	Authorization: Bearer < Token >	

.. literalinclude:: /resources/_static/SubscriptionDetailed.json
		:language: json


Response
^^^^^^^^

If successful, this method returns the updated subscription as a :doc:`/resources/SubscriptionDetailed` resource in the response body.

Response Body:

.. literalinclude:: /resources/_static/SubscriptionDetailed.json
		:language: json

Response success and error codes:

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.

+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error Codes                    | Description                                                                                                                                                                                                                                                                               |
+================================+===========================================================================================================================================================================================================================================================================================+
| 200 Ok                         | The request has succeeded.                                                                                                                                                                                                                                                                |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 400 Bad Request                | The request could not be understood by the server due to malformed syntax, missing required properties, properties that couldn't be parsed according to their type (and length). It is a non-retryable error condition. The client should not repeat the request without modifications.   |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 401 Unauthorized               | The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition.                                      |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 404 Not Found                  | The server has not found anything matching the request.                                                                                                                                                                                                                                   |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+