POST /order-pauses
Pauses an order with a specified ID.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
ID of the order pause. |
_links[] |
Array | No |
Related links. |
_links[].href |
String | No |
Link URL. |
_links[].rel |
String | No |
Type of link. Valid values:
|
pausedBy |
String | No |
Specifies who initiated the pause. Valid values:
Default value: "customer" |
orderId |
String | Yes |
ID of the paused order. |
description |
String | No |
Description of the pause reason in free form. |
updatedTime |
String | No |
Date and time when the resource is updated. This value is set automatically when the resource is updated. |
createdTime |
String | No |
Date and time when the resource is created. This value is set automatically when the resource is created. |
status |
String | No |
Status of the order pause. Valid values:
|
effectiveTime |
String | No |
Date and time when the service period pauses. This time must be later than the current time. If this time is earlier then the current time, the current time is used. If this field is omitted, this value defaults to the current time. |
endTime |
String | No |
Date and time when the pause ends and the order resumes billing. To resume a order from this point in time,
use the current time or an earlier time.
If |
timeRemaining |
String | No |
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 subscription on a 30-day month is paused on day 20 of the order. 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 the order uses a billing anchor, the renewal time after a pause shift behaves as though the renewal time is moved forward by an Order API operation, and the billing anchor is ignored for that period. For more information, see Service period anchor, billing timing, and invoice time shift. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.