Zum Hauptinhalt springen
GET
/
subscription-items
/
{id}
/
change-options
cURL
curl -X GET \
 /subscription-items/{id}/change-options \
 --header "Authorization: Bearer <token>"
{
  "current": {
    "id": "<string>",
    "name": "<string>",
    "pricePlan": "<unknown>",
    "product": "<unknown>"
  },
  "options": [
    {
      "id": "<string>",
      "label": "<string>",
      "product": "<unknown>",
      "pricePlans": [
        "<unknown>"
      ],
      "changeTiming": "immediately",
      "creditType": "full",
      "isUpgrade": true,
      "isDowngrade": true
    }
  ],
  "hasPendingChange": true
}
Get available upgrade and downgrade options for a subscription item.

​
Prerequisites

The subscription item must have a product group assigned via PUT /subscription-items/{id}/product-group.

​
Response

The response includes:
  • current: Information about the current membership and price plan
  • options: Available upgrade/downgrade options
  • hasPendingChange: Whether a change is already scheduled
If hasPendingChange is true, no further changes can be made until the pending change is applied.

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

​
id
string
erforderlich

SubscriptionItem identifier

Antwort

Change options for the subscription item

Available change options for a subscription item

​
current
object

Current membership information

​
options
object[]
​
hasPendingChange
boolean

Whether a change is already scheduled