Retrieve reactivations

Retrieves a list of subscription reactivations.

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 reactivations 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 reactivated subscription.

id
string <= 50 characters

ID of the reactivation.

cancellationId
string <= 50 characters

ID of the related cancellation.

description
string <= 255 characters

Description of the reactivation reason in free form.

effectiveTime
string <date-time>

Date and time when the service period starts, unless the subscription is canceled but still active.

If the subscription is still active, the subscription continues for the current service period.

If this field is omitted, this value defaults to the current time.

renewalTime
string <date-time>

Date and time of the next subscription renewal. If this field is omitted, this value is computed from the effectiveTime field.

If the subscription is canceled but still active, it is ignored and the next renewal occurs as scheduled.

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-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
[
  • {
    }
]