# Pause a subscription order

Pauses a subscription order with a specified ID.

Endpoint: POST /subscription-pauses
Version: latest
Security: SecretApiKey, JWT

## Request fields (application/json):

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

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

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

  - `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.

  - `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.

  - `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"

## Response 201 fields (application/json):

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

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

  - `status` (string)
    Status of the subscription pause.
    Enum: "pending", "ongoing", "revoked", "finished"

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

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

  - `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.

  - `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.

  - `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"

  - `createdTime` (string)
    Date and time which is set automatically when the resource is created.

  - `updatedTime` (string)
    Date and time which updates automatically when the resource is updated.

  - `_links` (array)
    Related links.

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

  - `_links.rel` (string)
    Type of link.
    Enum: "self"

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 422 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

  - `invalidFields` (array)
    Invalid field details.
    Example: [{"field":"field1","message":"field1 is invalid"},{"field":"subObject.field2","message":"field2 is invalid"},{"field":"subObject.field2","message":"another error in the field2"}]

  - `invalidFields.field` (string)
    Name of the field.
Dot notation is used for nested object field names.

  - `invalidFields.message` (string)
    Message field.

## Response 429 fields (application/json):

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".
    Example: "about:blank"

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
    Example: "Rate Limit Exceeded"

  - `status` (integer)
    HTTP status code.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.
    Example: "A request cannot be executed because the user has sent too many requests within a certain period of time"

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.