Retrieve order cancellation collection

Request

Retrieves a list of order cancellations.
Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]
Specifies the starting point within the collection of items to be returned.
filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/order-cancellations?limit=0&offset=0&filter=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of canceled orders retrieved.
Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger
Maximum number of items per page.
Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only
ID of the cancellation.
Example:"sub_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV"
orderIdstring, <= 50 charactersrequired
ID of the canceled order.
Example:"sub_01HRF27SATGE4Z6PBJE6PD8328"
proratedInvoiceIdstring or null, <= 50 charactersread-only
ID of the invoice on which the cancellation proration is calculated.
Example:"in_0YVF9605RKC62BP14NE2R7V2XT"
appliedInvoiceIdstring or null, <= 50 charactersread-only
ID of the invoice on which the cancellation fees or credits are applied.
Example:"in_0YVF9605RKC62BP14NE2R7V2XT"
canceledBystring
Specifies who initiated the cancellation.
Default:"customer"
Enum:"merchant""customer""rebilly"
reasonstring

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.

Default:"other"
Enum:"did-not-use""did-not-want""missing-features""bugs-or-problems""do-not-remember""risk-warning""contract-expired""too-expensive""other""billing-failure"
descriptionstring, <= 255 characters
Description of the cancellation reason in free form.
proratedboolean

Specifies if the customer gets a pro rata credit for the time remaining between churnTime and order next renewal time.

Default:false
statusstring
Status of the order cancellation.
Default:"confirmed"
Enum ValueDescription
draft
Creates a draft cancellation so that the cancellation and charge can be previewed.
confirmed

Confirms an order cancellation. Sets the order to cancel when the churnTime is reached.

completed

Marks an order cancellation as completed. This is a read-only status that is set when the churnTime is reached. The cancellation may not be changed or deleted when the status is completed.

revoked
Revokes an order cancellation.
canceledTimestring or null, (date-time)read-only

Date and time when an order is canceled. By default, this occurs when status is confirmed, unless draft is specified.

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.
churnTimestring, (date-time)

Date and time when the order is deactivated. If this field and churnTimePolicy are omitted, this value defaults to the current time.

churnTimePolicystring or null

Specifies when the order is to be deactivated. The churnTimePolicy takes precedence over the churnTime in request.

Enum:null"now""at-next-renewal"
lineItemsArray of objects
Items to be added to the new invoice. Proration item is generated and added automatically.
lineItemSubtotalobjectread-only
Subtotal of the line items added after the order cancellation.
]
Response
[ { "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": { … }, "_links": [ … ] } ]