# Update a subscription order item

Updates a subscription order item. This is an experimental endpoint, can be changed or removed in the future.

Endpoint: PATCH /subscriptions/{id}/items/{itemId}
Version: latest
Security: SecretApiKey, JWT

## Path parameters:

  - `id` (string, required)
    ID of the resource.

  - `itemId` (string, required)
    ID of subscription item.

## Request fields (application/json):

  - `quantityFilled` (number, required)
    Filled quantity of the subscription item (experimental property).
    Example: 5.125

  - `excludeFromMrr` (boolean)
    Specifies if this item should be excluded from monthly recurring revenue calculations.

## Response 200 fields (application/json):

  - `id` (string)
    ID of the order item.

  - `quantity` (integer)
    Number of product units in the specified plan.

  - `quantityFilled` (number)
    Number of filled product units.
    Example: 5.125

  - `plan` (any, required)

  - `usageLimits` (any)

  - `usageStatus` (object,null)
    Current status of the usage limits.

  - `usageStatus.isSoftLimitReached` (boolean)
    Specifies if the soft limit has been reached.

  - `usageStatus.isHardLimitReached` (boolean)
    Specifies if the hard limit has been reached.

  - `usageStatus.isTrialLimitReached` (boolean)
    Specifies if the trial limit has been reached.

  - `revision` (integer)
    Revision number that increments with each overriding change to this specific plan item.

  - `isModified` (boolean)
    Specifies if the plan information is modified for this subscription.

  - `isGrandfathered` (boolean)
    Specifies if the current plan revision number is greater than the plan item revision number.

  - `excludeFromMrr` (boolean)
    Specifies if this item should be excluded from monthly recurring revenue calculations.

  - `_embedded` (object)
    Embedded objects that are requested by the  query parameter.

  - `_embedded.product` (object)

  - `planId` (string)
    ID of the plan.
    Example: "plan_0YV7DENSVGDBW9S71XZNNYYQ0X"

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 422 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

  - `invalidFields` (array)
    Invalid field details.
    Example: [{"field":"field1","message":"field1 is invalid"},{"field":"subObject.field2","message":"field2 is invalid"},{"field":"subObject.field2","message":"another error in the field2"}]

  - `invalidFields.field` (string)
    Name of the field.
Dot notation is used for nested object field names.

  - `invalidFields.message` (string)
    Message field.

## Response 429 fields (application/json):

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".
    Example: "about:blank"

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
    Example: "Rate Limit Exceeded"

  - `status` (integer)
    HTTP status code.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.
    Example: "A request cannot be executed because the user has sent too many requests within a certain period of time"

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.