Retrieve a list of reactivations

Retrieve a list of reactivations for all subscriptions.

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

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

Responses
200

A list of reactivations was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

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

Identifier of the reactivated subscription.

id
string <= 50 characters

Reactivation identifier.

cancellationId
string <= 50 characters

Identifier of the related cancellation.

description
string <= 255 characters

Reactivation reason description in free form.

effectiveTime
string <date-time>

The date from which the service period would start, unless the subscription is canceled but still active. In case the subscription is still active, the subscription will continue the current service period. If omitted, it will default to the current time.

renewalTime
string <date-time>

The time of the next subscription renewal. If omitted then it is computed from the effective time. If the subscription is canceled but active it is ignored, so the next renewal will happen as scheduled.

createdTime
string <date-time>

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

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.

get/subscription-reactivations
Request samples
// all parameters are optional
const firstCollection = await api.subscriptionReactivations.getAll();

// alternatively you can specify one or more of them
const params = {limit: 20, offset: 100, sort: '-createdTime'};
const secondCollection = await api.subscriptionReactivations.getAll(params);

// access the collection items, each item is a Member
secondCollection.items.forEach(subscription => console.log(subscription.fields.customerId));
Response samples
application/json
[
  • {
    }
]