Retrieve subscription pauses

Retrieves a list of subscription pauses.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

Responses
200

List of pauses retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
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.

get/subscription-pauses
Request samples
Response samples
application/json
[
  • {
    }
]