Primary navigation

Agentic Checkout Spec

Merchants integrate with OpenAI’s checkout flow by implementing the Agentic Checkout Spec

Building with the Agentic Commerce Protocol is open to all. Instant Checkout in ChatGPT is currently available to approved partners. To apply to participate in Instant Checkout, fill out this form here.

Overview

Enable merchants to run end-to-end checkout flows inside ChatGPT while keeping orders, payments, and compliance on their existing commerce stack.

How it works

  1. Create session (REST). ChatGPT calls your POST /checkout_sessions to start a session with cart contents and buyer context; your response must include a rich, authoritative cart state.
  2. Update session (REST). As the user changes items, shipping, or discounts, ChatGPT calls POST /checkout_sessions/{checkout_session_id}; each response returns the full cart state for display and validation.
  3. Order events (webhooks). Your system publishes order lifecycle events (e.g., order.created, order.updated) to the provided webhook so ChatGPT stays in sync with fulfillment-grade truth.
  4. Complete checkout (REST). ChatGPT finalizes via POST /checkout_sessions/{checkout_session_id}/complete; you confirm order creation and return the final cart and order identifiers.
  5. Optionally, cancel checkouts using POST /checkout_sessions/{checkout_session_id}/cancel and get checkout information with GET /checkout_sessions/{checkout_session_id}.
  6. Payments on your rails. You process payment with your existing PSP; if using Delegated Payments, accept the token and apply your normal authorization/capture flow.

Key points

  • Required endpoints. Implement create, update, and complete checkout session REST endpoints; all responses must return a rich cart state (items, pricing, taxes/fees, shipping, discounts, totals, status).
  • Authoritative webhooks. Emit order events to the provided webhook to keep state consistent across retries and edge cases.
  • Keep payments where they are. Use your current PSP and settlement processes; integrate Delegated Payments only if applicable.
  • Security and robustness. Authenticate every request, verify signatures, enforce idempotency, validate inputs, and support safe retries.
  • Certify integration. Pass conformance checks (schema, error codes, rate limits, webhook delivery) to ensure reliable in-ChatGPT checkout.

Checkout session

For users to place an order through ChatGPT, you must create, update and complete a Checkout session. This Checkout session holds information about items to be purchased, fulfillment information, and payment information.

As the user progresses through the checkout flow the Checkout session will be updated and move between various states.

The response to update calls, should return all checkout options, messages, and errors to be displayed to the user. Once the customer clicks “Buy”, the checkout session is completed with a selected payment method.

State diagram showing order states

REST endpoints

Merchants must implement the following five endpoints to place orders on behalf of ChatGPT users.

In the future, the Agentic Checkout Spec will support MCP servers.

Common features of all endpoints

All endpoints must use HTTPS and return JSON.

Request headers

All endpoints will be called with the following headers set:

FieldDescriptionExample Value
AuthorizationAPI Key used to make requestsBearer api_key_123
Accept-LanguageThe preferred locale for content like messages and errorsen-US
User-AgentInformation about the client making this requestChatGPT/2.0 (Mac OS X 15.0.1; arm64; build 0)
Idempotency-KeyKey used to ensure requests are idempotentidempotency_key_123
Request-IdUnique key for each request for tracing purposesrequest_id_123
Content-TypeType of request contentapplication/json
SignatureBase64 encoded signature of the request bodyeyJtZX...
TimestampFormatted as an RFC 3339 string.2025-09-25T10:30:00Z
API-VersionAPI version2025-09-12

Response headers

FieldDescriptionExample Value
Idempotency-KeyIdempotency key passed in the requestidempotency_key_123
Request-IdRequest ID passed in the requestrequest_id_123

POST /checkout_sessions

Call direction: OpenAI -> Merchant

This is the initial call to create a checkout session. The call will contain information about the items the customer wishes to purchase and should return line item information, along with any messages or errors to be displayed to the customer. It should always return a checkout session id. All responses should be returned with a 201 status.

Request

FieldTypeRequiredDescriptionValidation
buyerBuyerNoOptional information about the buyer.None
itemsList[Item]YesThe initial list of items to initiate the checkout session.Should be a non empty list
fulfillment_addressAddressNoOptional fulfillment address if present.None

Response

FieldTypeRequiredDescriptionValidation
idStringYesUnique id that identifies the checkout session. This id will be used to update the checkout session in subsequent calls.None
buyerBuyerNoBuyer information, if providedNone
payment_providerPaymentProviderYesPayment provider that will be used to complete this transaction.None
statusString enumYesCurrent status of the checkout session. Possible values are: not_ready_for_payment ready_for_payment completed canceledNone
currencyStringYesCurrency code as per the ISO 4217 standardShould follow the ISO 4217 standard in lower case
line_itemsList[LineItem]YesList of items and computed costs.None
fulfillment_addressAddressNoAddress to ship items to.None
fulfillment_optionsList[FulfillmentOption]YesAll available fulfillment options and associated costs.None
fulfillment_option_idStringNoId of the selected fulfillment option.None
totalsList[Total]YesList of totals.None
messagesList[Message]YesList of informational and error messages to be displayed to the customer.None
linksList[Link]YesList of links (e.g. ToS/privacy policy/etc.) to be displayed to the customer.None

Examples

  1. Creating a checkout session with a single item and quantity. No fulfillment address is provided, so the checkout cannot be completed.
POST Request to /checkout_sessions

{
   "items": [
       {
           "id": "item_123",
           "quantity": 1
       }
   ]
}
Response

{
   "id": "checkout_session_123",
   "payment_provider": {
       "provider": "stripe",
       "supported_payment_methods": ["card"]
   },
   "status": "in_progress",
   "currency": "usd",
   "line_items": [
       {
           "id": "line_item_123",
           "item": {
               "id": "item_123",
               "quantity": 1
           },
           "base_amount": 300,
           "discount": 0,
           "subtotal": 300,
           "tax": 30,
           "total": 330
       }
   ],
   "totals": [
       {
           "type": "items_base_amount",
           "display_text": "Item(s) total",
           "amount": 300
       },
       {
           "type": "subtotal",
           "display_text": "Subtotal",
           "amount": 300
       },
       {
           "type": "tax",
           "display_text": "Tax",
           "amount": "0.30"
       },
       {
           "type": "total",
           "display_text": "Total",
           "amount": 330
       }
   ],
   "fulfillment_options": [],
   "messages": [
       {
           "type": "error",
           "code": "out_of_stock",
           "path": "$.line_items[0]",
           "content_type": "plain",
           "content": "This item is not available for sale.",
       }
   ],
   "links": [
       {
           "type": "terms_of_use",
           "url": "https://www.testshop.com/legal/terms-of-use"
       }
   ]
}
  1. Creating a checkout session with a single item and quantity, and a provided fulfillment address. Since a fulfillment address is provided, taxes are returned as well. Fulfillment options are also available, and the cheapest one is selected by default. Any messages to show to the customer based on their fulfillment address (e.g. CA 65 warning) are also returned.
POST Request to /checkout_sessions

{
   "items": [
       {
           "id": "item_456",
           "quantity": 1
       }
   ],
   "fulfillment_address": {
       "name": "test",
       "line_one": "1234 Chat Road",
       "line_two": "Apt 101",
       "city": "San Francisco",
       "state": "CA",
       "country": "US",
       "postal_code": "94131"
   }
}
Response

{
   "id": "checkout_session_123",
   "payment_provider": {
       "provider": "stripe",
       "supported_payment_methods": ["card"]
   },
   "status": "ready_for_payment",
   "currency": "usd",
   "line_items": [
       {
           "id": "line_item_456",
           "item": {
               "id": "item_456",
               "quantity": 1
           },
           "base_amount": 300,
           "discount": 0,
           "subtotal": 0,
           "tax": 30,
           "total": 330
       }
   ],
   "fulfillment_address": {
       "name": "test",
       "line_one": "1234 Chat Road",
       "line_two": "Apt 101",
       "city": "San Francisco",
       "state": "CA",
       "country": "US",
       "postal_code": "94131"
   },
   "fulfillment_option_id": "fulfillment_option_123",
   "totals": [
       {
           "type": "items_base_amount",
           "display_text": "Item(s) total",
           "amount": 300
       },
       {
           "type": "subtotal",
           "display_text": "Subtotal",
           "amount": 300
       },
       {
           "type": "tax",
           "display_text": "Tax",
           "amount": 30
       },
       {
           "type": "fulfillment",
           "display_text": "Fulfillment",
           "amount": 100
       },
       {
           "type": "total",
           "display_text": "Total",
           "amount": 430
       }
   ],
   "fulfillment_options": [
       {
           "type": "shipping",
           "id": "fulfillment_option_123",
           "title": "Standard",
           "subtitle": "Arrives in 4-5 days",
           "carrier": "USPS",
           "earliest_delivery_time": "2025-10-12T07:20:50.52Z",
           "latest_delivery_time": "2025-10-13T07:20:50.52Z",
           "subtotal": 100,
           "tax": 0,
           "total": 100
       },
       {
           "type": "shipping",
           "id": "fulfillment_option_456",
           "title": "Express",
           "subtitle": "Arrives in 1-2 days",
           "carrier": "USPS",
           "earliest_delivery_time": "2025-10-09T07:20:50.52Z",
           "latest_delivery_time": "2025-10-10T07:20:50.52Z",
           "subtotal": 500,
           "tax": 0,
           "total": 500
       }
   ],
   "messages": [],
   "links": [
       {
           "type": "terms_of_use",
           "url": "https://www.testshop.com/legal/terms-of-use"
       }
   ]
}

POST /checkout_sessions/{checkout_session_id}

Call direction: OpenAI -> Merchant

This endpoint will be called on checkout session updates, such as a change in fulfillment address or fulfillment option. The endpoint should return updated costs, new options (e.g. new fulfillment options based on update in fulfillment address), and any new errors.

Request

FieldTypeRequiredDescriptionValidation
buyerBuyerNoOptional information about the buyer.None
itemsList[Item]NoOptional list of updated items to be purchased.None
fulfillment_addressAddressNoNewly added or updated fulfillment address specified by the customer.None
fulfillment_option_idStringNoId of the fulfillment option specified by the customer.None

Response

FieldTypeRequiredDescriptionValidation
idStringYesUnique id that identifies the checkout session. This id will be used to update the checkout session in subsequent calls.None
buyerBuyerNoBuyer information, if providedNone
statusString enumYesCurrent status of the checkout session. Possible values are: not_ready_for_payment ready_for_payment completed canceledNone
currencyStringYesCurrency code as per the ISO 4217 standardShould follow the ISO 4217 standard in lower case
line_itemsList[LineItem]YesList of items and computed costs.None
fulfillment_addressAddressNoAddress to ship items to.None
fulfillment_optionsList[FulfillmentOption]YesAll available fulfillment options and associated costs.None
fulfillment_option_idStringNoId of the selected fulfillment option.None
totalsList[Total]YesList of totals.None
messagesList[Message]YesList of informational and error messages to be displayed to the customer.None
linksList[Link]YesList of links (e.g. ToS/privacy policy/etc.) to be displayed to the customer.None

Example

Updating the fulfillment option updates the checkout session totals.

POST Request to /checkout_sessions/checkout_session_123

{
   "fulfillment_option_id": "fulfillment_option_456"
}
Response

{
   "id": "checkout_session_123",
   "status": "ready_for_payment",
   "currency": "usd",
   "line_items": [
       {
           "id": "line_item_456",
           "item": {
               "id": "item_456",
               "quantity": 1
           },
           "base_amount": 300,
           "discount": 0,
           "subtotal": 0,
           "tax": 30,
           "total": 330
       }
   ],
   "fulfillment_address": {
       "name": "test",
       "line_one": "1234 Chat Road",
       "line_two": "Apt 101",
       "city": "San Francisco",
       "state": "CA",
       "country": "US",
       "postal_code": "94131"
   },
   "fulfillment_option_id": "fulfillment_option_456",
   "totals": [
       {
           "type": "items_base_amount",
           "display_text": "Item(s) total",
           "amount": 300
       },
       {
           "type": "subtotal",
           "display_text": "Subtotal",
           "amount": 300
       },
       {
           "type": "tax",
           "display_text": "Tax",
           "amount": 30
       },
       {
           "type": "fulfillment",
           "display_text": "Fulfillment",
           "amount": 500
       },
       {
           "type": "total",
           "display_text": "Total",
           "amount": 830
       }
   ],
   "fulfillment_options": [
       {
           "type": "shipping",
           "id": "fulfillment_option_123",
           "title": "Standard",
           "subtitle": "Arrives in 4-5 days",
           "carrier": "USPS",
           "earliest_delivery_time": "2025-10-12T07:20:50.52Z",
           "latest_delivery_time": "2025-10-13T07:20:50.52Z",
           "subtotal": 100,
           "tax": 0,
           "total": 100
       },
       {
           "type": "shipping",
           "id": "fulfillment_option_456",
           "title": "Express",
           "subtitle": "Arrives in 1-2 days",
           "carrier": "USPS",
           "earliest_delivery_time": "2025-10-09T07:20:50.52Z",
           "latest_delivery_time": "2025-10-10T07:20:50.52Z",
           "subtotal": 500,
           "tax": 0,
           "total": 500
       }
   ],
   "messages": [],
   "links": [
       {
           "type": "terms_of_use",
           "url": "https://www.testshop.com/legal/terms-of-use"
       }
   ]
}

POST /checkout_sessions/{checkout_session_id}/complete

Call direction: OpenAI -> Merchant

The endpoint will be called with the payment method to complete the purchase. It is expected that the checkout session will be completed and an order will be created after this call. Any errors that prevent this from happening should be returned in the response.

Request

FieldTypeRequiredDescriptionValidation
buyerBuyerNoOptional information about the buyer.None
payment_dataPaymentDataYesPayment data used to complete the checkout session.None

Response

FieldTypeRequiredDescriptionValidation
idStringYesUnique id that identifies the checkout session. This id will be used to update the checkout session in subsequent calls.None
buyerBuyerYesBuyer informationNone
statusString enumYesCurrent status of the checkout session. Possible values are: not_ready_for_payment ready_for_payment completed canceledNone
currencyStringYesCurrency code as per the ISO 4217 standardShould follow the ISO 4217 standard in lower case
line_itemsList[LineItem]YesList of items and computed costs.None
fulfillment_addressAddressNoAddress to ship items to.None
fulfillment_optionsList[FulfillmentOption]YesAll available fulfillment options and associated costs.None
fulfillment_option_idStringYesId of the selected fulfillment option.None
totalsList[Total]YesList of totals.None
orderOrderYesOrder that is created after the checkout session completes.None
messagesList[Message]YesList of informational and error messages to be displayed to the customer.None
linksList[Link]YesList of links (e.g. ToS/privacy policy/etc.) to be displayed to the customer.None

Example

Completing the checkout session with an encrypted payload representing the payment method.

POST Request to /checkout_sessions/checkout_session_123/complete

{
   "buyer": {
       "first_name": "John",
       "last_name": "Smith",
       "email": "johnsmith@mail.com",
       "phone_number": "15552003434"
   },
   "payment_data": {
       "token": "spt_123",
       "provider": "stripe",
       "billing_address": {
           "name": "test",
           "line_one": "1234 Chat Road",
           "line_two": "Apt 101",
           "city": "San Francisco",
           "state": "CA",
           "country": "US",
           "postal_code": "94131"
       }
   }
}
Response

{
   "id": "checkout_session_123",
   "buyer": {
       "first_name": "John",
       "last_name": "Smith",
       "email": "johnsmith@mail.com",
       "phone_number": "15552003434"
   },
   "status": "completed",
   "currency": "usd",
   "line_items": [
       {
           "id": "line_item_456",
           "item": {
               "id": "item_456",
               "quantity": 1
           },
           "base_amount": 300,
           "discount": 0,
           "subtotal": 300,
           "tax": 30,
           "total": 330
       }
   ],
   "fulfillment_address": {
       "name": "test",
       "line_one": "1234 Chat Road",
       "line_two": "Apt 101",
       "city": "San Francisco",
       "state": "CA",
       "country": "US",
       "postal_code": "94131"
   },
   "fulfillment_option_id": "fulfillment_option_123",
   "totals": [
       {
           "type": "items_base_amount",
           "display_text": "Item(s) total",
           "amount": 300
       },
       {
           "type": "subtotal",
           "display_text": "Subtotal",
           "amount": 300
       },
       {
           "type": "tax",
           "display_text": "Tax",
           "amount": 30
       },
       {
           "type": "fulfillment",
           "display_text": "Fulfillment",
           "Amount": 100
       },
       {
           "type": "total",
           "display_text": "Total",
           "amount": 430
       }
   ],
   "fulfillment_options": [
       {
           "type": "shipping",
           "id": "fulfillment_option_123",
           "title": "Standard",
           "subtitle": "Arrives in 4-5 days",
           "carrier": "USPS",
           "earliest_delivery_time": "2025-10-12T07:20:50.52Z",
           "latest_delivery_time": "2025-10-13T07:20:50.52Z",
           "subtotal": 100,
           "tax": 0,
           "total": 100
       },
       {
           "type": "shipping",
           "id": "fulfillment_option_456",
           "title": "Express",
           "subtitle": "Arrives in 1-2 days",
           "carrier": "USPS",
           "earliest_delivery_time": "2025-10-09T07:20:50.52Z",
           "latest_delivery_time": "2025-10-10T07:20:50.52Z",
           "subtotal": 500,
           "tax": 0,
           "total": 500
       }
   ],
   "messages": [],
   "links": [
       {
           "type": "terms_of_use",
           "url": "https://www.testshop.com/legal/terms-of-use"
       }
   ]
}

POST /checkout_sessions/{checkout_session_id}/cancel

This endpoint will be used to cancel a checkout session, if it can be canceled. If the checkout session cannot be canceled (e.g. if the checkout session is already canceled or completed), then the server should send back a response with status 405. Any checkout session with a status that is not equal to completed or canceled should be cancelable.

Request

None

Response

FieldTypeRequiredDescriptionValidation
idStringYesUnique id that identifies the checkout session. This id will be used to update the checkout session in subsequent calls.None
buyerBuyerNoBuyer information, if providedNone
statusString enumYesCurrent status of the checkout session. Possible values are: not_ready_for_payment ready_for_payment completed canceledNone
currencyStringYesCurrency code as per the ISO 4217 standardShould follow the ISO 4217 standard in lower case
line_itemsList[LineItem]YesList of items and computed costs.None
fulfillment_addressAddressNoAddress to ship items to.None
fulfillment_optionsList[FulfillmentOption]YesAll available fulfillment options and associated costs.None
fulfillment_option_idStringNoId of the selected fulfillment option.None
totalsList[Total]YesList of totals.None
messagesList[Message]YesList of informational and error messages to be displayed to the customer.None
linksList[Link]YesList of links (e.g. ToS/privacy policy/etc.) to be displayed to the customer.None

GET /checkout_sessions/{checkout_session_id}

This endpoint is used to return update to date information about the checkout session. If the checkout session is not found, then the server should return a response with status 404.

Request

None

Response

FieldTypeRequiredDescriptionValidation
idStringYesUnique id that identifies the checkout session. This id will be used to update the checkout session in subsequent calls.None
buyerBuyerNoBuyer information, if providedNone
statusString enumYesCurrent status of the checkout session. Possible values are: not_ready_for_payment ready_for_payment completed canceledNone
currencyStringYesCurrency code as per the ISO 4217 standardShould follow the ISO 4217 standard in lower case
line_itemsList[LineItem]YesList of items and computed costs.None
fulfillment_addressAddressNoAddress to ship items to.None
fulfillment_optionsList[FulfillmentOption]YesAll available fulfillment options and associated costs.None
fulfillment_option_idStringNoId of the selected fulfillment option.None
totalsList[Total]YesList of totals.None
messagesList[Message]YesList of informational and error messages to be displayed to the customer.None
linksList[Link]YesList of links (e.g. ToS/privacy policy/etc.) to be displayed to the customer.None

Response Errors

If the server is unable to return a 201 response, then it should return an error of the following shape with a 4xx/5xx status.

Error

FieldTypeRequiredDescription
typeString enumYesError type. Possible values are: invalid_request
codeString enumYesError code. Possible values are: request_not_idempotent
messageStringYesHuman‑readable description of the error.
paramStringNoJSONPath referring to the offending request body field, if applicable.

Object definitions

Item

FieldTypeRequiredDescriptionExample ValueValidation
idstringYesId of a piece of merchandise that can be purchased“itm_123”None
quantityintYesQuantity of the item for fulfillment1Should be a positive integer greater than 0.

Address

FieldTypeRequiredDescriptionValidation
nameStringYesName of the person to whom the items are shippedMax. length is 256
line_oneStringYesFirst line of addressMax. length is 60
line_twoStringNoOptional second line of addressMax. length is 60
cityStringYesAddress city/district/suburb/town/village.Max. length is 60
stateStringYesAddress state/county/province/region.Should follow the ISO 3166-1 standard
countryStringYesAddress countryShould follow the ISO 3166-1 standard
postal_codeStringYesAddress postal code or zip codeMax. length is 20
phone_numberStringNoOptional phone numberFollows the E.164 standard

PaymentProvider

FieldTypeRequiredDescriptionValidation
providerString enumYesString value representing payment processor. Possible values are: stripeNone
supported_payment_methodsList[String enum]YesList of payment methods that the merchant is willing to accept. Possible values are: cardNone

Message (type = info)

FieldTypeRequiredDescriptionValidation
typeStringYesString value representing the type of message. For an informational message, the type should be info.None
paramStringYesRFC 9535 JSONPath to the component of the checkout session that the message is referring to. For instance, if the message is referring to the second line item, the path would be $.line_items[1].None
content_typeString enumYesType of the message content for rendering purposes. Possible values are: plain markdownNone
contentStringYesRaw message content.None

Message (type = error)

FieldTypeRequiredDescriptionValidation
typeStringYesString value representing the type of message. For an error message, the type should be error.None
codeString enumYesError code. Possible values are: missing invalid out_of_stock payment_declined requires_sign_in requires_3dsNone
paramStringNoRFC 9535 JSONPath to the component of the checkout session that the message is referring to. For instance, if the message is referring to the second line item, the path would be $.line_items[1].None
content_typeString enumYesType of the message content for rendering purposes. Possible values are: plain markdownNone
contentStringYesRaw message content.None
FieldTypeRequiredDescriptionValidation
typeEnum(String)YesType of the link. Possible values are: terms_of_use privacy_policy seller_shop_policiesNone
valueStringYesLink content specified as a URL.None

Buyer

FieldTypeRequiredDescriptionValidation
first_nameStringYesFirst name of buyer.Max. length is 256
emailStringYesEmail address of buyer to be used for communication.Max. length is 256
phone_numberStringNoOptional phone number of the buyer.Follows the E.164 standard

Line Item

FieldTypeRequiredDescriptionValidation
idStringYesId of the line item. This is different from the id of the item - two line items representing the same item will have different line item ids.None
itemItemYesItem that is represented by the line item.None
base_amountintYesInteger representing item base amount before adjustments.Should be >= 0
discountintYesInteger representing any discount applied to the item.Should be >= 0
subtotalintYesInteger representing amount after all adjustments.Should sum up to base_amount - discount Should be >= 0
taxintYesInteger representing tax amount.Should be >= 0
totalintYesInteger representing total amount.Should sum up to base_amount - discount + tax Should be >= 0

Total

FieldTypeRequiredDescriptionValidation
typeString enumYesString value representing the type of total. Possible values are: items_base_amount items_discount subtotal discount fulfillment tax fee totalNone
display_textStringYesThe text displayed to the customer for this total.None
amountintYesInteger representing total amount in minor units.If type == subtotal, should sum to items_base_amount - items_discount If type == total, should sum to items_base_amount - items_discount - discount + fulfillment + tax + fee Should be >= 0

FulfillmentOption (type = shipping)

FieldTypeRequiredDescriptionValidation
typeStringYesString value representing the type of fulfillment option. For a shipping option, the value should be shipping.None
idStringYesUnique ID that represents the shipping option. Unique across all fulfillment options.Unique across all fulfillment options.
titleStringYesTitle of the shipping option to display to the customer.None
subtitleStringYesText content describing the estimated timeline for shipping to display to the customer.None
carrier_infoStringYesName of the shipping carrier.None
earliest_delivery_timeStringYesEstimated earliest delivery time, formatted as an RFC 3339 string.Formatted as an RFC 3339 string.
latest_deliver y_timeStringYesEstimated latest delivery time, formatted as an RFC 3339 string.Formatted as an RFC 3339 string.
subtotalintYesInteger subtotal cost of the shipping option, formatted as a string.Should be >= 0
taxintYesInteger representing tax amount.Should be >= 0
totalintYesInteger total cost of the shipping option, formatted as a string.Should sum to subtotal + tax

FulfillmentOption (type = digital)

FieldTypeRequiredDescriptionValidation
typeStringYesString value representing the type of fulfillment option. For a digital option, the value should be digital.None
idStringYesUnique ID that represents the digital option. Unique across all fulfillment options.Unique across all fulfillment options.
titleStringYesTitle of the digital option to display to the customer.None
subtitleStringNoText content describing how the item will be digitally delivered to the customer.None
subtotalintYesInteger subtotal cost of the digital option, formatted as a string.Should be >= 0
taxintYesInteger representing tax amount.Should be >= 0
totalintYesInteger total cost of the digital option, formatted as a string.Should sum to subtotal + tax

PaymentData

FieldTypeRequiredDescriptionValidation
tokenStringYesToken that represents the payment method.None
providerString enumYesString value representing the payment processor. Possible values are: stripeNone
billing_addressAddressNoOptional billing address associated with the payment methodNone

Order

FieldTypeRequiredDescriptionValidation
idStringYesUnique id that identifies the order that is created after completing the checkout session.None
checkout_session_idStringYesId that identifies the checkout session that created this orderNone
permalink_urlStringYesURL that points to the order. Customers should be able to visit this URL and provide at most their email address to view order details.None

Webhooks

The merchant sends OpenAI webhook events on order creation and update events. These events ensure that the buyer’s view stays in sync. The webhook events will be sent with a HMAC signature sent as a request header (i.e. Merchant_Name-Signature) that is created using the webhook payload and signed using a key provided by OpenAI.

Webhook Event

FieldTypeRequiredDescriptionValidation
typeString enumYesString representing the type of event. Possible values are: order_created order_updatedNone
dataEventDataYesWebhook event data. See EventData for more information.None

EventData (type = order)

FieldTypeRequiredDescriptionValidation
typeStringYesString value representing the type of event data. For order data, the value should be orderNone
checkout_session_idStringYesID that identifies the checkout session that created this order.None
permalink_urlStringYesURL that points to the order. Customers should be able to visit this URL and provide at most their email address to view order details.None
statusString enumYesString representing the latest status of the order. Possible values are: created manual_review confirmed canceled shipped fulfilledNone
refundsList[Refund]YesList of refunds that have been issued for the order.None

Refund

FieldTypeRequiredDescriptionValidation
typeString enumYesString representing the type of refund. Possible values are: store_credit original_paymentNone
amountintegerYesInteger representing total amount of money refunded.Should be >= 0