Update an order item

Request

Updates an order item.
Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required
ID of the resource.
itemIdstringrequired
ID of the order item.
Bodyapplication/jsonrequired
Update item request.
quantityFillednumber or null, (double)
Filled quantity of the subscription item.
Example:5.125
excludeFromMrrboolean
Specifies if this item should be excluded from monthly recurring revenue calculations.
planobject
Details of the subscription item plan.
curl -i -X PATCH \
  'https://www.rebilly.com/_mock/catalog/all/orders/{id}/items/{itemId}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "quantityFilled": 5.125,
    "excludeFromMrr": true,
    "plan": {
      "productOptions": {
        "region": "US",
        "size": "xxl"
      }
    }
  }'

Responses

Order item updated.
Headers
Rate-Limit-Limitinteger

Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.

Example:500
Rate-Limit-Remaininginteger

Number of requests still available for this rate limit. For more information, see Rate limits.

Example:499
Bodyapplication/json
idstring, <= 50 charactersread-only
ID of the order item.
quantityinteger, [ 0 .. 1000000000 ]
Number of product units in the specified plan.
quantityFillednumber or null, (double)
Number of filled product units.
Example:5.125
planOriginalPlan (object) or (FlexiblePlan (OneTimeSalePlan (object) or SubscriptionPlan (object) or TrialOnlyPlan (object)))required
One of:

Use an existing plan without changes for the current order.

To create a new plan, see Create a plan.

usageLimitsUsageLimits (object) or null
One of:
Specifies the soft and hard usage limit thresholds for an item with a metered billing plan. This value is ignored when the plan is not metered.
usageStatusUsageStatus (object) or null
One of:
Current status of the usage limits.
revisionintegerread-only
Revision number that increments with each overriding change to this specific plan item.
isModifiedbooleanread-only
Specifies if the plan information is modified for this subscription.
isGrandfatheredbooleanread-only
Specifies if the current plan revision number is greater than the plan item revision number.
excludeFromMrrboolean
Specifies if this item should be excluded from monthly recurring revenue calculations.
_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

planIdstring, <= 50 charactersdeprecated

ID of the plan.

Note: This field is deprecated. Use the plan.id field instead.

Example:"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"
Response
{ "id": "string", "planId": "plan_0YV7DENSVGDBW9S71XZNNYYQ0X", "quantity": 0, "quantityFilled": 5.125, "plan": { "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21" }, "usageLimits": null, "usageStatus": null, "revision": 0, "isModified": true, "isGrandfathered": true, "excludeFromMrr": true, "_embedded": { "product": {} } }