Update Order Subscription

Updates and existing subscription

put

Path parameters

idstringRequired

Id of the subscription to update

orderIdstringRequired

Body

application/jsontext/jsonapplication/*+json

idstringOptional

namestringOptional

startDatestring · date-timeOptional

terminationDatestring · date-time | nullableOptional

productall ofOptional

autoRenewbooleanOptional

statusstring · enumOptionalPossible values:

commitmentDatestring · date-time | nullableOptional

agreementall ofOptional

templateall ofOptional

Responses

200

OK

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

put

HTTPcURLJavaScriptPython

PUT /public/v1/commerce/orders/{orderId}/subscriptions/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 3598

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-05-16T06:20:27.906Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-05-16T06:20:27.906Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "active": {
      "at": "2025-05-16T06:20:27.906Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "terminated": {
      "at": "2025-05-16T06:20:27.906Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "terminating": {
      "at": "2025-05-16T06:20:27.906Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updating": {
      "at": "2025-05-16T06:20:27.906Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "startDate": "2025-05-16T06:20:27.906Z",
  "terminationDate": "2025-05-16T06:20:27.906Z",
  "externalIds": {
    "client": "text",
    "operations": "text",
    "vendor": "text"
  },
  "terms": {
    "period": "1m",
    "commitment": "1m"
  },
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "autoRenew": true,
  "status": "Draft",
  "commitmentDate": "2025-05-16T06:20:27.906Z",
  "parameters": {
    "fulfillment": [
      {
        "id": "text",
        "externalId": "text",
        "name": "text",
        "type": "SingleLineText",
        "phase": "Configuration",
        "error": {
          "id": "text",
          "message": "text",
          "parameters": null
        },
        "constraints": {
          "required": true,
          "hidden": true,
          "readonly": true
        },
        "displayValue": "text",
        "value": null
      }
    ]
  },
  "agreement": {
    "id": "text",
    "icon": "text",
    "status": "New",
    "name": "text"
  },
  "price": {
    "currency": "text",
    "markup": 1,
    "margin": 1,
    "SPxY": 1,
    "SPxM": 1,
    "PPxY": 1,
    "PPxM": 1,
    "defaultMarkup": 1,
    "defaultMargin": 1
  },
  "lines": [
    {
      "id": "text",
      "oldQuantity": 1,
      "quantity": 1,
      "price": {
        "currency": "text",
        "markup": 1,
        "margin": 1,
        "unitSP": 1,
        "unitPP": 1,
        "PPx1": 1,
        "SPx1": 1,
        "SPxY": 1,
        "SPxM": 1,
        "PPxY": 1,
        "PPxM": 1
      },
      "item": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "vendor": "text",
          "operations": "text"
        }
      },
      "subscription": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-05-16T06:20:27.906Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "updated": {
            "at": "2025-05-16T06:20:27.906Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "active": {
            "at": "2025-05-16T06:20:27.906Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "terminated": {
            "at": "2025-05-16T06:20:27.906Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "terminating": {
            "at": "2025-05-16T06:20:27.906Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "updating": {
            "at": "2025-05-16T06:20:27.906Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "startDate": "2025-05-16T06:20:27.906Z",
        "terminationDate": "2025-05-16T06:20:27.906Z",
        "externalIds": {
          "client": "text",
          "operations": "text",
          "vendor": "text"
        },
        "terms": {
          "period": "1m",
          "commitment": "1m"
        },
        "product": {
          "id": "text",
          "name": "text",
          "externalIds": {
            "operations": "text"
          },
          "icon": "text",
          "status": "text"
        },
        "autoRenew": true,
        "status": "Draft",
        "commitmentDate": "2025-05-16T06:20:27.906Z",
        "parameters": {
          "fulfillment": [
            {
              "id": "text",
              "externalId": "text",
              "name": "text",
              "type": "SingleLineText",
              "phase": "Configuration",
              "error": {
                "id": "text",
                "message": "text",
                "parameters": null
              },
              "constraints": {
                "required": true,
                "hidden": true,
                "readonly": true
              },
              "displayValue": "text",
              "value": null
            }
          ]
        },
        "agreement": {
          "id": "text",
          "icon": "text",
          "status": "New",
          "name": "text"
        },
        "price": {
          "currency": "text",
          "markup": 1,
          "margin": 1,
          "SPxY": 1,
          "SPxM": 1,
          "PPxY": 1,
          "PPxM": 1,
          "defaultMarkup": 1,
          "defaultMargin": 1
        },
        "lines": [
          {
            "id": "text",
            "oldQuantity": 1,
            "quantity": 1,
            "price": {
              "currency": "text",
              "markup": 1,
              "margin": 1,
              "unitSP": 1,
              "unitPP": 1,
              "PPx1": 1,
              "SPx1": 1,
              "SPxY": 1,
              "SPxM": 1,
              "PPxY": 1,
              "PPxM": 1
            },
            "item": {
              "id": "text",
              "name": "text",
              "externalIds": {
                "vendor": "text",
                "operations": "text"
              }
            },
            "subscription": "[Circular Reference]"
          }
        ],
        "template": {
          "id": "text",
          "name": "text"
        }
      }
    }
  ],
  "template": {
    "id": "text",
    "name": "text"
  }
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-05-16T06:20:27.906Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-05-16T06:20:27.906Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "active": {
      "at": "2025-05-16T06:20:27.906Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "terminated": {
      "at": "2025-05-16T06:20:27.906Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "terminating": {
      "at": "2025-05-16T06:20:27.906Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updating": {
      "at": "2025-05-16T06:20:27.906Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "expired": {
      "at": "2025-05-16T06:20:27.906Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "renewed": {
      "at": "2025-05-16T06:20:27.906Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "startDate": "2025-05-16T06:20:27.906Z",
  "terminationDate": "2025-05-16T06:20:27.906Z",
  "externalIds": {
    "client": "text",
    "operations": "text",
    "vendor": "text"
  },
  "terms": {
    "period": "1m",
    "commitment": "1m"
  },
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "autoRenew": true,
  "status": "Active",
  "commitmentDate": "2025-05-16T06:20:27.906Z",
  "price": {
    "currency": "text",
    "markup": 1,
    "margin": 1,
    "SPxY": 1,
    "SPxM": 1,
    "PPxY": 1,
    "PPxM": 1,
    "defaultMarkup": 1,
    "defaultMargin": 1
  },
  "parameters": {
    "fulfillment": [
      {
        "id": "text",
        "externalId": "text",
        "name": "text",
        "type": "SingleLineText",
        "phase": "Configuration",
        "error": {
          "id": "text",
          "message": "text",
          "parameters": null
        },
        "constraints": {
          "required": true,
          "hidden": true,
          "readonly": true
        },
        "displayValue": "text",
        "value": null
      }
    ]
  },
  "agreement": {
    "id": "text",
    "icon": "text",
    "status": "New",
    "name": "text"
  },
  "buyer": {
    "id": "text",
    "icon": "text",
    "name": "text"
  },
  "licensee": {
    "id": "text",
    "icon": "text",
    "name": "text",
    "externalId": "text"
  },
  "seller": {
    "id": "text",
    "icon": "text",
    "externalId": "text",
    "name": "text",
    "erpLink": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-05-16T06:20:27.906Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-05-16T06:20:27.906Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "blocked": {
          "at": "2025-05-16T06:20:27.906Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "unblocked": {
          "at": "2025-05-16T06:20:27.906Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "id": "text",
        "icon": "text",
        "externalId": "text",
        "name": "text",
        "erpLink": "[Circular Reference]"
      },
      "name": "text",
      "status": "Active",
      "note": "text",
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      }
    }
  },
  "split": {
    "id": "text"
  },
  "splitStatus": "Disabled",
  "lines": [
    {
      "id": "text",
      "quantity": 1,
      "item": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "vendor": "text",
          "operations": "text"
        }
      },
      "audit": {
        "created": {
          "at": "2025-05-16T06:20:27.906Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-05-16T06:20:27.906Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "terminated": {
          "at": "2025-05-16T06:20:27.906Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "deleted": {
          "at": "2025-05-16T06:20:27.906Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        }
      },
      "price": {
        "currency": "text",
        "markup": 1,
        "margin": 1,
        "unitSP": 1,
        "unitPP": 1,
        "SPxY": 1,
        "SPxM": 1,
        "PPxY": 1,
        "PPxM": 1
      },
      "subscription": {
        "id": "text",
        "name": "text"
      },
      "status": "Active"
    }
  ],
  "template": {
    "id": "text",
    "name": "text"
  }
}