Update a subscription pause

Updates a subscription pause.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Request Body schema: application/json
subscriptionId
required
string <= 50 characters

ID of the paused subscription.

pausedBy
string
Default: "customer"

Specifies who initiated the pause.

Enum: "merchant" "customer"
description
string or null <= 255 characters

Description of the pause reason in free form.

effectiveTime
string or null <date-time>

Date when the service period pauses.

This time should 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>

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 endTime is earlier then the current time, the current time is used. If this field is empty, the subscription is indefinitely paused.

timeRemaining
string

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.

Responses
200

Pause updated.

Response Schema: application/json
subscriptionId
required
string <= 50 characters

ID of the paused subscription.

id
string <= 50 characters

ID of the subscription pause.

status
string

Status of the subscription pause.

Enum: "pending" "ongoing" "revoked" "finished"
pausedBy
string
Default: "customer"

Specifies who initiated the pause.

Enum: "merchant" "customer"
description
string or null <= 255 characters

Description of the pause reason in free form.

effectiveTime
string or null <date-time>

Date when the service period pauses.

This time should 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>

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 endTime is earlier then the current time, the current time is used. If this field is empty, the subscription is indefinitely paused.

timeRemaining
string

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.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
201

Pause created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
subscriptionId
required
string <= 50 characters

ID of the paused subscription.

id
string <= 50 characters

ID of the subscription pause.

status
string

Status of the subscription pause.

Enum: "pending" "ongoing" "revoked" "finished"
pausedBy
string
Default: "customer"

Specifies who initiated the pause.

Enum: "merchant" "customer"
description
string or null <= 255 characters

Description of the pause reason in free form.

effectiveTime
string or null <date-time>

Date when the service period pauses.

This time should 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>

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 endTime is earlier then the current time, the current time is used. If this field is empty, the subscription is indefinitely paused.

timeRemaining
string

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.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

put/subscription-pauses/{id}
Request samples
application/json
{
  • "subscriptionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "pausedBy": "merchant",
  • "description": "string",
  • "effectiveTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "timeRemaining": "P3600S"
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "subscriptionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "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": [
    ]
}