Changelog

Adds the External Payment Gateway endpoints to the Checkout Admin API. These endpoints allow developers to integrate payment gateways not supported by Bold in their store checkout.

Bold Checkout now supports users of both Adobe Commerce (formerly known as Magento 2) and Magento Open Source.

To support the recent introduction of our Subscription Adjustment API, several improvements have been made to the Future Order endpoints of Subscriptions.

Developers now have the ability to add line items to future orders as one-time or ongoing modifications, or on a customized schedule of their own.

New endpoints for managing Subscription Adjustments:

1. Create Subscription Adjustments
2. List Subscription Adjustments
3. Delete Subscription Adjustments
4. Get Subscription Adjustment by ID
5. Delete Subscription Adjustment by ID

Additional Documentation​

For more information and examples of subscription adjustments, see our Create Subscription Adjustments specification.

Adds the Remote State Authority API. This API enables platform developers to fully control the state of orders during checkout by interfacing directly with the platform.

The tax zone settings endpoints are now a sub-route of zones. Refer to Checkout Admin.

Adds support for reading, updating, and deleting warehouses using the Checkout Admin API. The warehouse routes are now sub-routes of the zone routes. The route for Create Warehouse has been modified to this effect.

Adds support for reading, updating, and deleting zones using the Checkout Admin API.

When updating a Subscription Line Item, the price field is now optional.

Adds 3 new endpoints to independently sync products, customers, and orders from a platform connector on behalf of a shop into Bold.

Adds support for configuring tax zone settings using the Checkout Admin API.

Adds various features and improvements to Bold gift card functionality, including better formatting of data in Bold Checkout admin, support for setting gift card recipient data through the API, and a new endpoint to query for a gift card balance.

Refer to Manage Gift Cards for more information about gift cards.

Adds the List Selection Options endpoint, which retrieves some or all selection options for the active subscription groups on a given store.

Zones (tax, shipping, and warehouse) and warehouses can be created using the Checkout Admin API.

Adds the Create Order endpoint.

The Handle Amendment endpoint directs Bold Checkout to recalculate the outstanding balance of the order compared to what was authorized in the Pre-Process Order endpoint and attempt to add an additional payment if required.

Callbacks to webhooks registered using the Create Webhook Subscription endpoint now contain a header called Event-Actor-Type. This header indicates the type of user that triggered the webhook event.

Adds the description of how to include orders with gift cards to: Initialize Order, Create Order and Add List Item endpoints. Also allows the gift card properties to be shown in the application state returned from most Checkout Frontend and Backend endpoints

A new webhook topic is now available for subscription line items added. Add this webhook via the Create Webhook Subscription endpoint.

The subscriptions shipping_address and billing_address objects now contain a field called deleted_at.

The subscription now contains a field called order_count. This field gives the current count of orders created for a subscription.

The code of shipping method for the order. Each store defines its own shipping codes.

Adds the Create Line Items endpoint.

The application_state now contains a field called is_processed. This field indicates whether the order has been processed.

Adds new property source in discount objects in the Checkout Frontend API to identify the source of the discount code.

Adds the flow_id field to the application state returned from most Checkout Frontend and Backend endpoints.

Adds a new Verification endpoint to the Platform Connector API Specification.

Adds the Platform Connector: Integration Configurations API. This API enables Platform Connector developers to register their connector's destinations via API.

Adds the Cancel Order endpoint.

Adds Bold Checkout's order_id to the application state.

Adds a series of endpoints to create, update, and delete API overrides.

Adds the Update Line Item Prepaid Metadata endpoint.

Adds the Create Line Item Attributes endpoint.

Adds a plugin_event_failed failure code to the possible list of last failure codes in the Subscription entity of the Subscriptions API.

Adds the Create Line Item Prepaid Metadata endpoint to the Subscriptions API. This allows API users to convert subscriptions to prepaid.

Removes the placed_at attribute from the Platform Connector: Create Order request body.

Adds the address_use field to address objects in the Platform Connector customer endpoints. This field denotes whether an address is for "shipping" or "billing".

Adds the User-Agent header, which is sent with all Platform Connector API calls from Bold.

Adds an optional email query parameter to the List Customers endpoint to filter the results based on that email.

Adds an optional platform_id to the transaction schema in the Platform Connector: Orders API

Adds a few new failure codes to the Subscription entity of the Subscriptions API

Adds three optional fields to the Subscription entity of the Subscriptions API

Adds support for the subscription.discount_code field in the payload of the Create Subscription endpoint of the Subscriptions API.

Adds a new placed_at field to the Subscription entity of the Subscriptions API.

Fees are now included in the application_state. Add fees can be added to orders by using the add_fee plugin action.

The Remove Gift Card Payment endpoint removes a gift card payment from an order.

Add an order_note field to the Subscriptions object. This feature ensures that the customer order note added at the time of the initial order is carried through to recurring orders and that it can be updated via the API.

The Pre-Process Order endpoint allows Bold Checkout to complete full order validation and payment authorization, without actually processing the order.

Add the cart_customer_id field to the response body of the Initialize Order endpoint.

To support the recent introduction of our Subscription Adjustment API, several improvements have been made to the Future Order endpoints of Subscriptions.

Adds the External Payment Gateway endpoints to the Checkout Admin API. These endpoints allow developers to integrate payment gateways not supported by Bold in their store checkout.

Bold Checkout now supports users of both Adobe Commerce (formerly known as Magento 2) and Magento Open Source.

Adds the Remote State Authority API. This API enables platform developers to fully control the state of orders during checkout by interfacing directly with the platform.

The tax zone settings endpoints are now a sub-route of zones. Refer to Checkout Admin.

Adds support for reading, updating, and deleting warehouses using the Checkout Admin API. The warehouse routes are now sub-routes of the zone routes. The route for Create Warehouse has been modified to this effect.

Adds support for reading, updating, and deleting zones using the Checkout Admin API.

When updating a Subscription Line Item, the price field is now optional.

Adds 3 new endpoints to independently sync products, customers, and orders from a platform connector on behalf of a shop into Bold.

Adds support for configuring tax zone settings using the Checkout Admin API.

Adds various features and improvements to Bold gift card functionality, including better formatting of data in Bold Checkout admin, support for setting gift card recipient data through the API, and a new endpoint to query for a gift card balance.

Refer to Manage Gift Cards for more information about gift cards.

Adds the List Selection Options endpoint, which retrieves some or all selection options for the active subscription groups on a given store.

Zones (tax, shipping, and warehouse) and warehouses can be created using the Checkout Admin API.

Adds the Create Order endpoint.

The Handle Amendment endpoint directs Bold Checkout to recalculate the outstanding balance of the order compared to what was authorized in the Pre-Process Order endpoint and attempt to add an additional payment if required.

Callbacks to webhooks registered using the Create Webhook Subscription endpoint now contain a header called Event-Actor-Type. This header indicates the type of user that triggered the webhook event.

Adds the description of how to include orders with gift cards to: Initialize Order, Create Order and Add List Item endpoints. Also allows the gift card properties to be shown in the application state returned from most Checkout Frontend and Backend endpoints

A new webhook topic is now available for subscription line items added. Add this webhook via the Create Webhook Subscription endpoint.

The subscriptions shipping_address and billing_address objects now contain a field called deleted_at.

The subscription now contains a field called order_count. This field gives the current count of orders created for a subscription.

The code of shipping method for the order. Each store defines its own shipping codes.

Adds the Create Line Items endpoint.

The application_state now contains a field called is_processed. This field indicates whether the order has been processed.

Adds new property source in discount objects in the Checkout Frontend API to identify the source of the discount code.

Adds the flow_id field to the application state returned from most Checkout Frontend and Backend endpoints.

Adds a new Verification endpoint to the Platform Connector API Specification.

Adds the Platform Connector: Integration Configurations API. This API enables Platform Connector developers to register their connector's destinations via API.

Adds the Cancel Order endpoint.

Adds Bold Checkout's order_id to the application state.

Adds a series of endpoints to create, update, and delete API overrides.

Adds the Update Line Item Prepaid Metadata endpoint.

Adds the Create Line Item Attributes endpoint.

Adds a plugin_event_failed failure code to the possible list of last failure codes in the Subscription entity of the Subscriptions API.

Adds the Create Line Item Prepaid Metadata endpoint to the Subscriptions API. This allows API users to convert subscriptions to prepaid.

Removes the placed_at attribute from the Platform Connector: Create Order request body.

Adds the address_use field to address objects in the Platform Connector customer endpoints. This field denotes whether an address is for "shipping" or "billing".

Adds the User-Agent header, which is sent with all Platform Connector API calls from Bold.

Adds an optional email query parameter to the List Customers endpoint to filter the results based on that email.

Adds an optional platform_id to the transaction schema in the Platform Connector: Orders API

Adds a few new failure codes to the Subscription entity of the Subscriptions API

Adds three optional fields to the Subscription entity of the Subscriptions API

Adds support for the subscription.discount_code field in the payload of the Create Subscription endpoint of the Subscriptions API.

Adds a new placed_at field to the Subscription entity of the Subscriptions API.

Fees are now included in the application_state. Add fees can be added to orders by using the add_fee plugin action.

The Remove Gift Card Payment endpoint removes a gift card payment from an order.

Add an order_note field to the Subscriptions object. This feature ensures that the customer order note added at the time of the initial order is carried through to recurring orders and that it can be updated via the API.

The Pre-Process Order endpoint allows Bold Checkout to complete full order validation and payment authorization, without actually processing the order.

Add the cart_customer_id field to the response body of the Initialize Order endpoint.