Updates a subscription order pause.
Updates a subscription order pause.
| subscriptionId required | string <= 50 characters ID of the paused subscription. |
| pausedBy | string Default: "customer" Specifies who initiated the pause. |
| description | string or null <= 255 characters Description of the pause reason in free form. |
| effectiveTime | string 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 then the current time, the current time is used. If this field is omitted, this value defaults to the current time. |
| endTime | string or null <date-time> Date and time when the pause ends and the subscription resumes billing. To resume a subscription from this point in time, use the current time or an earlier time. If |
| timeRemaining | string 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 subscription on a 30-day month is paused on day 20 of the subscription. There are 10 unused days on the subscription. Therefore, the subscription 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 subscription 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. |
{ "subscriptionId": "sub_01HRF27SATGE4Z6PBJE6PD8328", "pausedBy": "merchant", "description": "string", "effectiveTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "timeRemaining": "P3600S" }
200
Pause updated.
| id | string <= 50 characters ID of the subscription pause. |
| subscriptionId required | string <= 50 characters ID of the paused subscription. |
| status | string Status of the subscription pause. |
| pausedBy | string Default: "customer" Specifies who initiated the pause. |
| description | string or null <= 255 characters Description of the pause reason in free form. |
| effectiveTime | string 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 then the current time, the current time is used. If this field is omitted, this value defaults to the current time. |
| endTime | string or null <date-time> Date and time when the pause ends and the subscription resumes billing. To resume a subscription from this point in time, use the current time or an earlier time. If |
| timeRemaining | string 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 subscription on a 30-day month is paused on day 20 of the subscription. There are 10 unused days on the subscription. Therefore, the subscription 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 subscription 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. |
| createdTime | string <date-time> (CreatedTime) Date and time which is set automatically when the resource is created. |
| updatedTime | string <date-time> (UpdatedTime) Date and time which updates automatically when the resource is updated. |
Array of objects (SelfLink) Related links. |
201
Pause created.
401
Unauthorized access. Invalid credentials used.
403
Access forbidden.
422
Invalid data sent.
{ "id": "ord_pau_01H085J3ZR1WKD120D73D7N4C9", "subscriptionId": "sub_01HRF27SATGE4Z6PBJE6PD8328", "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": [ { "href": "string", "rel": "self" } ] }