logo

Reactivate an order

Reactivate a subscription.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Reactivation resource.

subscriptionId
required
string <= 50 characters

Identifier of the reactivated subscription.

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.

Responses
201

Reactivation was created, the order is active and won't be. deactivated. If there was a cancellation with status "confirmed", it is revoked.

Response Headers
Location
string <uri>

The location of the related resource.

Example: "https://api.rebilly.com/example"
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.

422

Invalid data was sent.

post/subscription-reactivations
Request samples
application/json
{
  • "subscriptionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "description": "string",
  • "effectiveTime": "2019-08-24T14:15:22Z",
  • "renewalTime": "2019-08-24T14:15:22Z"
}
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 an order reactivation