> For the complete documentation index, see [llms.txt](https://docs.chord.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.chord.co/chord-oms/api-reference/checkouts.md).

# Checkouts

## Update checkout

> Updates a checkout.\
> \
> \*\*Note:\*\* In addition to the order update, this action always attempts to perform an order state machine transition which results in a \`422\` response if it cannot be transitioned.

```json
{"openapi":"3.0.0","info":{"title":"OMS API","version":"1.1"},"tags":[{"name":"Checkouts"}],"servers":[{"url":"https://{host}/api","description":"Chord OMS instance","variables":{"host":{"default":"plant-staging.assembly-api.com","description":"Your tenant host, as configured in Chord OMS. The default is a Chord staging sandbox: replace it with your own host before making real requests."}}}],"security":[{"api-key":[]},{"order-token":[]}],"components":{"securitySchemes":{"api-key":{"type":"http","scheme":"bearer","description":"This is an admin level API token used for priviliged storefront\noperations. This should never be used in public contexts.\n"},"order-token":{"type":"apiKey","name":"X-Spree-Order-Token","in":"header","description":"This is a token that is assoicated with an order that allows operations\non that order. It is to be used as a means of authentication for guest\ncheckout sessions.\n"}},"schemas":{"checkout-input":{"type":"object","title":"Checkout input","properties":{"coupon_code":{"type":"string"},"email":{"type":"string"},"referral_identifier":{"type":"string"},"special_instructions":{"type":"string"},"channel":{"type":"string"},"use_billing":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/metadata"},"bill_address_attributes":{"$ref":"#/components/schemas/address-input"},"ship_address_attributes":{"$ref":"#/components/schemas/address-input"},"payments_attributes":{"type":"array","items":{"$ref":"#/components/schemas/payment-input"}},"shipments_attributes":{"type":"array","items":{"$ref":"#/components/schemas/shipment-input"}}}},"metadata":{"type":"object","nullable":true,"additionalProperties":true,"properties":{},"title":"Metadata","description":"A key-value store of additional information. A key can be removed by\nsetting its value to null.\n"},"address-input":{"type":"object","title":"Address Input","required":["address1","city"],"properties":{"name":{"type":"string","description":"The full name of the user. You must provide this field OR one of OR both of `firstname` and `lastname` for\nthe payload to be valid.\n\nThis field will override `firstname` and `lastname` if both are provided.\n"},"firstname":{"type":"string","description":"The first name of the user. This field will be ignored if `name` is provided.\n"},"lastname":{"type":"string","description":"The last name of the user. This field will be ignored if `name` is provided.\n"},"address1":{"type":"string"},"address2":{"type":"string","nullable":true},"city":{"type":"string"},"state_name":{"type":"string","description":"Either the name of the state (\"New York\") or it's abbreviation (\"NY\").\n\nThis field (or `state_id`) is required if [`/api/countries/{country_id}/states`](#/paths/list-country-states)\nreturns `\"states_required\": true` in it's body.\n"},"state_id":{"type":"integer","description":"This ID can be found by calling [`/api/countries/{country_id}/states`](#/paths/list-country-states).\n\nThis field (or `state_name`) is required if the above endpoint returns `\"states_required\": true`.\n"},"country_id":{"type":"integer","description":"This ID can be found by calling [`/api/countries`](#/paths/list-countries). Either `country_id` OR `country_iso`\nmust be provided for this payload to be valid.\n"},"country_iso":{"type":"string","description":"The [ISO 3166-1 Alpha-2 country code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) that the\nuser resides in. This list can be fetched from [`/api/countries`](#/paths/list-countries), where the key is\n`iso`.\n\nThis field OR `country_id` must be provided for this payload to be valid.\n"},"zipcode":{"type":"string","nullable":true,"description":"This field is required if the country requires a ZIP code, like the United States (`233`).\n"},"phone":{"type":"string","nullable":true},"alternative_phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true}}},"payment-input":{"type":"object","title":"Payment input","properties":{"amount":{"type":"string"},"payment_method_id":{"type":"integer"},"payment_method":{"type":"string"},"source_attributes":{"type":"object","properties":{"number":{"type":"string"},"month":{"type":"integer"},"year":{"type":"integer"},"verification_value":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"cc_type":{"type":"string"},"gateway_customer_profile_id":{"type":"string"},"gateway_payment_profile_id":{"type":"string"},"last_digits":{"type":"string"},"name":{"type":"string"},"encrypted_data":{"type":"string"},"existing_card_id":{"type":"integer"},"wallet_payment_source_id":{"type":"integer"},"address_attributes":{"$ref":"#/components/schemas/address-input"}}}}},"shipment-input":{"type":"object","title":"Shipment input","properties":{"cost":{"type":"number"},"id":{"type":"integer"},"inventory_units":{"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"integer"}}}},"selected_shipping_rate_id":{"type":"integer"},"shipped_at":{"type":"string"},"special_instructions":{"type":"string"},"stock_location_id":{"type":"integer"},"tracking":{"type":"string"}}},"square-braintree-checkout-input":{"type":"object","title":"Square/Braintree checkout input","properties":{"payments_attributes":{"type":"array","items":{"type":"object","properties":{"payment_method_type":{"type":"string"},"source_attributes":{"type":"object","properties":{"nonce":{"type":"string"},"payment_type":{"type":"string"}}}}}}}},"OrderBig":{"title":"Order (big)","allOf":[{"$ref":"#/components/schemas/OrderSmall"},{"type":"object","properties":{"checkout_session_id":{"type":"string","nullable":true},"store":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"code":{"type":"string"}}},"pre_paid_subscription_installment":{"type":"boolean"},"subscription_in_cart":{"type":"boolean"},"tag_list":{"type":"array","items":{"type":"string"}},"gift_note":{"$ref":"#/components/schemas/gift_note"}}}]},"OrderSmall":{"type":"object","title":"Order (small)","required":["id","number","token","user_id","email","currency","locale","total","display_total","item_total","display_item_total","payment_total","adjustment_total","ship_total","display_ship_total","tax_total","additional_tax_total","display_additional_tax_total","included_tax_total","display_included_tax_total","checkout_steps","created_at","updated_at","completed_at"],"properties":{"id":{"type":"integer"},"number":{"type":"string"},"token":{"type":"string","description":"This token can be used as a means of authentication for a subset\nof order operations in a guest checkout scenario. It should be passed\nas header named `X-Spree-Order-Token` on the request.\n"},"user_id":{"type":"integer","nullable":true,"description":"The ID of the user associated with this order. If the order is not in a completed\nstate and the customer is not logged in, this will be `null`.\n"},"email":{"type":"string","format":"email","nullable":true},"currency":{"type":"string","description":"The [ISO 4217 currency code](https://taxsummaries.pwc.com/glossary/currency-codes)\nfor the order.\n"},"locale":{"type":"string","nullable":true},"total":{"type":"string","format":"float","description":"This is the total amount of money that the customer paid/will pay.\nIt is the `item_total` + `shipment_total` + `adjustment_total`.\n"},"display_total":{"type":"string","description":"The formatted `total` with the currency's symbol.\n"},"item_total":{"type":"string","format":"float","description":"The total cost of the items in the cart. This does not include discounts,\nadjustments or shipping.\n"},"display_item_total":{"type":"string","format":"string","description":"The formatted `item_total` with the order's currency symbol.\n"},"payment_total":{"type":"string","format":"float","description":"TBD"},"adjustment_total":{"type":"string","format":"float","description":"The total amount discounted from the order.\n"},"ship_total":{"type":"string","format":"float","description":"The amount of money that the customer paid in shipping costs. For some of\nChord's payment methods, like Stripe, this amount in not known until after\nthe order is completed, as the address input is outside of Chord's systems.\n"},"display_ship_total":{"type":"string","description":"The formatted `ship_total` with the order's currency symbol.\n"},"tax_total":{"type":"string","format":"float","description":"The amount of money the the customer paid in taxes. For some of Chord's\npayment methods, like Stripe, this amount is not known until after the\norder is completed, as the address input is outside of Chord's systems.\n"},"display_tax_total":{"type":"string","description":"The `tax_total` formatted with the order's currency symbol.\n"},"additional_tax_total":{"type":"string","format":"float","description":"If the order requires VAT (Value Added Tax), this is the amount of tax the\ncustomer will pay.\n"},"display_additional_tax_total":{"type":"string","description":"The formatted `additional_tax_total` with the order's currency symbol.\n"},"included_tax_total":{"type":"string","format":"float","description":"The total amount of additional tax applied to the order outside of the normal\nsales tax applied.\n"},"display_included_tax_total":{"type":"string","description":"The formatted `included_tax_total` with the order's currency symbol.\n"},"covered_by_store_credit":{"type":"boolean","description":"This is `true` if the user's available store credit is greater than\nor equal to the order's total.\n"},"total_applicable_store_credit":{"description":"How much store credit will be subtracted by this order's total.\n\nThis will be an integer 0 when there is not any store credit\navailable, otherwise, it will be a string float.\n","oneOf":[{"type":"string","format":"float"},{"type":"integer","enum":[0]}]},"display_total_applicable_store_credit":{"type":"string","description":"The `total_applicable_store_credit` formatted with the order's currency sign.\n"},"order_total_after_store_credit":{"type":"string","format":"float","description":"The order total after any and all `total_applicable_store_credit` is subtracted\nfrom the `total`.\n"},"display_order_total_after_store_credit":{"type":"string","description":"The `order_total_after_store_credit` formatted with the order's currecny sign.\n"},"display_total_available_store_credit":{"type":"string","description":"The total amount of store credit associated with the customer's account formatted\nwith the order's currency symbol.\n"},"display_store_credit_remaining_after_capture":{"type":"string","description":"The total amount of store credit after the payment has been captured formatted\nwith the order's currency symbol.\n"},"checkout_steps":{"type":"array","items":{"type":"string"},"description":"The steps the customer must finish in order to complete the order.\n\n**This field is deprecated and will be removed at some point in the future\nas it doesn't mean anything in Chord's 1 step checkout based flows.**\n"},"canceler_id":{"type":"integer","nullable":true,"description":"The ID of the user that canceled the order, if it has been canceled.\n"},"channel":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time","nullable":true},"payment_state":{"type":"string"},"shipment_state":{"type":"string","nullable":true},"hold_until":{"type":"string","format":"date-time"},"warehouse_sku":{"type":"string"},"special_instructions":{"type":"string","nullable":true},"state":{"type":"string"},"total_quantity":{"type":"integer","description":"The total number of items in the order."},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/line-item"}},"metadata":{"$ref":"#/components/schemas/OrderMetadata"},"cross_sell_details":{"$ref":"#/components/schemas/CrossSellDetails"}}},"line-item":{"type":"object","title":"Line item","required":["adjustments"],"properties":{"id":{"type":"integer"},"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/adjustment"}},"is_bundle":{"type":"boolean"},"subscription_type":{"type":"string"},"parts":{"type":"array","items":{"$ref":"#/components/schemas/part"}},"total":{"type":"string"},"display_amount":{"type":"string"},"price":{"type":"string","format":"float"},"single_display_amount":{"type":"string"},"quantity":{"type":"integer"},"variant":{"$ref":"#/components/schemas/variant"},"variant_id":{"type":"integer"},"metadata":{"$ref":"#/components/schemas/metadata"},"cross_sold":{"type":"integer"},"dynamic_promotions":{"type":"array","items":{"$ref":"#/components/schemas/dynamic_promotion"}},"gift_cards":{"type":"array","items":{"$ref":"#/components/schemas/gift_card"}},"pre_paid_subscription":{"$ref":"#/components/schemas/PrepaidSubscriptionResponse"},"digital_purchases":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"redeemed":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/metadata"}}}}}},"adjustment":{"type":"object","properties":{"adjustable_id":{"type":"integer"},"adjustable_type":{"type":"string"},"amount":{"type":"string"},"created_at":{"type":"string"},"display_amount":{"type":"string"},"eligible":{"type":"boolean"},"finalized":{"type":"boolean"},"id":{"type":"integer"},"label":{"type":"string"},"promotion_code_id":{"type":"integer"},"source_id":{"type":"integer"},"source_type":{"type":"string"},"updated_at":{"type":"string"},"promotion_code":{"properties":{"id":{"type":"integer"},"value":{"type":"string"}}}},"title":"Adjustment"},"part":{"type":"object","title":"Part within a parts array","properties":{"sku":{"type":"string","description":"SKU of the variant in the bundle"},"quantity":{"type":"integer","description":"The quantity of variant in this bundle"},"price":{"type":"number","format":"float","description":"The price of the variant in this bundle"}}},"variant":{"type":"object","title":"Variant","properties":{"cost_price":{"type":"string"},"depth":{"type":"string"},"description":{"type":"string"},"display_price":{"type":"string"},"height":{"type":"string"},"id":{"type":"integer"},"images":{"type":"array","items":{"$ref":"#/components/schemas/image"}},"in_stock":{"type":"boolean"},"is_backorderable":{"type":"boolean"},"is_destroyed":{"type":"boolean"},"is_master":{"type":"boolean"},"name":{"type":"string"},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/option-value"}},"options_text":{"type":"string"},"price":{"type":"string"},"sku":{"type":"string"},"slug":{"type":"string"},"total_on_hand":{"type":"integer"},"track_inventory":{"type":"boolean"},"weight":{"type":"string"},"width":{"type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"image":{"type":"object","properties":{"alt":{"type":"string"},"attachment_content_type":{"type":"string"},"attachment_file_name":{"type":"string"},"attachment_height":{"type":"integer"},"attachment_updated_at":{"type":"string"},"attachment_width":{"type":"integer"},"id":{"type":"integer"},"large_url":{"type":"string"},"mini_url":{"type":"string"},"position":{"type":"integer"},"product_url":{"type":"string"},"small_url":{"type":"string"},"type":{"type":"string"},"viewable_id":{"type":"integer"},"viewable_type":{"type":"string"}},"title":"Image"},"option-value":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"option_type_id":{"type":"integer"},"option_type_name":{"type":"string"},"option_type_presentation":{"type":"string"},"presentation":{"type":"string"}},"title":"Option value"},"dynamic_promotion":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}},"gift_card":{"type":"object","properties":{"id":{"type":"integer"},"filled":{"type":"boolean"},"amount":{"type":"string"},"recipient_email":{"type":"string"},"recipient_name":{"type":"string"},"gift_message":{"type":"string"},"send_email_at":{"type":"string"},"purchaser_name":{"type":"string"},"auto_redeem":{"type":"boolean"},"redemption_code":{"type":"string"}}},"PrepaidSubscriptionResponse":{"type":"object","required":["id","subscription_id","virtual_gift_card_id","actionable_date","auto_redeem","gift","recurring","amount","single_installment_price","state","quantity","installment_count","interval_length","interval_units","line_items","recipient","virtual_gift_card"],"properties":{"id":{"type":"integer"},"subscription_id":{"type":"integer","nullable":true},"virtual_gift_card_id":{"type":"integer","nullable":true},"actionable_date":{"type":"string","format":"date-time"},"auto_redeem":{"type":"boolean"},"gift":{"type":"boolean"},"recurring":{"type":"boolean"},"amount":{"type":"string","format":"float","description":"Total amount that the customer paid upfront for this subsciption.\n"},"single_installment_price":{"type":"string","format":"float","description":"The amount of money the customer paid for a single installment upfront.\n"},"state":{"type":"string","enum":["pending","active","completed"]},"quantity":{"type":"integer","minimum":1,"description":"The number of items that will be in the shipment.\n"},"installment_count":{"type":"number","description":"The number of times that the subsciption should be fulfilled.\n"},"fulfilled_installment_count":{"type":"number","description":"The number of times that the subsciption has been fulfilled within\na billing period.\n"},"interval_length":{"$ref":"#/components/schemas/IntervalLength"},"interval_units":{"$ref":"#/components/schemas/IntervalUnit"},"line_items":{"type":"array","items":{"type":"object","required":["quantity","variant"],"properties":{"quantity":{"type":"integer"},"variant":{"$ref":"#/components/schemas/variant"}}}},"recipient":{"type":"object","required":["name","email","address"],"properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"},"address":{"$ref":"#/components/schemas/address"}}},"virtual_gift_card":{"$ref":"#/components/schemas/gift_card"}}},"IntervalLength":{"type":"number","minimum":1,"description":"How many times a subscription should be fulfilled for a given\ninterval unit. Here are some examples.\n\n- Length = 1 and unit = `month` == once a month\n- Length = 2 and unit = `week` == every two weeks\n- Length = 1 and unit = `year` == once a year\n"},"IntervalUnit":{"type":"string","enum":["day","week","month","year"],"description":"The measurement of time applied to the interval unit of how often a\nsubscription is fulfilled.\n"},"address":{"type":"object","title":"Address","properties":{"id":{"type":"integer"},"name":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string","nullable":true},"city":{"type":"string"},"zipcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"alternative_phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"country_id":{"type":"integer"},"country_iso":{"type":"string"},"phone":{"type":"string","nullable":true},"state":{"$ref":"#/components/schemas/state"},"state_id":{"type":"integer"},"state_name":{"type":"string"},"state_text":{"type":"string"}}},"country":{"type":"object","properties":{"id":{"type":"integer"},"iso":{"type":"string"},"iso3":{"type":"string"},"iso_name":{"type":"string"},"name":{"type":"string"},"numcode":{"type":"integer"}},"title":"Country"},"state":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"abbr":{"type":"string"},"country_id":{"type":"integer"}},"title":"State"},"OrderMetadata":{"type":"object","nullable":true,"additionalProperties":true,"properties":{},"title":"Metadata","description":"A key-value store of additional information. A key can be removed by\nsetting its value to null.\n"},"CrossSellDetails":{"type":"object","properties":{"cross_sellable":{"type":"boolean"},"cross_sell_duration_in_minutes":{"type":"integer"},"cross_sell_ends_at":{"type":"string","format":"date-time"}}},"gift_note":{"type":"object","title":"Gift Note","nullable":true,"description":"An optional note to attach to the order. For some fulfillment services,\nthis note might be printed and packaged with the order.\n","properties":{"from":{"type":"string"},"recipient":{"type":"string"},"note":{"type":"string"}}}},"responses":{"invalid-api-key":{"description":"Invalid API Key provided","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"not-found":{"description":"Resource is not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"unprocessable-entity":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"errors":{"type":"object"}}}}}}}},"paths":{"/checkouts/{id}":{"patch":{"summary":"Update checkout","description":"Updates a checkout.\n\n**Note:** In addition to the order update, this action always attempts to perform an order state machine transition which results in a `422` response if it cannot be transitioned.","operationId":"update-checkout","tags":["Checkouts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/checkout-input"},{"$ref":"#/components/schemas/square-braintree-checkout-input"}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderBig"}}}},"401":{"$ref":"#/components/responses/invalid-api-key"},"404":{"$ref":"#/components/responses/not-found"},"422":{"$ref":"#/components/responses/unprocessable-entity"}}}}}}
```

## Advance checkout

> Advances a checkout to the furthest possible state.

```json
{"openapi":"3.0.0","info":{"title":"OMS API","version":"1.1"},"tags":[{"name":"Checkouts"}],"servers":[{"url":"https://{host}/api","description":"Chord OMS instance","variables":{"host":{"default":"plant-staging.assembly-api.com","description":"Your tenant host, as configured in Chord OMS. The default is a Chord staging sandbox: replace it with your own host before making real requests."}}}],"security":[{"api-key":[]},{"order-token":[]}],"components":{"securitySchemes":{"api-key":{"type":"http","scheme":"bearer","description":"This is an admin level API token used for priviliged storefront\noperations. This should never be used in public contexts.\n"},"order-token":{"type":"apiKey","name":"X-Spree-Order-Token","in":"header","description":"This is a token that is assoicated with an order that allows operations\non that order. It is to be used as a means of authentication for guest\ncheckout sessions.\n"}},"schemas":{"OrderBig":{"title":"Order (big)","allOf":[{"$ref":"#/components/schemas/OrderSmall"},{"type":"object","properties":{"checkout_session_id":{"type":"string","nullable":true},"store":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"code":{"type":"string"}}},"pre_paid_subscription_installment":{"type":"boolean"},"subscription_in_cart":{"type":"boolean"},"tag_list":{"type":"array","items":{"type":"string"}},"gift_note":{"$ref":"#/components/schemas/gift_note"}}}]},"OrderSmall":{"type":"object","title":"Order (small)","required":["id","number","token","user_id","email","currency","locale","total","display_total","item_total","display_item_total","payment_total","adjustment_total","ship_total","display_ship_total","tax_total","additional_tax_total","display_additional_tax_total","included_tax_total","display_included_tax_total","checkout_steps","created_at","updated_at","completed_at"],"properties":{"id":{"type":"integer"},"number":{"type":"string"},"token":{"type":"string","description":"This token can be used as a means of authentication for a subset\nof order operations in a guest checkout scenario. It should be passed\nas header named `X-Spree-Order-Token` on the request.\n"},"user_id":{"type":"integer","nullable":true,"description":"The ID of the user associated with this order. If the order is not in a completed\nstate and the customer is not logged in, this will be `null`.\n"},"email":{"type":"string","format":"email","nullable":true},"currency":{"type":"string","description":"The [ISO 4217 currency code](https://taxsummaries.pwc.com/glossary/currency-codes)\nfor the order.\n"},"locale":{"type":"string","nullable":true},"total":{"type":"string","format":"float","description":"This is the total amount of money that the customer paid/will pay.\nIt is the `item_total` + `shipment_total` + `adjustment_total`.\n"},"display_total":{"type":"string","description":"The formatted `total` with the currency's symbol.\n"},"item_total":{"type":"string","format":"float","description":"The total cost of the items in the cart. This does not include discounts,\nadjustments or shipping.\n"},"display_item_total":{"type":"string","format":"string","description":"The formatted `item_total` with the order's currency symbol.\n"},"payment_total":{"type":"string","format":"float","description":"TBD"},"adjustment_total":{"type":"string","format":"float","description":"The total amount discounted from the order.\n"},"ship_total":{"type":"string","format":"float","description":"The amount of money that the customer paid in shipping costs. For some of\nChord's payment methods, like Stripe, this amount in not known until after\nthe order is completed, as the address input is outside of Chord's systems.\n"},"display_ship_total":{"type":"string","description":"The formatted `ship_total` with the order's currency symbol.\n"},"tax_total":{"type":"string","format":"float","description":"The amount of money the the customer paid in taxes. For some of Chord's\npayment methods, like Stripe, this amount is not known until after the\norder is completed, as the address input is outside of Chord's systems.\n"},"display_tax_total":{"type":"string","description":"The `tax_total` formatted with the order's currency symbol.\n"},"additional_tax_total":{"type":"string","format":"float","description":"If the order requires VAT (Value Added Tax), this is the amount of tax the\ncustomer will pay.\n"},"display_additional_tax_total":{"type":"string","description":"The formatted `additional_tax_total` with the order's currency symbol.\n"},"included_tax_total":{"type":"string","format":"float","description":"The total amount of additional tax applied to the order outside of the normal\nsales tax applied.\n"},"display_included_tax_total":{"type":"string","description":"The formatted `included_tax_total` with the order's currency symbol.\n"},"covered_by_store_credit":{"type":"boolean","description":"This is `true` if the user's available store credit is greater than\nor equal to the order's total.\n"},"total_applicable_store_credit":{"description":"How much store credit will be subtracted by this order's total.\n\nThis will be an integer 0 when there is not any store credit\navailable, otherwise, it will be a string float.\n","oneOf":[{"type":"string","format":"float"},{"type":"integer","enum":[0]}]},"display_total_applicable_store_credit":{"type":"string","description":"The `total_applicable_store_credit` formatted with the order's currency sign.\n"},"order_total_after_store_credit":{"type":"string","format":"float","description":"The order total after any and all `total_applicable_store_credit` is subtracted\nfrom the `total`.\n"},"display_order_total_after_store_credit":{"type":"string","description":"The `order_total_after_store_credit` formatted with the order's currecny sign.\n"},"display_total_available_store_credit":{"type":"string","description":"The total amount of store credit associated with the customer's account formatted\nwith the order's currency symbol.\n"},"display_store_credit_remaining_after_capture":{"type":"string","description":"The total amount of store credit after the payment has been captured formatted\nwith the order's currency symbol.\n"},"checkout_steps":{"type":"array","items":{"type":"string"},"description":"The steps the customer must finish in order to complete the order.\n\n**This field is deprecated and will be removed at some point in the future\nas it doesn't mean anything in Chord's 1 step checkout based flows.**\n"},"canceler_id":{"type":"integer","nullable":true,"description":"The ID of the user that canceled the order, if it has been canceled.\n"},"channel":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time","nullable":true},"payment_state":{"type":"string"},"shipment_state":{"type":"string","nullable":true},"hold_until":{"type":"string","format":"date-time"},"warehouse_sku":{"type":"string"},"special_instructions":{"type":"string","nullable":true},"state":{"type":"string"},"total_quantity":{"type":"integer","description":"The total number of items in the order."},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/line-item"}},"metadata":{"$ref":"#/components/schemas/OrderMetadata"},"cross_sell_details":{"$ref":"#/components/schemas/CrossSellDetails"}}},"line-item":{"type":"object","title":"Line item","required":["adjustments"],"properties":{"id":{"type":"integer"},"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/adjustment"}},"is_bundle":{"type":"boolean"},"subscription_type":{"type":"string"},"parts":{"type":"array","items":{"$ref":"#/components/schemas/part"}},"total":{"type":"string"},"display_amount":{"type":"string"},"price":{"type":"string","format":"float"},"single_display_amount":{"type":"string"},"quantity":{"type":"integer"},"variant":{"$ref":"#/components/schemas/variant"},"variant_id":{"type":"integer"},"metadata":{"$ref":"#/components/schemas/metadata"},"cross_sold":{"type":"integer"},"dynamic_promotions":{"type":"array","items":{"$ref":"#/components/schemas/dynamic_promotion"}},"gift_cards":{"type":"array","items":{"$ref":"#/components/schemas/gift_card"}},"pre_paid_subscription":{"$ref":"#/components/schemas/PrepaidSubscriptionResponse"},"digital_purchases":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"redeemed":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/metadata"}}}}}},"adjustment":{"type":"object","properties":{"adjustable_id":{"type":"integer"},"adjustable_type":{"type":"string"},"amount":{"type":"string"},"created_at":{"type":"string"},"display_amount":{"type":"string"},"eligible":{"type":"boolean"},"finalized":{"type":"boolean"},"id":{"type":"integer"},"label":{"type":"string"},"promotion_code_id":{"type":"integer"},"source_id":{"type":"integer"},"source_type":{"type":"string"},"updated_at":{"type":"string"},"promotion_code":{"properties":{"id":{"type":"integer"},"value":{"type":"string"}}}},"title":"Adjustment"},"part":{"type":"object","title":"Part within a parts array","properties":{"sku":{"type":"string","description":"SKU of the variant in the bundle"},"quantity":{"type":"integer","description":"The quantity of variant in this bundle"},"price":{"type":"number","format":"float","description":"The price of the variant in this bundle"}}},"variant":{"type":"object","title":"Variant","properties":{"cost_price":{"type":"string"},"depth":{"type":"string"},"description":{"type":"string"},"display_price":{"type":"string"},"height":{"type":"string"},"id":{"type":"integer"},"images":{"type":"array","items":{"$ref":"#/components/schemas/image"}},"in_stock":{"type":"boolean"},"is_backorderable":{"type":"boolean"},"is_destroyed":{"type":"boolean"},"is_master":{"type":"boolean"},"name":{"type":"string"},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/option-value"}},"options_text":{"type":"string"},"price":{"type":"string"},"sku":{"type":"string"},"slug":{"type":"string"},"total_on_hand":{"type":"integer"},"track_inventory":{"type":"boolean"},"weight":{"type":"string"},"width":{"type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"image":{"type":"object","properties":{"alt":{"type":"string"},"attachment_content_type":{"type":"string"},"attachment_file_name":{"type":"string"},"attachment_height":{"type":"integer"},"attachment_updated_at":{"type":"string"},"attachment_width":{"type":"integer"},"id":{"type":"integer"},"large_url":{"type":"string"},"mini_url":{"type":"string"},"position":{"type":"integer"},"product_url":{"type":"string"},"small_url":{"type":"string"},"type":{"type":"string"},"viewable_id":{"type":"integer"},"viewable_type":{"type":"string"}},"title":"Image"},"option-value":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"option_type_id":{"type":"integer"},"option_type_name":{"type":"string"},"option_type_presentation":{"type":"string"},"presentation":{"type":"string"}},"title":"Option value"},"metadata":{"type":"object","nullable":true,"additionalProperties":true,"properties":{},"title":"Metadata","description":"A key-value store of additional information. A key can be removed by\nsetting its value to null.\n"},"dynamic_promotion":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}},"gift_card":{"type":"object","properties":{"id":{"type":"integer"},"filled":{"type":"boolean"},"amount":{"type":"string"},"recipient_email":{"type":"string"},"recipient_name":{"type":"string"},"gift_message":{"type":"string"},"send_email_at":{"type":"string"},"purchaser_name":{"type":"string"},"auto_redeem":{"type":"boolean"},"redemption_code":{"type":"string"}}},"PrepaidSubscriptionResponse":{"type":"object","required":["id","subscription_id","virtual_gift_card_id","actionable_date","auto_redeem","gift","recurring","amount","single_installment_price","state","quantity","installment_count","interval_length","interval_units","line_items","recipient","virtual_gift_card"],"properties":{"id":{"type":"integer"},"subscription_id":{"type":"integer","nullable":true},"virtual_gift_card_id":{"type":"integer","nullable":true},"actionable_date":{"type":"string","format":"date-time"},"auto_redeem":{"type":"boolean"},"gift":{"type":"boolean"},"recurring":{"type":"boolean"},"amount":{"type":"string","format":"float","description":"Total amount that the customer paid upfront for this subsciption.\n"},"single_installment_price":{"type":"string","format":"float","description":"The amount of money the customer paid for a single installment upfront.\n"},"state":{"type":"string","enum":["pending","active","completed"]},"quantity":{"type":"integer","minimum":1,"description":"The number of items that will be in the shipment.\n"},"installment_count":{"type":"number","description":"The number of times that the subsciption should be fulfilled.\n"},"fulfilled_installment_count":{"type":"number","description":"The number of times that the subsciption has been fulfilled within\na billing period.\n"},"interval_length":{"$ref":"#/components/schemas/IntervalLength"},"interval_units":{"$ref":"#/components/schemas/IntervalUnit"},"line_items":{"type":"array","items":{"type":"object","required":["quantity","variant"],"properties":{"quantity":{"type":"integer"},"variant":{"$ref":"#/components/schemas/variant"}}}},"recipient":{"type":"object","required":["name","email","address"],"properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"},"address":{"$ref":"#/components/schemas/address"}}},"virtual_gift_card":{"$ref":"#/components/schemas/gift_card"}}},"IntervalLength":{"type":"number","minimum":1,"description":"How many times a subscription should be fulfilled for a given\ninterval unit. Here are some examples.\n\n- Length = 1 and unit = `month` == once a month\n- Length = 2 and unit = `week` == every two weeks\n- Length = 1 and unit = `year` == once a year\n"},"IntervalUnit":{"type":"string","enum":["day","week","month","year"],"description":"The measurement of time applied to the interval unit of how often a\nsubscription is fulfilled.\n"},"address":{"type":"object","title":"Address","properties":{"id":{"type":"integer"},"name":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string","nullable":true},"city":{"type":"string"},"zipcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"alternative_phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"country_id":{"type":"integer"},"country_iso":{"type":"string"},"phone":{"type":"string","nullable":true},"state":{"$ref":"#/components/schemas/state"},"state_id":{"type":"integer"},"state_name":{"type":"string"},"state_text":{"type":"string"}}},"country":{"type":"object","properties":{"id":{"type":"integer"},"iso":{"type":"string"},"iso3":{"type":"string"},"iso_name":{"type":"string"},"name":{"type":"string"},"numcode":{"type":"integer"}},"title":"Country"},"state":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"abbr":{"type":"string"},"country_id":{"type":"integer"}},"title":"State"},"OrderMetadata":{"type":"object","nullable":true,"additionalProperties":true,"properties":{},"title":"Metadata","description":"A key-value store of additional information. A key can be removed by\nsetting its value to null.\n"},"CrossSellDetails":{"type":"object","properties":{"cross_sellable":{"type":"boolean"},"cross_sell_duration_in_minutes":{"type":"integer"},"cross_sell_ends_at":{"type":"string","format":"date-time"}}},"gift_note":{"type":"object","title":"Gift Note","nullable":true,"description":"An optional note to attach to the order. For some fulfillment services,\nthis note might be printed and packaged with the order.\n","properties":{"from":{"type":"string"},"recipient":{"type":"string"},"note":{"type":"string"}}}},"responses":{"invalid-api-key":{"description":"Invalid API Key provided","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"not-found":{"description":"Resource is not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"unprocessable-entity":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"errors":{"type":"object"}}}}}}}},"paths":{"/checkouts/{checkout_id}/advance":{"put":{"summary":"Advance checkout","description":"Advances a checkout to the furthest possible state.","operationId":"advance-checkout","tags":["Checkouts"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderBig"}}}},"401":{"$ref":"#/components/responses/invalid-api-key"},"404":{"$ref":"#/components/responses/not-found"},"422":{"$ref":"#/components/responses/unprocessable-entity"}}}}}}
```

## Complete checkout

> Completes a checkout.

```json
{"openapi":"3.0.0","info":{"title":"OMS API","version":"1.1"},"tags":[{"name":"Checkouts"}],"servers":[{"url":"https://{host}/api","description":"Chord OMS instance","variables":{"host":{"default":"plant-staging.assembly-api.com","description":"Your tenant host, as configured in Chord OMS. The default is a Chord staging sandbox: replace it with your own host before making real requests."}}}],"security":[{"api-key":[]},{"order-token":[]}],"components":{"securitySchemes":{"api-key":{"type":"http","scheme":"bearer","description":"This is an admin level API token used for priviliged storefront\noperations. This should never be used in public contexts.\n"},"order-token":{"type":"apiKey","name":"X-Spree-Order-Token","in":"header","description":"This is a token that is assoicated with an order that allows operations\non that order. It is to be used as a means of authentication for guest\ncheckout sessions.\n"}},"schemas":{"OrderBig":{"title":"Order (big)","allOf":[{"$ref":"#/components/schemas/OrderSmall"},{"type":"object","properties":{"checkout_session_id":{"type":"string","nullable":true},"store":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"code":{"type":"string"}}},"pre_paid_subscription_installment":{"type":"boolean"},"subscription_in_cart":{"type":"boolean"},"tag_list":{"type":"array","items":{"type":"string"}},"gift_note":{"$ref":"#/components/schemas/gift_note"}}}]},"OrderSmall":{"type":"object","title":"Order (small)","required":["id","number","token","user_id","email","currency","locale","total","display_total","item_total","display_item_total","payment_total","adjustment_total","ship_total","display_ship_total","tax_total","additional_tax_total","display_additional_tax_total","included_tax_total","display_included_tax_total","checkout_steps","created_at","updated_at","completed_at"],"properties":{"id":{"type":"integer"},"number":{"type":"string"},"token":{"type":"string","description":"This token can be used as a means of authentication for a subset\nof order operations in a guest checkout scenario. It should be passed\nas header named `X-Spree-Order-Token` on the request.\n"},"user_id":{"type":"integer","nullable":true,"description":"The ID of the user associated with this order. If the order is not in a completed\nstate and the customer is not logged in, this will be `null`.\n"},"email":{"type":"string","format":"email","nullable":true},"currency":{"type":"string","description":"The [ISO 4217 currency code](https://taxsummaries.pwc.com/glossary/currency-codes)\nfor the order.\n"},"locale":{"type":"string","nullable":true},"total":{"type":"string","format":"float","description":"This is the total amount of money that the customer paid/will pay.\nIt is the `item_total` + `shipment_total` + `adjustment_total`.\n"},"display_total":{"type":"string","description":"The formatted `total` with the currency's symbol.\n"},"item_total":{"type":"string","format":"float","description":"The total cost of the items in the cart. This does not include discounts,\nadjustments or shipping.\n"},"display_item_total":{"type":"string","format":"string","description":"The formatted `item_total` with the order's currency symbol.\n"},"payment_total":{"type":"string","format":"float","description":"TBD"},"adjustment_total":{"type":"string","format":"float","description":"The total amount discounted from the order.\n"},"ship_total":{"type":"string","format":"float","description":"The amount of money that the customer paid in shipping costs. For some of\nChord's payment methods, like Stripe, this amount in not known until after\nthe order is completed, as the address input is outside of Chord's systems.\n"},"display_ship_total":{"type":"string","description":"The formatted `ship_total` with the order's currency symbol.\n"},"tax_total":{"type":"string","format":"float","description":"The amount of money the the customer paid in taxes. For some of Chord's\npayment methods, like Stripe, this amount is not known until after the\norder is completed, as the address input is outside of Chord's systems.\n"},"display_tax_total":{"type":"string","description":"The `tax_total` formatted with the order's currency symbol.\n"},"additional_tax_total":{"type":"string","format":"float","description":"If the order requires VAT (Value Added Tax), this is the amount of tax the\ncustomer will pay.\n"},"display_additional_tax_total":{"type":"string","description":"The formatted `additional_tax_total` with the order's currency symbol.\n"},"included_tax_total":{"type":"string","format":"float","description":"The total amount of additional tax applied to the order outside of the normal\nsales tax applied.\n"},"display_included_tax_total":{"type":"string","description":"The formatted `included_tax_total` with the order's currency symbol.\n"},"covered_by_store_credit":{"type":"boolean","description":"This is `true` if the user's available store credit is greater than\nor equal to the order's total.\n"},"total_applicable_store_credit":{"description":"How much store credit will be subtracted by this order's total.\n\nThis will be an integer 0 when there is not any store credit\navailable, otherwise, it will be a string float.\n","oneOf":[{"type":"string","format":"float"},{"type":"integer","enum":[0]}]},"display_total_applicable_store_credit":{"type":"string","description":"The `total_applicable_store_credit` formatted with the order's currency sign.\n"},"order_total_after_store_credit":{"type":"string","format":"float","description":"The order total after any and all `total_applicable_store_credit` is subtracted\nfrom the `total`.\n"},"display_order_total_after_store_credit":{"type":"string","description":"The `order_total_after_store_credit` formatted with the order's currecny sign.\n"},"display_total_available_store_credit":{"type":"string","description":"The total amount of store credit associated with the customer's account formatted\nwith the order's currency symbol.\n"},"display_store_credit_remaining_after_capture":{"type":"string","description":"The total amount of store credit after the payment has been captured formatted\nwith the order's currency symbol.\n"},"checkout_steps":{"type":"array","items":{"type":"string"},"description":"The steps the customer must finish in order to complete the order.\n\n**This field is deprecated and will be removed at some point in the future\nas it doesn't mean anything in Chord's 1 step checkout based flows.**\n"},"canceler_id":{"type":"integer","nullable":true,"description":"The ID of the user that canceled the order, if it has been canceled.\n"},"channel":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time","nullable":true},"payment_state":{"type":"string"},"shipment_state":{"type":"string","nullable":true},"hold_until":{"type":"string","format":"date-time"},"warehouse_sku":{"type":"string"},"special_instructions":{"type":"string","nullable":true},"state":{"type":"string"},"total_quantity":{"type":"integer","description":"The total number of items in the order."},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/line-item"}},"metadata":{"$ref":"#/components/schemas/OrderMetadata"},"cross_sell_details":{"$ref":"#/components/schemas/CrossSellDetails"}}},"line-item":{"type":"object","title":"Line item","required":["adjustments"],"properties":{"id":{"type":"integer"},"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/adjustment"}},"is_bundle":{"type":"boolean"},"subscription_type":{"type":"string"},"parts":{"type":"array","items":{"$ref":"#/components/schemas/part"}},"total":{"type":"string"},"display_amount":{"type":"string"},"price":{"type":"string","format":"float"},"single_display_amount":{"type":"string"},"quantity":{"type":"integer"},"variant":{"$ref":"#/components/schemas/variant"},"variant_id":{"type":"integer"},"metadata":{"$ref":"#/components/schemas/metadata"},"cross_sold":{"type":"integer"},"dynamic_promotions":{"type":"array","items":{"$ref":"#/components/schemas/dynamic_promotion"}},"gift_cards":{"type":"array","items":{"$ref":"#/components/schemas/gift_card"}},"pre_paid_subscription":{"$ref":"#/components/schemas/PrepaidSubscriptionResponse"},"digital_purchases":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"redeemed":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/metadata"}}}}}},"adjustment":{"type":"object","properties":{"adjustable_id":{"type":"integer"},"adjustable_type":{"type":"string"},"amount":{"type":"string"},"created_at":{"type":"string"},"display_amount":{"type":"string"},"eligible":{"type":"boolean"},"finalized":{"type":"boolean"},"id":{"type":"integer"},"label":{"type":"string"},"promotion_code_id":{"type":"integer"},"source_id":{"type":"integer"},"source_type":{"type":"string"},"updated_at":{"type":"string"},"promotion_code":{"properties":{"id":{"type":"integer"},"value":{"type":"string"}}}},"title":"Adjustment"},"part":{"type":"object","title":"Part within a parts array","properties":{"sku":{"type":"string","description":"SKU of the variant in the bundle"},"quantity":{"type":"integer","description":"The quantity of variant in this bundle"},"price":{"type":"number","format":"float","description":"The price of the variant in this bundle"}}},"variant":{"type":"object","title":"Variant","properties":{"cost_price":{"type":"string"},"depth":{"type":"string"},"description":{"type":"string"},"display_price":{"type":"string"},"height":{"type":"string"},"id":{"type":"integer"},"images":{"type":"array","items":{"$ref":"#/components/schemas/image"}},"in_stock":{"type":"boolean"},"is_backorderable":{"type":"boolean"},"is_destroyed":{"type":"boolean"},"is_master":{"type":"boolean"},"name":{"type":"string"},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/option-value"}},"options_text":{"type":"string"},"price":{"type":"string"},"sku":{"type":"string"},"slug":{"type":"string"},"total_on_hand":{"type":"integer"},"track_inventory":{"type":"boolean"},"weight":{"type":"string"},"width":{"type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"image":{"type":"object","properties":{"alt":{"type":"string"},"attachment_content_type":{"type":"string"},"attachment_file_name":{"type":"string"},"attachment_height":{"type":"integer"},"attachment_updated_at":{"type":"string"},"attachment_width":{"type":"integer"},"id":{"type":"integer"},"large_url":{"type":"string"},"mini_url":{"type":"string"},"position":{"type":"integer"},"product_url":{"type":"string"},"small_url":{"type":"string"},"type":{"type":"string"},"viewable_id":{"type":"integer"},"viewable_type":{"type":"string"}},"title":"Image"},"option-value":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"option_type_id":{"type":"integer"},"option_type_name":{"type":"string"},"option_type_presentation":{"type":"string"},"presentation":{"type":"string"}},"title":"Option value"},"metadata":{"type":"object","nullable":true,"additionalProperties":true,"properties":{},"title":"Metadata","description":"A key-value store of additional information. A key can be removed by\nsetting its value to null.\n"},"dynamic_promotion":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}},"gift_card":{"type":"object","properties":{"id":{"type":"integer"},"filled":{"type":"boolean"},"amount":{"type":"string"},"recipient_email":{"type":"string"},"recipient_name":{"type":"string"},"gift_message":{"type":"string"},"send_email_at":{"type":"string"},"purchaser_name":{"type":"string"},"auto_redeem":{"type":"boolean"},"redemption_code":{"type":"string"}}},"PrepaidSubscriptionResponse":{"type":"object","required":["id","subscription_id","virtual_gift_card_id","actionable_date","auto_redeem","gift","recurring","amount","single_installment_price","state","quantity","installment_count","interval_length","interval_units","line_items","recipient","virtual_gift_card"],"properties":{"id":{"type":"integer"},"subscription_id":{"type":"integer","nullable":true},"virtual_gift_card_id":{"type":"integer","nullable":true},"actionable_date":{"type":"string","format":"date-time"},"auto_redeem":{"type":"boolean"},"gift":{"type":"boolean"},"recurring":{"type":"boolean"},"amount":{"type":"string","format":"float","description":"Total amount that the customer paid upfront for this subsciption.\n"},"single_installment_price":{"type":"string","format":"float","description":"The amount of money the customer paid for a single installment upfront.\n"},"state":{"type":"string","enum":["pending","active","completed"]},"quantity":{"type":"integer","minimum":1,"description":"The number of items that will be in the shipment.\n"},"installment_count":{"type":"number","description":"The number of times that the subsciption should be fulfilled.\n"},"fulfilled_installment_count":{"type":"number","description":"The number of times that the subsciption has been fulfilled within\na billing period.\n"},"interval_length":{"$ref":"#/components/schemas/IntervalLength"},"interval_units":{"$ref":"#/components/schemas/IntervalUnit"},"line_items":{"type":"array","items":{"type":"object","required":["quantity","variant"],"properties":{"quantity":{"type":"integer"},"variant":{"$ref":"#/components/schemas/variant"}}}},"recipient":{"type":"object","required":["name","email","address"],"properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"},"address":{"$ref":"#/components/schemas/address"}}},"virtual_gift_card":{"$ref":"#/components/schemas/gift_card"}}},"IntervalLength":{"type":"number","minimum":1,"description":"How many times a subscription should be fulfilled for a given\ninterval unit. Here are some examples.\n\n- Length = 1 and unit = `month` == once a month\n- Length = 2 and unit = `week` == every two weeks\n- Length = 1 and unit = `year` == once a year\n"},"IntervalUnit":{"type":"string","enum":["day","week","month","year"],"description":"The measurement of time applied to the interval unit of how often a\nsubscription is fulfilled.\n"},"address":{"type":"object","title":"Address","properties":{"id":{"type":"integer"},"name":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string","nullable":true},"city":{"type":"string"},"zipcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"alternative_phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"country_id":{"type":"integer"},"country_iso":{"type":"string"},"phone":{"type":"string","nullable":true},"state":{"$ref":"#/components/schemas/state"},"state_id":{"type":"integer"},"state_name":{"type":"string"},"state_text":{"type":"string"}}},"country":{"type":"object","properties":{"id":{"type":"integer"},"iso":{"type":"string"},"iso3":{"type":"string"},"iso_name":{"type":"string"},"name":{"type":"string"},"numcode":{"type":"integer"}},"title":"Country"},"state":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"abbr":{"type":"string"},"country_id":{"type":"integer"}},"title":"State"},"OrderMetadata":{"type":"object","nullable":true,"additionalProperties":true,"properties":{},"title":"Metadata","description":"A key-value store of additional information. A key can be removed by\nsetting its value to null.\n"},"CrossSellDetails":{"type":"object","properties":{"cross_sellable":{"type":"boolean"},"cross_sell_duration_in_minutes":{"type":"integer"},"cross_sell_ends_at":{"type":"string","format":"date-time"}}},"gift_note":{"type":"object","title":"Gift Note","nullable":true,"description":"An optional note to attach to the order. For some fulfillment services,\nthis note might be printed and packaged with the order.\n","properties":{"from":{"type":"string"},"recipient":{"type":"string"},"note":{"type":"string"}}}},"responses":{"invalid-api-key":{"description":"Invalid API Key provided","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"not-found":{"description":"Resource is not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"unprocessable-entity":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"errors":{"type":"object"}}}}}}}},"paths":{"/checkouts/{checkout_id}/complete":{"put":{"summary":"Complete checkout","description":"Completes a checkout.","operationId":"complete-checkout","tags":["Checkouts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expected_total":{"type":"string"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderBig"}}}},"401":{"$ref":"#/components/responses/invalid-api-key"},"404":{"$ref":"#/components/responses/not-found"},"422":{"$ref":"#/components/responses/unprocessable-entity"}}}}}}
```

## Transition checkout

> Transitions a checkout to the next state.

```json
{"openapi":"3.0.0","info":{"title":"OMS API","version":"1.1"},"tags":[{"name":"Checkouts"}],"servers":[{"url":"https://{host}/api","description":"Chord OMS instance","variables":{"host":{"default":"plant-staging.assembly-api.com","description":"Your tenant host, as configured in Chord OMS. The default is a Chord staging sandbox: replace it with your own host before making real requests."}}}],"security":[{"api-key":[]},{"order-token":[]}],"components":{"securitySchemes":{"api-key":{"type":"http","scheme":"bearer","description":"This is an admin level API token used for priviliged storefront\noperations. This should never be used in public contexts.\n"},"order-token":{"type":"apiKey","name":"X-Spree-Order-Token","in":"header","description":"This is a token that is assoicated with an order that allows operations\non that order. It is to be used as a means of authentication for guest\ncheckout sessions.\n"}},"schemas":{"OrderBig":{"title":"Order (big)","allOf":[{"$ref":"#/components/schemas/OrderSmall"},{"type":"object","properties":{"checkout_session_id":{"type":"string","nullable":true},"store":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"code":{"type":"string"}}},"pre_paid_subscription_installment":{"type":"boolean"},"subscription_in_cart":{"type":"boolean"},"tag_list":{"type":"array","items":{"type":"string"}},"gift_note":{"$ref":"#/components/schemas/gift_note"}}}]},"OrderSmall":{"type":"object","title":"Order (small)","required":["id","number","token","user_id","email","currency","locale","total","display_total","item_total","display_item_total","payment_total","adjustment_total","ship_total","display_ship_total","tax_total","additional_tax_total","display_additional_tax_total","included_tax_total","display_included_tax_total","checkout_steps","created_at","updated_at","completed_at"],"properties":{"id":{"type":"integer"},"number":{"type":"string"},"token":{"type":"string","description":"This token can be used as a means of authentication for a subset\nof order operations in a guest checkout scenario. It should be passed\nas header named `X-Spree-Order-Token` on the request.\n"},"user_id":{"type":"integer","nullable":true,"description":"The ID of the user associated with this order. If the order is not in a completed\nstate and the customer is not logged in, this will be `null`.\n"},"email":{"type":"string","format":"email","nullable":true},"currency":{"type":"string","description":"The [ISO 4217 currency code](https://taxsummaries.pwc.com/glossary/currency-codes)\nfor the order.\n"},"locale":{"type":"string","nullable":true},"total":{"type":"string","format":"float","description":"This is the total amount of money that the customer paid/will pay.\nIt is the `item_total` + `shipment_total` + `adjustment_total`.\n"},"display_total":{"type":"string","description":"The formatted `total` with the currency's symbol.\n"},"item_total":{"type":"string","format":"float","description":"The total cost of the items in the cart. This does not include discounts,\nadjustments or shipping.\n"},"display_item_total":{"type":"string","format":"string","description":"The formatted `item_total` with the order's currency symbol.\n"},"payment_total":{"type":"string","format":"float","description":"TBD"},"adjustment_total":{"type":"string","format":"float","description":"The total amount discounted from the order.\n"},"ship_total":{"type":"string","format":"float","description":"The amount of money that the customer paid in shipping costs. For some of\nChord's payment methods, like Stripe, this amount in not known until after\nthe order is completed, as the address input is outside of Chord's systems.\n"},"display_ship_total":{"type":"string","description":"The formatted `ship_total` with the order's currency symbol.\n"},"tax_total":{"type":"string","format":"float","description":"The amount of money the the customer paid in taxes. For some of Chord's\npayment methods, like Stripe, this amount is not known until after the\norder is completed, as the address input is outside of Chord's systems.\n"},"display_tax_total":{"type":"string","description":"The `tax_total` formatted with the order's currency symbol.\n"},"additional_tax_total":{"type":"string","format":"float","description":"If the order requires VAT (Value Added Tax), this is the amount of tax the\ncustomer will pay.\n"},"display_additional_tax_total":{"type":"string","description":"The formatted `additional_tax_total` with the order's currency symbol.\n"},"included_tax_total":{"type":"string","format":"float","description":"The total amount of additional tax applied to the order outside of the normal\nsales tax applied.\n"},"display_included_tax_total":{"type":"string","description":"The formatted `included_tax_total` with the order's currency symbol.\n"},"covered_by_store_credit":{"type":"boolean","description":"This is `true` if the user's available store credit is greater than\nor equal to the order's total.\n"},"total_applicable_store_credit":{"description":"How much store credit will be subtracted by this order's total.\n\nThis will be an integer 0 when there is not any store credit\navailable, otherwise, it will be a string float.\n","oneOf":[{"type":"string","format":"float"},{"type":"integer","enum":[0]}]},"display_total_applicable_store_credit":{"type":"string","description":"The `total_applicable_store_credit` formatted with the order's currency sign.\n"},"order_total_after_store_credit":{"type":"string","format":"float","description":"The order total after any and all `total_applicable_store_credit` is subtracted\nfrom the `total`.\n"},"display_order_total_after_store_credit":{"type":"string","description":"The `order_total_after_store_credit` formatted with the order's currecny sign.\n"},"display_total_available_store_credit":{"type":"string","description":"The total amount of store credit associated with the customer's account formatted\nwith the order's currency symbol.\n"},"display_store_credit_remaining_after_capture":{"type":"string","description":"The total amount of store credit after the payment has been captured formatted\nwith the order's currency symbol.\n"},"checkout_steps":{"type":"array","items":{"type":"string"},"description":"The steps the customer must finish in order to complete the order.\n\n**This field is deprecated and will be removed at some point in the future\nas it doesn't mean anything in Chord's 1 step checkout based flows.**\n"},"canceler_id":{"type":"integer","nullable":true,"description":"The ID of the user that canceled the order, if it has been canceled.\n"},"channel":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time","nullable":true},"payment_state":{"type":"string"},"shipment_state":{"type":"string","nullable":true},"hold_until":{"type":"string","format":"date-time"},"warehouse_sku":{"type":"string"},"special_instructions":{"type":"string","nullable":true},"state":{"type":"string"},"total_quantity":{"type":"integer","description":"The total number of items in the order."},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/line-item"}},"metadata":{"$ref":"#/components/schemas/OrderMetadata"},"cross_sell_details":{"$ref":"#/components/schemas/CrossSellDetails"}}},"line-item":{"type":"object","title":"Line item","required":["adjustments"],"properties":{"id":{"type":"integer"},"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/adjustment"}},"is_bundle":{"type":"boolean"},"subscription_type":{"type":"string"},"parts":{"type":"array","items":{"$ref":"#/components/schemas/part"}},"total":{"type":"string"},"display_amount":{"type":"string"},"price":{"type":"string","format":"float"},"single_display_amount":{"type":"string"},"quantity":{"type":"integer"},"variant":{"$ref":"#/components/schemas/variant"},"variant_id":{"type":"integer"},"metadata":{"$ref":"#/components/schemas/metadata"},"cross_sold":{"type":"integer"},"dynamic_promotions":{"type":"array","items":{"$ref":"#/components/schemas/dynamic_promotion"}},"gift_cards":{"type":"array","items":{"$ref":"#/components/schemas/gift_card"}},"pre_paid_subscription":{"$ref":"#/components/schemas/PrepaidSubscriptionResponse"},"digital_purchases":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"redeemed":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/metadata"}}}}}},"adjustment":{"type":"object","properties":{"adjustable_id":{"type":"integer"},"adjustable_type":{"type":"string"},"amount":{"type":"string"},"created_at":{"type":"string"},"display_amount":{"type":"string"},"eligible":{"type":"boolean"},"finalized":{"type":"boolean"},"id":{"type":"integer"},"label":{"type":"string"},"promotion_code_id":{"type":"integer"},"source_id":{"type":"integer"},"source_type":{"type":"string"},"updated_at":{"type":"string"},"promotion_code":{"properties":{"id":{"type":"integer"},"value":{"type":"string"}}}},"title":"Adjustment"},"part":{"type":"object","title":"Part within a parts array","properties":{"sku":{"type":"string","description":"SKU of the variant in the bundle"},"quantity":{"type":"integer","description":"The quantity of variant in this bundle"},"price":{"type":"number","format":"float","description":"The price of the variant in this bundle"}}},"variant":{"type":"object","title":"Variant","properties":{"cost_price":{"type":"string"},"depth":{"type":"string"},"description":{"type":"string"},"display_price":{"type":"string"},"height":{"type":"string"},"id":{"type":"integer"},"images":{"type":"array","items":{"$ref":"#/components/schemas/image"}},"in_stock":{"type":"boolean"},"is_backorderable":{"type":"boolean"},"is_destroyed":{"type":"boolean"},"is_master":{"type":"boolean"},"name":{"type":"string"},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/option-value"}},"options_text":{"type":"string"},"price":{"type":"string"},"sku":{"type":"string"},"slug":{"type":"string"},"total_on_hand":{"type":"integer"},"track_inventory":{"type":"boolean"},"weight":{"type":"string"},"width":{"type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"image":{"type":"object","properties":{"alt":{"type":"string"},"attachment_content_type":{"type":"string"},"attachment_file_name":{"type":"string"},"attachment_height":{"type":"integer"},"attachment_updated_at":{"type":"string"},"attachment_width":{"type":"integer"},"id":{"type":"integer"},"large_url":{"type":"string"},"mini_url":{"type":"string"},"position":{"type":"integer"},"product_url":{"type":"string"},"small_url":{"type":"string"},"type":{"type":"string"},"viewable_id":{"type":"integer"},"viewable_type":{"type":"string"}},"title":"Image"},"option-value":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"option_type_id":{"type":"integer"},"option_type_name":{"type":"string"},"option_type_presentation":{"type":"string"},"presentation":{"type":"string"}},"title":"Option value"},"metadata":{"type":"object","nullable":true,"additionalProperties":true,"properties":{},"title":"Metadata","description":"A key-value store of additional information. A key can be removed by\nsetting its value to null.\n"},"dynamic_promotion":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}},"gift_card":{"type":"object","properties":{"id":{"type":"integer"},"filled":{"type":"boolean"},"amount":{"type":"string"},"recipient_email":{"type":"string"},"recipient_name":{"type":"string"},"gift_message":{"type":"string"},"send_email_at":{"type":"string"},"purchaser_name":{"type":"string"},"auto_redeem":{"type":"boolean"},"redemption_code":{"type":"string"}}},"PrepaidSubscriptionResponse":{"type":"object","required":["id","subscription_id","virtual_gift_card_id","actionable_date","auto_redeem","gift","recurring","amount","single_installment_price","state","quantity","installment_count","interval_length","interval_units","line_items","recipient","virtual_gift_card"],"properties":{"id":{"type":"integer"},"subscription_id":{"type":"integer","nullable":true},"virtual_gift_card_id":{"type":"integer","nullable":true},"actionable_date":{"type":"string","format":"date-time"},"auto_redeem":{"type":"boolean"},"gift":{"type":"boolean"},"recurring":{"type":"boolean"},"amount":{"type":"string","format":"float","description":"Total amount that the customer paid upfront for this subsciption.\n"},"single_installment_price":{"type":"string","format":"float","description":"The amount of money the customer paid for a single installment upfront.\n"},"state":{"type":"string","enum":["pending","active","completed"]},"quantity":{"type":"integer","minimum":1,"description":"The number of items that will be in the shipment.\n"},"installment_count":{"type":"number","description":"The number of times that the subsciption should be fulfilled.\n"},"fulfilled_installment_count":{"type":"number","description":"The number of times that the subsciption has been fulfilled within\na billing period.\n"},"interval_length":{"$ref":"#/components/schemas/IntervalLength"},"interval_units":{"$ref":"#/components/schemas/IntervalUnit"},"line_items":{"type":"array","items":{"type":"object","required":["quantity","variant"],"properties":{"quantity":{"type":"integer"},"variant":{"$ref":"#/components/schemas/variant"}}}},"recipient":{"type":"object","required":["name","email","address"],"properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"},"address":{"$ref":"#/components/schemas/address"}}},"virtual_gift_card":{"$ref":"#/components/schemas/gift_card"}}},"IntervalLength":{"type":"number","minimum":1,"description":"How many times a subscription should be fulfilled for a given\ninterval unit. Here are some examples.\n\n- Length = 1 and unit = `month` == once a month\n- Length = 2 and unit = `week` == every two weeks\n- Length = 1 and unit = `year` == once a year\n"},"IntervalUnit":{"type":"string","enum":["day","week","month","year"],"description":"The measurement of time applied to the interval unit of how often a\nsubscription is fulfilled.\n"},"address":{"type":"object","title":"Address","properties":{"id":{"type":"integer"},"name":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string","nullable":true},"city":{"type":"string"},"zipcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"alternative_phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"country_id":{"type":"integer"},"country_iso":{"type":"string"},"phone":{"type":"string","nullable":true},"state":{"$ref":"#/components/schemas/state"},"state_id":{"type":"integer"},"state_name":{"type":"string"},"state_text":{"type":"string"}}},"country":{"type":"object","properties":{"id":{"type":"integer"},"iso":{"type":"string"},"iso3":{"type":"string"},"iso_name":{"type":"string"},"name":{"type":"string"},"numcode":{"type":"integer"}},"title":"Country"},"state":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"abbr":{"type":"string"},"country_id":{"type":"integer"}},"title":"State"},"OrderMetadata":{"type":"object","nullable":true,"additionalProperties":true,"properties":{},"title":"Metadata","description":"A key-value store of additional information. A key can be removed by\nsetting its value to null.\n"},"CrossSellDetails":{"type":"object","properties":{"cross_sellable":{"type":"boolean"},"cross_sell_duration_in_minutes":{"type":"integer"},"cross_sell_ends_at":{"type":"string","format":"date-time"}}},"gift_note":{"type":"object","title":"Gift Note","nullable":true,"description":"An optional note to attach to the order. For some fulfillment services,\nthis note might be printed and packaged with the order.\n","properties":{"from":{"type":"string"},"recipient":{"type":"string"},"note":{"type":"string"}}}},"responses":{"invalid-api-key":{"description":"Invalid API Key provided","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"not-found":{"description":"Resource is not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"unprocessable-entity":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"errors":{"type":"object"}}}}}}}},"paths":{"/checkouts/{checkout_id}/next":{"put":{"summary":"Transition checkout","description":"Transitions a checkout to the next state.","operationId":"transition-checkout","tags":["Checkouts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expected_total":{"type":"string"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderBig"}}}},"401":{"$ref":"#/components/responses/invalid-api-key"},"404":{"$ref":"#/components/responses/not-found"},"422":{"$ref":"#/components/responses/unprocessable-entity"}}}}}}
```

## Finalize the checkout

> Finalize the checkout after a succesful payment.

```json
{"openapi":"3.0.0","info":{"title":"OMS API","version":"1.1"},"tags":[{"name":"Checkouts"}],"servers":[{"url":"https://{host}/api","description":"Chord OMS instance","variables":{"host":{"default":"plant-staging.assembly-api.com","description":"Your tenant host, as configured in Chord OMS. The default is a Chord staging sandbox: replace it with your own host before making real requests."}}}],"security":[{"api-key":[]},{"order-token":[]}],"components":{"securitySchemes":{"api-key":{"type":"http","scheme":"bearer","description":"This is an admin level API token used for priviliged storefront\noperations. This should never be used in public contexts.\n"},"order-token":{"type":"apiKey","name":"X-Spree-Order-Token","in":"header","description":"This is a token that is assoicated with an order that allows operations\non that order. It is to be used as a means of authentication for guest\ncheckout sessions.\n"}},"schemas":{"OrderBig":{"title":"Order (big)","allOf":[{"$ref":"#/components/schemas/OrderSmall"},{"type":"object","properties":{"checkout_session_id":{"type":"string","nullable":true},"store":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"code":{"type":"string"}}},"pre_paid_subscription_installment":{"type":"boolean"},"subscription_in_cart":{"type":"boolean"},"tag_list":{"type":"array","items":{"type":"string"}},"gift_note":{"$ref":"#/components/schemas/gift_note"}}}]},"OrderSmall":{"type":"object","title":"Order (small)","required":["id","number","token","user_id","email","currency","locale","total","display_total","item_total","display_item_total","payment_total","adjustment_total","ship_total","display_ship_total","tax_total","additional_tax_total","display_additional_tax_total","included_tax_total","display_included_tax_total","checkout_steps","created_at","updated_at","completed_at"],"properties":{"id":{"type":"integer"},"number":{"type":"string"},"token":{"type":"string","description":"This token can be used as a means of authentication for a subset\nof order operations in a guest checkout scenario. It should be passed\nas header named `X-Spree-Order-Token` on the request.\n"},"user_id":{"type":"integer","nullable":true,"description":"The ID of the user associated with this order. If the order is not in a completed\nstate and the customer is not logged in, this will be `null`.\n"},"email":{"type":"string","format":"email","nullable":true},"currency":{"type":"string","description":"The [ISO 4217 currency code](https://taxsummaries.pwc.com/glossary/currency-codes)\nfor the order.\n"},"locale":{"type":"string","nullable":true},"total":{"type":"string","format":"float","description":"This is the total amount of money that the customer paid/will pay.\nIt is the `item_total` + `shipment_total` + `adjustment_total`.\n"},"display_total":{"type":"string","description":"The formatted `total` with the currency's symbol.\n"},"item_total":{"type":"string","format":"float","description":"The total cost of the items in the cart. This does not include discounts,\nadjustments or shipping.\n"},"display_item_total":{"type":"string","format":"string","description":"The formatted `item_total` with the order's currency symbol.\n"},"payment_total":{"type":"string","format":"float","description":"TBD"},"adjustment_total":{"type":"string","format":"float","description":"The total amount discounted from the order.\n"},"ship_total":{"type":"string","format":"float","description":"The amount of money that the customer paid in shipping costs. For some of\nChord's payment methods, like Stripe, this amount in not known until after\nthe order is completed, as the address input is outside of Chord's systems.\n"},"display_ship_total":{"type":"string","description":"The formatted `ship_total` with the order's currency symbol.\n"},"tax_total":{"type":"string","format":"float","description":"The amount of money the the customer paid in taxes. For some of Chord's\npayment methods, like Stripe, this amount is not known until after the\norder is completed, as the address input is outside of Chord's systems.\n"},"display_tax_total":{"type":"string","description":"The `tax_total` formatted with the order's currency symbol.\n"},"additional_tax_total":{"type":"string","format":"float","description":"If the order requires VAT (Value Added Tax), this is the amount of tax the\ncustomer will pay.\n"},"display_additional_tax_total":{"type":"string","description":"The formatted `additional_tax_total` with the order's currency symbol.\n"},"included_tax_total":{"type":"string","format":"float","description":"The total amount of additional tax applied to the order outside of the normal\nsales tax applied.\n"},"display_included_tax_total":{"type":"string","description":"The formatted `included_tax_total` with the order's currency symbol.\n"},"covered_by_store_credit":{"type":"boolean","description":"This is `true` if the user's available store credit is greater than\nor equal to the order's total.\n"},"total_applicable_store_credit":{"description":"How much store credit will be subtracted by this order's total.\n\nThis will be an integer 0 when there is not any store credit\navailable, otherwise, it will be a string float.\n","oneOf":[{"type":"string","format":"float"},{"type":"integer","enum":[0]}]},"display_total_applicable_store_credit":{"type":"string","description":"The `total_applicable_store_credit` formatted with the order's currency sign.\n"},"order_total_after_store_credit":{"type":"string","format":"float","description":"The order total after any and all `total_applicable_store_credit` is subtracted\nfrom the `total`.\n"},"display_order_total_after_store_credit":{"type":"string","description":"The `order_total_after_store_credit` formatted with the order's currecny sign.\n"},"display_total_available_store_credit":{"type":"string","description":"The total amount of store credit associated with the customer's account formatted\nwith the order's currency symbol.\n"},"display_store_credit_remaining_after_capture":{"type":"string","description":"The total amount of store credit after the payment has been captured formatted\nwith the order's currency symbol.\n"},"checkout_steps":{"type":"array","items":{"type":"string"},"description":"The steps the customer must finish in order to complete the order.\n\n**This field is deprecated and will be removed at some point in the future\nas it doesn't mean anything in Chord's 1 step checkout based flows.**\n"},"canceler_id":{"type":"integer","nullable":true,"description":"The ID of the user that canceled the order, if it has been canceled.\n"},"channel":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time","nullable":true},"payment_state":{"type":"string"},"shipment_state":{"type":"string","nullable":true},"hold_until":{"type":"string","format":"date-time"},"warehouse_sku":{"type":"string"},"special_instructions":{"type":"string","nullable":true},"state":{"type":"string"},"total_quantity":{"type":"integer","description":"The total number of items in the order."},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/line-item"}},"metadata":{"$ref":"#/components/schemas/OrderMetadata"},"cross_sell_details":{"$ref":"#/components/schemas/CrossSellDetails"}}},"line-item":{"type":"object","title":"Line item","required":["adjustments"],"properties":{"id":{"type":"integer"},"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/adjustment"}},"is_bundle":{"type":"boolean"},"subscription_type":{"type":"string"},"parts":{"type":"array","items":{"$ref":"#/components/schemas/part"}},"total":{"type":"string"},"display_amount":{"type":"string"},"price":{"type":"string","format":"float"},"single_display_amount":{"type":"string"},"quantity":{"type":"integer"},"variant":{"$ref":"#/components/schemas/variant"},"variant_id":{"type":"integer"},"metadata":{"$ref":"#/components/schemas/metadata"},"cross_sold":{"type":"integer"},"dynamic_promotions":{"type":"array","items":{"$ref":"#/components/schemas/dynamic_promotion"}},"gift_cards":{"type":"array","items":{"$ref":"#/components/schemas/gift_card"}},"pre_paid_subscription":{"$ref":"#/components/schemas/PrepaidSubscriptionResponse"},"digital_purchases":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"redeemed":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/metadata"}}}}}},"adjustment":{"type":"object","properties":{"adjustable_id":{"type":"integer"},"adjustable_type":{"type":"string"},"amount":{"type":"string"},"created_at":{"type":"string"},"display_amount":{"type":"string"},"eligible":{"type":"boolean"},"finalized":{"type":"boolean"},"id":{"type":"integer"},"label":{"type":"string"},"promotion_code_id":{"type":"integer"},"source_id":{"type":"integer"},"source_type":{"type":"string"},"updated_at":{"type":"string"},"promotion_code":{"properties":{"id":{"type":"integer"},"value":{"type":"string"}}}},"title":"Adjustment"},"part":{"type":"object","title":"Part within a parts array","properties":{"sku":{"type":"string","description":"SKU of the variant in the bundle"},"quantity":{"type":"integer","description":"The quantity of variant in this bundle"},"price":{"type":"number","format":"float","description":"The price of the variant in this bundle"}}},"variant":{"type":"object","title":"Variant","properties":{"cost_price":{"type":"string"},"depth":{"type":"string"},"description":{"type":"string"},"display_price":{"type":"string"},"height":{"type":"string"},"id":{"type":"integer"},"images":{"type":"array","items":{"$ref":"#/components/schemas/image"}},"in_stock":{"type":"boolean"},"is_backorderable":{"type":"boolean"},"is_destroyed":{"type":"boolean"},"is_master":{"type":"boolean"},"name":{"type":"string"},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/option-value"}},"options_text":{"type":"string"},"price":{"type":"string"},"sku":{"type":"string"},"slug":{"type":"string"},"total_on_hand":{"type":"integer"},"track_inventory":{"type":"boolean"},"weight":{"type":"string"},"width":{"type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"image":{"type":"object","properties":{"alt":{"type":"string"},"attachment_content_type":{"type":"string"},"attachment_file_name":{"type":"string"},"attachment_height":{"type":"integer"},"attachment_updated_at":{"type":"string"},"attachment_width":{"type":"integer"},"id":{"type":"integer"},"large_url":{"type":"string"},"mini_url":{"type":"string"},"position":{"type":"integer"},"product_url":{"type":"string"},"small_url":{"type":"string"},"type":{"type":"string"},"viewable_id":{"type":"integer"},"viewable_type":{"type":"string"}},"title":"Image"},"option-value":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"option_type_id":{"type":"integer"},"option_type_name":{"type":"string"},"option_type_presentation":{"type":"string"},"presentation":{"type":"string"}},"title":"Option value"},"metadata":{"type":"object","nullable":true,"additionalProperties":true,"properties":{},"title":"Metadata","description":"A key-value store of additional information. A key can be removed by\nsetting its value to null.\n"},"dynamic_promotion":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}},"gift_card":{"type":"object","properties":{"id":{"type":"integer"},"filled":{"type":"boolean"},"amount":{"type":"string"},"recipient_email":{"type":"string"},"recipient_name":{"type":"string"},"gift_message":{"type":"string"},"send_email_at":{"type":"string"},"purchaser_name":{"type":"string"},"auto_redeem":{"type":"boolean"},"redemption_code":{"type":"string"}}},"PrepaidSubscriptionResponse":{"type":"object","required":["id","subscription_id","virtual_gift_card_id","actionable_date","auto_redeem","gift","recurring","amount","single_installment_price","state","quantity","installment_count","interval_length","interval_units","line_items","recipient","virtual_gift_card"],"properties":{"id":{"type":"integer"},"subscription_id":{"type":"integer","nullable":true},"virtual_gift_card_id":{"type":"integer","nullable":true},"actionable_date":{"type":"string","format":"date-time"},"auto_redeem":{"type":"boolean"},"gift":{"type":"boolean"},"recurring":{"type":"boolean"},"amount":{"type":"string","format":"float","description":"Total amount that the customer paid upfront for this subsciption.\n"},"single_installment_price":{"type":"string","format":"float","description":"The amount of money the customer paid for a single installment upfront.\n"},"state":{"type":"string","enum":["pending","active","completed"]},"quantity":{"type":"integer","minimum":1,"description":"The number of items that will be in the shipment.\n"},"installment_count":{"type":"number","description":"The number of times that the subsciption should be fulfilled.\n"},"fulfilled_installment_count":{"type":"number","description":"The number of times that the subsciption has been fulfilled within\na billing period.\n"},"interval_length":{"$ref":"#/components/schemas/IntervalLength"},"interval_units":{"$ref":"#/components/schemas/IntervalUnit"},"line_items":{"type":"array","items":{"type":"object","required":["quantity","variant"],"properties":{"quantity":{"type":"integer"},"variant":{"$ref":"#/components/schemas/variant"}}}},"recipient":{"type":"object","required":["name","email","address"],"properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"},"address":{"$ref":"#/components/schemas/address"}}},"virtual_gift_card":{"$ref":"#/components/schemas/gift_card"}}},"IntervalLength":{"type":"number","minimum":1,"description":"How many times a subscription should be fulfilled for a given\ninterval unit. Here are some examples.\n\n- Length = 1 and unit = `month` == once a month\n- Length = 2 and unit = `week` == every two weeks\n- Length = 1 and unit = `year` == once a year\n"},"IntervalUnit":{"type":"string","enum":["day","week","month","year"],"description":"The measurement of time applied to the interval unit of how often a\nsubscription is fulfilled.\n"},"address":{"type":"object","title":"Address","properties":{"id":{"type":"integer"},"name":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string","nullable":true},"city":{"type":"string"},"zipcode":{"type":"string"},"country":{"$ref":"#/components/schemas/country"},"alternative_phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"country_id":{"type":"integer"},"country_iso":{"type":"string"},"phone":{"type":"string","nullable":true},"state":{"$ref":"#/components/schemas/state"},"state_id":{"type":"integer"},"state_name":{"type":"string"},"state_text":{"type":"string"}}},"country":{"type":"object","properties":{"id":{"type":"integer"},"iso":{"type":"string"},"iso3":{"type":"string"},"iso_name":{"type":"string"},"name":{"type":"string"},"numcode":{"type":"integer"}},"title":"Country"},"state":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"abbr":{"type":"string"},"country_id":{"type":"integer"}},"title":"State"},"OrderMetadata":{"type":"object","nullable":true,"additionalProperties":true,"properties":{},"title":"Metadata","description":"A key-value store of additional information. A key can be removed by\nsetting its value to null.\n"},"CrossSellDetails":{"type":"object","properties":{"cross_sellable":{"type":"boolean"},"cross_sell_duration_in_minutes":{"type":"integer"},"cross_sell_ends_at":{"type":"string","format":"date-time"}}},"gift_note":{"type":"object","title":"Gift Note","nullable":true,"description":"An optional note to attach to the order. For some fulfillment services,\nthis note might be printed and packaged with the order.\n","properties":{"from":{"type":"string"},"recipient":{"type":"string"},"note":{"type":"string"}}}},"responses":{"invalid-api-key":{"description":"Invalid API Key provided","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"not-found":{"description":"Resource is not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"unprocessable-entity":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"errors":{"type":"object"}}}}}}}},"paths":{"/checkouts/{checkout_id}/finalize":{"put":{"summary":"Finalize the checkout","description":"Finalize the checkout after a succesful payment.","operationId":"finalize-checkout","tags":["Checkouts"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderBig"}}}},"401":{"$ref":"#/components/responses/invalid-api-key"},"404":{"$ref":"#/components/responses/not-found"},"422":{"$ref":"#/components/responses/unprocessable-entity"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.chord.co/chord-oms/api-reference/checkouts.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.