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 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 SubscriptionTermImmediateChangeOption collection in the response body.

[
  {
    "TermDuration": "P1Y",
    "BillingCycleOptions": [
        1,
        2
    ]
  },
  {
    "TermDuration": "P1M",
    "BillingCycleOptions": [
      1
    ]
  }
]

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.