logo

Pause a subscription

Pause a subscription.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Pause resource.

subscriptionId
required
string <= 50 characters

Identifier of the paused subscription.

pausedBy
string
Default: "customer"

Who did the pause.

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

Pause reason description.

effectiveTime
string or null <date-time>

The date from which the service period will pause. This time should be later than now, if it is earlier then current time is taken. If omitted, it will default to the current time.

endTime
string or null <date-time>

The time when the pause ends and the subscription resumes its billing. In order to resume a subscription now, use current time or past time (will default to now). Empty endTime will result in indefinitely paused subscription.

timeRemaining
string

Time period between the pause end time and the renewal time in ISO-8601 durations format. By default, it's computed as the time between the pause and the renewal. For instance, you have a $30/month subscription and 30-day month. If you pause on day 20 of the subscription, there are 10 days unused. Therefore, the subscription would renew in 10 days after resuming. The upcoming invoice would not change the amount for invoiced period, it remains $30. There may be a billing anchor for the subscription, the renewal time after a pause shift should behave as if the renewal time moved forward with Order API (the billing anchor is ignored for that period then).

Responses
201

Pause was created, the subscription will be paused at the specified time.

Response Headers
Location
string <uri>

The location of the related resource.

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

Identifier of the paused subscription.

id
string <= 50 characters

Pause identifier.

status
string

The pause status.

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

Who did the pause.

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

Pause reason description.

effectiveTime
string or null <date-time>

The date from which the service period will pause. This time should be later than now, if it is earlier then current time is taken. If omitted, it will default to the current time.

endTime
string or null <date-time>

The time when the pause ends and the subscription resumes its billing. In order to resume a subscription now, use current time or past time (will default to now). Empty endTime will result in indefinitely paused subscription.

timeRemaining
string

Time period between the pause end time and the renewal time in ISO-8601 durations format. By default, it's computed as the time between the pause and the renewal. For instance, you have a $30/month subscription and 30-day month. If you pause on day 20 of the subscription, there are 10 days unused. Therefore, the subscription would renew in 10 days after resuming. The upcoming invoice would not change the amount for invoiced period, it remains $30. There may be a billing anchor for the subscription, the renewal time after a pause shift should behave as if the renewal time moved forward with Order API (the billing anchor is ignored for that period then).

createdTime
string <date-time>

The time of resource creation (when it is posted).

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp updates when the resource is updated.

Array of objects (Self) non-empty

The links related to resource.

Array (non-empty)
href
required
string

The link URL.

rel
required
string

The link type.

Value: "self"
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/subscription-pauses
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": [
    ]
}
➔ Next to Retrieve a subscription pause