latestSwagger 2.02026-08-109450223.9 KB

94acb422c07d

Reseller

Upgrade Reseller Subscription

Upgrades an active subscription by creating a new subscription with a higher minimum and/or price tier, replacing the existing one.

This is modeled as a sub-resource because the operation creates a new subscription record rather than modifying the existing one in place.

post/v1/reseller/subscriptions/{id}/upgrade

Path parameters

idinteger required

Request body

minimuminteger required

New minimum usage commitment (must be greater than zero)

purchase_orderstring

Purchase order number (defaults to existing subscription's PO)

on_renewalboolean

Schedule upgrade for next renewal instead of immediately

Response

Upgrade Reseller Subscription

Example response

{
  "subscription": {
    "id": 1,
    "account": {
      "id": 1,
      "name": "Little Bobby's Table Emporium"
    },
    "product": "edr",
    "status": "active",
    "minimum_usage": 50,
    "terminal_minimum_usage": 100,
    "billing_interval": "monthly",
    "effective_date": "2024-01-01T00:00:00Z",
    "renewal_date": "2025-01-01T00:00:00Z",
    "auto_renew": true,
    "schedules": [
      {
        "id": 1,
        "minimum": 100,
        "maximum": 500,
        "status": "active",
        "target_price": 200,
        "months": 12,
        "promo_units": 0,
        "starts_at": "2024-01-01T00:00:00Z",
        "ends_at": "2025-01-01T00:00:00Z"
      }
    ]
  }
}