/
Reactivate a subscription...

Reactivate a subscription order

Request

Reactivates a subscription order with a specified ID.

Security
SecretApiKey or JWT
Bodyapplication/jsonrequired

Reactivation resource.

subscriptionIdstring, <= 50 charactersrequired

ID of the reactivated subscription.

Example:"sub_01HRF27SATGE4Z6PBJE6PD8328"
descriptionstring or null, <= 255 characters

Description of the reactivation reason in free form.

effectiveTimestring, (date-time)write-only

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.

renewalTimestring, (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.

paymentInstrumentIdstring or null, <= 50 characterswrite-only

ID of the payment instrument. If this field is omitted, the subscription payment instrument remains unchanged.

Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/subscription-reactivations \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "subscriptionId": "sub_01HRF27SATGE4Z6PBJE6PD8328",
    "description": "string",
    "effectiveTime": "2019-08-24T14:15:22Z",
    "renewalTime": "2019-08-24T14:15:22Z",
    "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
  }'

Responses

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

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the reactivation.

Example:"sub_rct_0YVJ62AF5XCFCA6EBFAAA3Z7E0"
subscriptionIdstring, <= 50 charactersrequired

ID of the reactivated subscription.

Example:"sub_01HRF27SATGE4Z6PBJE6PD8328"
cancellationIdstring, <= 50 charactersread-only

ID of the related cancellation.

Example:"sub_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV"
descriptionstring or null, <= 255 characters

Description of the reactivation reason in free form.

renewalTimestring, (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.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

Response
{
  "id": "sub_rct_0YVJ62AF5XCFCA6EBFAAA3Z7E0",
  "subscriptionId": "sub_01HRF27SATGE4Z6PBJE6PD8328",
  "cancellationId": "sub_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV",
  "description": "string",
  "renewalTime": "2019-08-24T14:15:22Z",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}