# Subscription order resumed

Endpoint: POST subscription-resumed
Version: latest
Security: SecretApiKey, JWT

## Request fields (application/json):

  - `subscriptionId` (string)
    ID of the order.
    Example: "sub_01HRF27SATGE4Z6PBJE6PD8328"

  - `subscriptionPauseId` (string)
    ID of the subscription pause.
    Example: "sub_pau_01H085J3ZR1WKD120D73D7N4C9"

  - `eventType` (string)
    Type of webhook event.
    Enum: "subscription-pause-created", "subscription-pause-modified", "subscription-pause-revoked", "subscription-paused", "subscription-resumed"

  - `_embedded` (object)
    Embedded objects.

  - `_embedded.subscription` (any)

  - `_embedded.pause` (object)
    Subscription pause details.

  - `_embedded.pause.subscriptionId` (string, required)
    ID of the paused subscription.
    Example: "sub_01HRF27SATGE4Z6PBJE6PD8328"

  - `_embedded.pause.pausedBy` (string)
    Specifies who initiated the pause.
    Enum: "merchant", "customer"

  - `_embedded.pause.description` (string,null)
    Description of the pause reason in free form.

  - `_embedded.pause.effectiveTime` (string,null)
    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.

  - `_embedded.pause.endTime` (string,null)
    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  is earlier then the current time, the current time is used.
If this field is empty, the subscription is indefinitely paused.

  - `_embedded.pause.timeRemaining` (string,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](https://www.rebilly.com/catalog/all/orders),
and the billing anchor is ignored for that period.

For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift).
    Example: "P3600S"

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "subscription", "pause"