Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.
Retrieves a list of order changes. To find the pending change of an order, use filter=orderId:{orderId};status:pending.
Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.
For more information, see Search filters.
- Mock serverhttps://www.rebilly.com/_mock/catalog/all/order-changes
- Sandbox serverhttps://api-sandbox.rebilly.com/organizations/{organizationId}/order-changes
- Live serverhttps://api.rebilly.com/organizations/{organizationId}/order-changes
curl -i -X GET \
'https://www.rebilly.com/_mock/catalog/all/order-changes?limit=0&offset=0&filter=string&sort=string' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'Total number of items that match the request. The value is independent of limit, including when limit is 0.
| Enum Value | Description |
|---|---|
| pending | |
| applied | |
| canceled | |
| superseded |
Time when the new items are applied.
now: The items change immediately.renewalPolicy,prorated, andeffectiveTimeapply.nextRenewal: The current items stay until the next renewal. The new items are billed on the next renewal invoice.renewalPolicy,prorated, andeffectiveTimeare not allowed. A later change for the same order supersedes the pending change. The pending change is locked when the next renewal invoice is issued. To remove a pending change, use theDELETE /order-changes/{id}operation. The new items must differ from the current items. One-time sale items that are already on the order remain. A one-time sale item cannot be added withnextRenewal.
Date and time when the change is applied. If applyAt is set to now, this value is the date from which the renewal time for resetToRecurring and the proration are calculated. If this field is omitted, this value defaults to the current time. If applyAt is set to nextRenewal, this value is read-only and equals the renewal time of the order.
ID of the quote that is used to create the change. This value is null if the change is not created from a quote.
How the service periods and trial state of the order are managed when its items change now. Required when applyAt is now. Not allowed when applyAt is nextRenewal.
| Enum Value | Description |
|---|---|
| resetToRecurring | |
| retainRecurring | |
| retainTrialThenRecurring | |
| retainTrialOnly |
Specifies whether to give a pro rata credit for the amount of time remaining between the effectiveTime and the end of the current period. Required when applyAt is now. Not allowed when applyAt is nextRenewal.
If renewalTime is retained by setting renewalPolicy to retainRecurring, retainTrialThenRecurring, or retainTrialOnly, a pro rata debit is also applied for the time between effectiveTime and renewalTime, as a percentage of the normal period size.
[ { "id": "ord_chg_0YV7DES3WPC5J8JD8QTVNZBZQ8", "orderId": "ord_01HRF27SATGE4Z6PBJE6PD8328", "status": "pending", "applyAt": "now", "effectiveTime": "2019-08-24T14:15:22Z", "lockedTime": "2019-08-24T14:15:22Z", "appliedTime": "2019-08-24T14:15:22Z", "quoteId": "string", "items": [ … ], "renewalPolicy": "resetToRecurring", "prorated": true, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ … ] } ]