:orphan:

Get subscription term immediate change options
==============================================

Returns the term durations and billing cycles a subscription can be immediately changed to.

If the subscription's term lifecycle state is *EndOfSale*, an empty collection is returned.

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

- Credentials as described in :doc:`/getting-started/authentication`
- A Subscription identifier

Request
^^^^^^^

Request Syntax:

+---------+---------------------------------------------------------------------------------------+
| Method  | Request URI                                                                           |
+=========+=======================================================================================+
| GET     | *https://api.crayon.com/api/v1/subscriptions/{id}/term-immediate-change-options*      |
+---------+---------------------------------------------------------------------------------------+

Request Parameters:

+-------+-----------+----------------------------------------------------------------------+
| Name  | Type      | Description                                                          |
+=======+===========+======================================================================+
| id    | int       | Identifier for subscription                                          |
+-------+-----------+----------------------------------------------------------------------+

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".    |
+------------------+----------------+-----------------------------------------------------------------+

Request Example:

::

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


Response
^^^^^^^^

If successful, this method returns a :doc:`/resources/SubscriptionTermImmediateChangeOption` collection in the response body.

.. literalinclude:: /resources/_static/SubscriptionTermImmediateChangeOptions.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.                                                                                                                                                                                                                                                                                |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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.                                                       |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+