Retrieve subscription order pauses

Request

Retrieves a list of subscription order pauses.

Security

SecretApiKey or JWT

Query

limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

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

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/subscription-pauses?limit=1000&offset=1000&filter=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of subscription order pauses retrieved.

Headers

Pagination-Totalinteger

Total number of items.

Example:332

Pagination-Limitinteger

Maximum number of items per page.

Example:100

Pagination-Offsetinteger

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

Bodyapplication/json

Array [

idstring, <= 50 charactersread-only

ID of the subscription pause.

Example:"sub_pau_01H085J3ZR1WKD120D73D7N4C9"

subscriptionIdstring, <= 50 charactersrequired

ID of the paused subscription.

Example:"sub_01HRF27SATGE4Z6PBJE6PD8328"

statusstringread-only

Status of the subscription pause.

Enum:"pending""ongoing""revoked""finished"

pausedBystring

Specifies who initiated the pause.

Default:"customer"

Enum:"merchant""customer"

descriptionstring or null, <= 255 characters

Description of the pause reason in free form.

effectiveTimestring or null, (date-time)

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.

endTimestring or null, (date-time)

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

timeRemainingstring or 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, and the billing anchor is ignored for that period.

For more information, see Service period anchor, billing timing, and invoice time shift.

Example:"P3600S"

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

_linksArray of objects(SelfLink)read-only

Our Solutions

Products

Features

Solutions

About