v7

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-121372601.5 MB
Return Envelopes

Cancel Return Envelope Order

Cancels the return envelope order by orderID for the return envelope by id. Note that this operation cannot be undone.

delete/print-mail/v1/return_envelopes/{id}/orders/{orderID}

Path parameters

idstring required

The ID of the return envelope.

orderIDstring required

The ID of the return envelope order to cancel.

Query parameters

expand[]string[]

Pass expand[]=returnEnvelope to expand the order's returnEnvelope field into the full return envelope object.

Response

The cancelled return envelope order.

idstring required

A unique ID prefixed with return_envelope_order_

descriptionstring

An optional string describing this resource. Will be visible in the API and the dashboard.

metadataobject

See the section on Metadata.

liveboolean required

true if this is a live mode resource else false.

createdAtstring date-time required

The UTC time at which this resource was created.

updatedAtstring date-time required

The UTC time at which this resource was last updated.