Update an order pause

Request

Updates an order pause with a specified ID.
Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required
ID of the resource.
Bodyapplication/json
orderIdstring, <= 50 charactersrequired
ID of the paused order.
Example:"ord_01HVKA5975PJBSQ1SX72G3MSZC"
pausedBystring
Specifies who initiated the pause.
Default:"customer"
Enum:"merchant""customer"
descriptionstring or null, <= 255 characters
Description of the pause reason in free form.
effectiveTimestring or null, (date-time)
Date and time when the service period pauses. This time must be later than the current time. If this time is earlier than the current time, the current time is used. If this field is omitted, this value defaults to the current time.
endTimestring or null, (date-time)

Date and time when the pause ends and the order resumes billing.

To resume an order from this point in time, use the current time or an earlier time. If endTime is earlier than the current time, the current time is used. If this field is empty, the order is indefinitely paused.

timeRemainingstring or null

Amount of time between the pause end time and the renewal time in ISO-8601 durations format. By default, this value is computed as the time between the pause and the renewal.

Example: A $30 per month order on a 30-day month is paused on day 20. There are 10 unused days on the order. Therefore, the order renews in 10 days after it is resumed. The upcoming invoice does not change the amount for the invoiced period, it remains at $30. If a subscription item in the order uses a service period anchor, the renewal time after a pause shift behaves as though the renewal time is moved forward by an Order API operation, and the service period anchor is ignored for that period.

For more information, see Service period anchor, billing timing, and invoice time shift.

Example:"P3600S"
curl -i -X PUT \
  'https://www.rebilly.com/_mock/catalog/all/order-pauses/{id}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "orderId": "ord_01HVKA5975PJBSQ1SX72G3MSZC",
    "pausedBy": "merchant",
    "description": "string",
    "effectiveTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "timeRemaining": "P3600S"
  }'

Responses

Pause 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 pause.
Example:"sub_pau_01H085J3ZR1WKD120D73D7N4C9"
orderIdstring, <= 50 charactersrequired
ID of the paused order.
Example:"ord_01HVKA5975PJBSQ1SX72G3MSZC"
statusstringread-only
Status of the order pause.
Enum:"pending""ongoing""revoked""finished"
pausedBystring
Specifies who initiated the pause.
Default:"customer"
Enum:"merchant""customer"
descriptionstring or null, <= 255 characters
Description of the pause reason in free form.
effectiveTimestring or null, (date-time)
Date and time when the service period pauses. This time must be later than the current time. If this time is earlier than the current time, the current time is used. If this field is omitted, this value defaults to the current time.
endTimestring or null, (date-time)

Date and time when the pause ends and the order resumes billing.

To resume an order from this point in time, use the current time or an earlier time. If endTime is earlier than the current time, the current time is used. If this field is empty, the order is indefinitely paused.

timeRemainingstring or null

Amount of time between the pause end time and the renewal time in ISO-8601 durations format. By default, this value is computed as the time between the pause and the renewal.

Example: A $30 per month order on a 30-day month is paused on day 20. There are 10 unused days on the order. Therefore, the order renews in 10 days after it is resumed. The upcoming invoice does not change the amount for the invoiced period, it remains at $30. If a subscription item in the order uses a service period anchor, the renewal time after a pause shift behaves as though the renewal time is moved forward by an Order API operation, and the service period anchor is ignored for that period.

For more information, see Service period anchor, billing timing, and invoice time shift.

Example:"P3600S"
createdTimestring, (date-time)(CreatedTime)read-only
Date and time when the resource is created. This value is set automatically when the resource is created.
updatedTimestring, (date-time)(UpdatedTime)read-only
Date and time when the resource is updated. This value is set automatically when the resource is updated.
Response
{ "id": "sub_pau_01H085J3ZR1WKD120D73D7N4C9", "orderId": "ord_01HVKA5975PJBSQ1SX72G3MSZC", "status": "pending", "pausedBy": "merchant", "description": "string", "effectiveTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "timeRemaining": "P3600S", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }