logo

Retrieve an order reactivation

Retrieve an order reactivation with specified identifier string.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Responses
200

Reactivation was retrieved successfully.

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

404

Resource was not found.

get/subscription-reactivations/{id}
Request samples
const subscription = await api.subscriptionReactivations.get({id: 'foobar-001'});
console.log(subscription.fields.description);
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "subscriptionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "cancellationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "description": "string",
  • "effectiveTime": "2019-08-24T14:15:22Z",
  • "renewalTime": "2019-08-24T14:15:22Z",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Retrieve subscription order's upcoming invoice