logo

Reactivate an order

Reactivates a subscription with a specified ID.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Reactivation resource.

subscriptionId
required
string <= 50 characters

ID of the reactivated subscription.

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.

Responses
201

Reactivation created. The order is now active. If the order had a related cancellation with a status of confirmed, it is revoked.

Response Headers
Location
string <uri>

Location of the related resource.

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

422

Invalid data 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",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Retrieve an order reactivation