Reason for the cancellation.
The sandbox-retention value is set only in the sandbox environment when a recurring order is canceled 90 days after creation. If a request includes it, a validation error is returned.
Reason for the cancellation.
The sandbox-retention value is set only in the sandbox environment when a recurring order is canceled 90 days after creation. If a request includes it, a validation error is returned.
Specifies if the customer gets a pro rata credit for the time remaining between churnTime and order next renewal time.
| Enum Value | Description |
|---|---|
| draft | |
| confirmed | Confirms an order cancellation. Sets the order to cancel when the |
| completed | Marks an order cancellation as completed. This is a read-only status that is set when the |
| revoked |
Date and time when the order is deactivated. If this field and churnTimePolicy are omitted, this value defaults to the current time.
Specifies when the order is to be deactivated. The churnTimePolicy takes precedence over the churnTime in request.
curl -i -X POST \
https://www.rebilly.com/_mock/catalog/all/order-cancellations \
-H 'Content-Type: application/json' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE' \
-d '{
"orderId": "sub_01HRF27SATGE4Z6PBJE6PD8328",
"canceledBy": "merchant",
"reason": "did-not-use",
"description": "string",
"prorated": false,
"status": "draft",
"churnTime": "2019-08-24T14:15:22Z",
"churnTimePolicy": null,
"lineItems": [
{
"type": "debit",
"description": "string",
"unitPriceAmount": 49.95,
"unitPriceCurrency": "USD",
"quantity": 1,
"periodStartTime": "2019-08-24T14:15:22Z",
"periodEndTime": "2019-08-24T14:15:22Z"
}
]
}'Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.
Number of requests still available for this rate limit. For more information, see Rate limits.
Reason for the cancellation.
The sandbox-retention value is set only in the sandbox environment when a recurring order is canceled 90 days after creation. If a request includes it, a validation error is returned.
Specifies if the customer gets a pro rata credit for the time remaining between churnTime and order next renewal time.
| Enum Value | Description |
|---|---|
| draft | |
| confirmed | Confirms an order cancellation. Sets the order to cancel when the |
| completed | Marks an order cancellation as completed. This is a read-only status that is set when the |
| revoked |
Date and time when an order is canceled. By default, this occurs when status is confirmed, unless draft is specified.
Date and time when the order is deactivated. If this field and churnTimePolicy are omitted, this value defaults to the current time.
Specifies when the order is to be deactivated. The churnTimePolicy takes precedence over the churnTime in request.
{ "id": "sub_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV", "orderId": "sub_01HRF27SATGE4Z6PBJE6PD8328", "proratedInvoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT", "appliedInvoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT", "canceledBy": "merchant", "reason": "did-not-use", "description": "string", "prorated": false, "status": "draft", "canceledTime": "2019-08-24T14:15:22Z", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "churnTime": "2019-08-24T14:15:22Z", "churnTimePolicy": null, "lineItems": [ { … } ], "lineItemSubtotal": { "amount": 49.95, "currency": "USD" }, "_links": [ { … } ] }