Skip to main content
POST
/
checkout
Error
A valid request URL is required to generate request examples
{
  "order_id": 789,
  "status": "processing",
  "order_key": "wc_order_abc123xyz",
  "order_number": "789",
  "payment_result": {
    "payment_status": "success",
    "redirect_url": "https://example.com/checkout/order-received/789/?key=wc_order_abc123xyz",
    "message": "Payment successful"
  },
  "customer_id": 123,
  "billing_address": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@example.com",
    "phone": "+1234567890",
    "address_1": "123 Main St",
    "address_2": "Apt 4B",
    "city": "Anytown",
    "state": "CA",
    "postcode": "12345",
    "country": "US",
    "company": ""
  },
  "shipping_address": {
    "first_name": "John",
    "last_name": "Doe",
    "address_1": "123 Main St",
    "address_2": "Apt 4B",
    "city": "Anytown",
    "state": "CA",
    "postcode": "12345",
    "country": "US",
    "company": ""
  },
  "cart_key": null
}
This endpoint is currently shown as a preview of what’s currently in development and is subject to change.

​
Overview

This endpoint completes the checkout process by creating an order and processing payment. Use this after collecting all necessary checkout information and customer details.

Body

application/json

Checkout completion data

​
billing_address
object
required
​
shipping_address
object
​
use_different_billing
boolean
default:true

Whether to use a different billing address from shipping

​
payment_method
string

Payment method ID

​
payment_data
object[]

Payment data to pass through to the payment gateway

​
shipping_method
string

Shipping method ID

​
currency
string

Currency code for the order (e.g., USD, EUR, GBP). Enables multi-currency support with compatible plugins. If not provided, store default will be used.

Pattern: ^[A-Z]{3}$
Example:

"USD"

​
create_account
boolean
default:false

Create customer account during checkout (for guest checkout)

​
customer_password
string

Password for new customer account (required if create_account is true)

​
customer_note
string

Customer note for the order

Response

Checkout processed successfully

​
order_id
integer

Created order ID

​
status
string

Order status

​
order_key
string

Order key

​
order_number
string

Order number

​
payment_result
object
​
customer_id
integer

Customer ID

​
billing_address
object
​
shipping_address
object
​
cart_key
string | null

Cart key (null after successful checkout)