Sign in

v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Apply upgrade profile

This endpoint allows you to apply an upgrade profile to a subscription contract.

post/2023-10/subscription/{subscriptionId}/upgrade

Path parameters

subscriptionIdinteger required

The unique identifier of the subscription in Loop.

Request body

profileIdinteger required

The unique identifier of the upgrade profile to apply to the subscription. This ID can be retrieved using the Fetch Upgrade Profiles API.

Response

200

successboolean

Indicates whether the request was processed successfully.

messagestring

A message describing the result of the request.

codestring

The response code indicating the outcome of the request.

{"stackTrail":"paths:/2023-10/subscription/{subscriptionId}/upgrade:post:responses:200:content:application/json:schema:properties:pageInfo","oasType":"schema","type":"unknown","description":"Pagination metadata. Returns null for this endpoint as pagination is not applicable."}

Example response

{
  "success": true,
  "message": "Subscription upgrade request created successfully",
  "data": {
    "upcomingOrderDetail": {
      "id": 121311
    }
  },
  "code": "SUCCESS"
}