Get a specific order from the Order Service.
Retrieved Order
The ID for this resource
The type of the resource
The date and time the resource was created
The date and time the resource was last updated
The currency to price the order in. The currency code should be provided in the 3 letter (ISO 4217 standard)[https://www.iso.org/iso-4217-currency-codes.html].
The price of all the line items on an order, calculated by the pricing calculator, before discounts are applied, in the currency's minor units e.g. pence or cents.
The subtotal formatted using the currencyCode.
The discount applied to the subtotal, in the currency's minor units e.g. pence or cents.
The subtotalDiscount formatted using the currencyCode.
The subtotal, after discounts have been applied, in the currency's minor units e.g. pence or cents.
The subtotalPrice formatted using the currencyCode.
The fee for delivering the order, before discounts are applied, in the currency's minor units e.g. pence or cents.
The delivery formatted using the currencyCode.
The discount applied to the delivery, in the currency's minor units e.g. pence or cents.
The deliveryDiscount formatted using the currencyCode.
The deliveryPrice, after discounts have been applied, in the currency's minor units e.g. pence or cents.
The deliveryPrice formatted using the currencyCode.
The gross total of the order, subtotal + deliveryPrice, before discounts are applied, in the currency's minor units e.g. pence or cents.
The grossTotal formatted using the currencyCode.
The total discount applied to the order, subtotalDiscount + deliveryDiscount, in the currency's minor units e.g. pence or cents.
The totalDiscount formatted using the currencyCode.
The total price of the order including discounts, grossTotal - totalDiscount, in the currency's minor units e.g. pence or cents.
The totalPrice formatted using the currencyCode.
Delivery information for the order.
Date the order is to be shipped.
Information about the order's customer.
The ID for this resource
The type of the resource
Discounts applied to the order.
Discount code applied to the order (maximum one per order).
The status of the order. PENDING: not yet successfully billed. COMMITTED: Successfully billed. CANCELLED: Removed from customers' order list. Note that an order with billing status REFUNDED would still be considered COMMITTED, while an order with billing status FAILED would remain PENDING.
The billing status of the order.
PENDING: Not yet attempted billing.IN PROGRESS: Currently attempting billing.DELEGATED: Billing happened through a process external to Bento, e.g. during signup.SUCCEEDED: Billing occurred successfully.FAILED: Billing attempt failed, e.g. due to incorrect card details.REFUNDED: The order was billed, but later refunded for the full amount.PARTIALLY REFUNDED: Order was billed for the full amount, but refunded for less than the full amount.AUTOFILLING: The order is currently being autofilled.CANCELLED: The order is cancelled.IN RETRY: The order will automatically retry following a retryable failure to bill.
The price that was billed, in the currency's minor units, e.g. pence or cents.
The billedPrice formatted using the pricing.currencyCode.
The amount of monetary credit used when the order was billed, in the currency's minor units, e.g. pence or cents.
The monetaryCreditUsed formatted using the pricing.currencyCode.
Line items associated with the order.
The ID for this resource
The type of the resource
Quantity of the product in the order.
Additional information about the product.
Whether the product is a gift.
The source of why the item is in the order e.g. set by the contract, added by an admin.
The contract associated with the order.
The ID for this resource
The type of the resource
The identifier for the phase that order is in within the subscription contract. This is currently optional due to V2 contracts not containing the concept of phases.
The contract type associated with the order.
The ID for this resource
The type of the resource
The count of all COMMITTED and PENDING orders associated with the linked subscription up to and including this order.
The number of the order in the linked subscription contract, the first order of the subscription would have number 1. Useful for custom tracking of orders e.g. playlists.
The transactions associated with the order.
Represents when an order will no longer be editable and the configured cutoff flow will begin.
Additional information about the order.
Additional information about the resource.
Unauthorized
Details of problems encountered processing the request.
Details of a problem encountered processing the request.
The HTTP status code applicable to the problem
A short-human readable description of the problem, this should not change from occurrence to occurrence.
A human-readable explanation specific to this occurrence of the problem.
The source of the error.
A pointer to the request field related to the problem.
A parameter related to the problem.
A header related to the problem.
Additional metadata about the error.
Forbidden
Details of problems encountered processing the request.
Details of a problem encountered processing the request.
The HTTP status code applicable to the problem
A short-human readable description of the problem, this should not change from occurrence to occurrence.
A human-readable explanation specific to this occurrence of the problem.
The source of the error.
A pointer to the request field related to the problem.
A parameter related to the problem.
A header related to the problem.
Additional metadata about the error.
Not Found
Details of problems encountered processing the request.
Details of a problem encountered processing the request.
The HTTP status code applicable to the problem
A short-human readable description of the problem, this should not change from occurrence to occurrence.
A human-readable explanation specific to this occurrence of the problem.
The source of the error.
A pointer to the request field related to the problem.
A parameter related to the problem.
A header related to the problem.
Additional metadata about the error.
Too Many Requests
Details of problems encountered processing the request.
Details of a problem encountered processing the request.
The HTTP status code applicable to the problem
A short-human readable description of the problem, this should not change from occurrence to occurrence.
A human-readable explanation specific to this occurrence of the problem.
The source of the error.
A pointer to the request field related to the problem.
A parameter related to the problem.
A header related to the problem.
Additional metadata about the error.
Internal Server Error
Details of problems encountered processing the request.
Details of a problem encountered processing the request.
The HTTP status code applicable to the problem
A short-human readable description of the problem, this should not change from occurrence to occurrence.
A human-readable explanation specific to this occurrence of the problem.
The source of the error.
A pointer to the request field related to the problem.
A parameter related to the problem.
A header related to the problem.
Additional metadata about the error.
Service Unavailable
Details of problems encountered processing the request.
Details of a problem encountered processing the request.
The HTTP status code applicable to the problem
A short-human readable description of the problem, this should not change from occurrence to occurrence.
A human-readable explanation specific to this occurrence of the problem.
The source of the error.
A pointer to the request field related to the problem.
A parameter related to the problem.
A header related to the problem.
Additional metadata about the error.