Changelog

Subscription Groups support Dynamic Discount rules.

Developers now have the ability to configure automatic product conversions when subscriptions are created from checkout.

The Subscriptions API now supports a new type of adjustment action - apply price to a line item.

Bold renamed the Payment Isolation Gateway Interface (PIGI) to Secure Payments Interface (SPI) for increased clarity.

Adds the Authorize Payments endpoint to the Checkout Backend API. This endpoint enables a merchant to authorize a payment from their backend application.

Adds the Update Platform Customer Creation Setting endpoint in the Checkout Admin API.

Adds the Update Inventory Check Requirement endpoint in the Checkout Admin API.

Adds several shop payment styling endpoints that can be used to style the Payment Isolation Gateway Interface for all orders on a given store.

The Customers API now returns only the first 50 addresses associated with a customer. Previously, there was no limit on address retrieval.

Adds a new LiFE element location (paypal_additional_information) that can be used with the PayPal Checkout Flow. You can use the paypal_additional_information anchor location to create an Additional information page that contains your desired element.

Bold now sends bold_order_id in Auth requests from the External Payment Gateway Connector.

Adds the Update Phone Number Requirement endpoint to the Checkout Admin API.

Adds the optional include_all_apps query parameter to the Get Ruleset by External ID endpoint.

Bold now sends customer_data in the External Payment Gateway Connector API Auth Request.

The Checkout Frontend API now includes the Estimate Taxes and Estimate Shipping Line endpoints. These endpoints provide the estimated tax and shipping line for a given shipping address (which may be partial or complete).

Adds several endpoints to support wallet pay in the Checkout Frontend API. These endpoints enable Bold to communicate with the wallet pay provider in order to properly create and capture orders.

The discounts field is the list of discounts for an order. It is a list which contains the applied discounts to the order with details about the each discount.

Create Payment Gateway Order allows merchants to directly create an order on a payment gateway.

The Checkout Frontend API now includes wallet_pay_type in payment objects to indicate if the payment was created by a wallet/express payment provider.

A new optional field has been added to the Initialize Order and Create Order endpoints.

This will be used to track order completion rates. For more information, refer to Configure Checkout Flow Metrics.

The platform_friendly_id field is a unique identifier for the order on the platform. This field is used to identify the order on the platform and is used by the Bold Checkout Admin to link the order to the platform. Please note platform_id should be used only for the internal identifier of the order on the platform.

In the External Payment Gateway Connector API, the tax_total field in the Auth request payload now includes total shipping taxes (where applicable) on the order. The initial value only contained total product taxes.

Refer to the specifications for more information:

• External Payment Gateway Connector API: Auth request

Adds the following new features for Lightweight Frontend Experience (LiFE) elements:

• New dropdown and datepicker types of LiFE element.
• New locations on the checkout and thank you page.
• Support regular expression for text and textarea elements.

Adds new endpoints that allow a merchant to capture and refund payments, specified by a payment identifier.

Refer to the specifications for more information:

• Capture Specific Payment
• Refund a Specific Payment for an Arbitrary Amount.

You can now use a plugin action to set the displayed currency and/or exchange rate on the order. These values are added to the order's application state.

For more information please see the set_display_currency plugin action.

External payment gateways now use a div with an identifier matching the payment gateway's public_id, and the location field to place the div in the checkout frontend.

External payment gateways also now support setting HTTP headers on requests to the base_url.

Adds self-service support for managing the domains that are permitted to call the Bold Checkout APIs. You can add a domain to the Cross-Origin Resource Sharing (CORS) allowlist using the Add Domain to CORS Allowlist endpoint.

Adds batch processing support for select Checkout Frontend endpoints.

The Checkout Admin API now includes two endpoints, List Saved Payment Methods and Delete Saved Payment Method, to manage customers' saved payment methods.

During the checkout process, the plugin event payments_preauthorized can now be sent to plugins after the payment preauthorization step.

For products configured on the platform in multiple languages, product data now includes localization data in those languages for use by API consumers.

Taxes must be calculated on an order before the order is processed. Bold Checkout added internal validation to strongly enforce this requirement.

Adds the ability to add, edit, and delete Checkout Lightweight Frontend Experience (LiFE) Elements.

Adds the Get PMMC Session endpoint to the Checkout Admin API.

Developers can now update line item quantity in future orders as one-time or ongoing modifications, or on a customized schedule of their own.

Adds a new public_order_id field to the Shop General Settings entity of the Checkout Admin API.

The List Selection Options endpoint now uses the optional latest query parameter to return the latest subscription group that a product was added to.

The Inventory, Shipping, and Tax Overrides now contain the note_attributes and cart_params from the Order metadata.

The Get Payment Method endpoint now returns additional information, such as customer's name and billing address, when this data is available.

Adds the Uninstall Integration endpoint to the Shops API. This endpoint allows an API consumer (typically an integration developer) to uninstall an integration for a shop by using the same token issued during its installation.

For Subscriptions endpoints, the new out_of_stock_product error code is now available in the last_failure_code field when a recurrence order cannot be placed due to missing products on stock.

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.

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.

Subscription Groups support Dynamic Discount rules.

Developers now have the ability to configure automatic product conversions when subscriptions are created from checkout.

The Subscriptions API now supports a new type of adjustment action - apply price to a line item.

Bold renamed the Payment Isolation Gateway Interface (PIGI) to Secure Payments Interface (SPI) for increased clarity.

Adds the Authorize Payments endpoint to the Checkout Backend API. This endpoint enables a merchant to authorize a payment from their backend application.

Adds the Update Platform Customer Creation Setting endpoint in the Checkout Admin API.

Adds the Update Inventory Check Requirement endpoint in the Checkout Admin API.

Adds several shop payment styling endpoints that can be used to style the Payment Isolation Gateway Interface for all orders on a given store.

The Customers API now returns only the first 50 addresses associated with a customer. Previously, there was no limit on address retrieval.

Adds a new LiFE element location (paypal_additional_information) that can be used with the PayPal Checkout Flow. You can use the paypal_additional_information anchor location to create an Additional information page that contains your desired element.

Bold now sends bold_order_id in Auth requests from the External Payment Gateway Connector.

Adds the Update Phone Number Requirement endpoint to the Checkout Admin API.

Adds the optional include_all_apps query parameter to the Get Ruleset by External ID endpoint.

Bold now sends customer_data in the External Payment Gateway Connector API Auth Request.

The Checkout Frontend API now includes the Estimate Taxes and Estimate Shipping Line endpoints. These endpoints provide the estimated tax and shipping line for a given shipping address (which may be partial or complete).

Adds several endpoints to support wallet pay in the Checkout Frontend API. These endpoints enable Bold to communicate with the wallet pay provider in order to properly create and capture orders.

The discounts field is the list of discounts for an order. It is a list which contains the applied discounts to the order with details about the each discount.

Create Payment Gateway Order allows merchants to directly create an order on a payment gateway.

The Checkout Frontend API now includes wallet_pay_type in payment objects to indicate if the payment was created by a wallet/express payment provider.

A new optional field has been added to the Initialize Order and Create Order endpoints.

This will be used to track order completion rates. For more information, refer to Configure Checkout Flow Metrics.

The platform_friendly_id field is a unique identifier for the order on the platform. This field is used to identify the order on the platform and is used by the Bold Checkout Admin to link the order to the platform. Please note platform_id should be used only for the internal identifier of the order on the platform.

In the External Payment Gateway Connector API, the tax_total field in the Auth request payload now includes total shipping taxes (where applicable) on the order. The initial value only contained total product taxes.

Refer to the specifications for more information:

• External Payment Gateway Connector API: Auth request

Adds the following new features for Lightweight Frontend Experience (LiFE) elements:

• New dropdown and datepicker types of LiFE element.
• New locations on the checkout and thank you page.
• Support regular expression for text and textarea elements.

Adds new endpoints that allow a merchant to capture and refund payments, specified by a payment identifier.

Refer to the specifications for more information:

• Capture Specific Payment
• Refund a Specific Payment for an Arbitrary Amount.

You can now use a plugin action to set the displayed currency and/or exchange rate on the order. These values are added to the order's application state.

For more information please see the set_display_currency plugin action.

Adds self-service support for managing the domains that are permitted to call the Bold Checkout APIs. You can add a domain to the Cross-Origin Resource Sharing (CORS) allowlist using the Add Domain to CORS Allowlist endpoint.

Adds batch processing support for select Checkout Frontend endpoints.

The Checkout Admin API now includes two endpoints, List Saved Payment Methods and Delete Saved Payment Method, to manage customers' saved payment methods.

During the checkout process, the plugin event payments_preauthorized can now be sent to plugins after the payment preauthorization step.

For products configured on the platform in multiple languages, product data now includes localization data in those languages for use by API consumers.

Taxes must be calculated on an order before the order is processed. Bold Checkout added internal validation to strongly enforce this requirement.

Adds the ability to add, edit, and delete Checkout Lightweight Frontend Experience (LiFE) Elements.

Adds the Get PMMC Session endpoint to the Checkout Admin API.

Developers can now update line item quantity in future orders as one-time or ongoing modifications, or on a customized schedule of their own.

Adds a new public_order_id field to the Shop General Settings entity of the Checkout Admin API.

The List Selection Options endpoint now uses the optional latest query parameter to return the latest subscription group that a product was added to.

The Inventory, Shipping, and Tax Overrides now contain the note_attributes and cart_params from the Order metadata.

The Get Payment Method endpoint now returns additional information, such as customer's name and billing address, when this data is available.

Adds the Uninstall Integration endpoint to the Shops API. This endpoint allows an API consumer (typically an integration developer) to uninstall an integration for a shop by using the same token issued during its installation.

For Subscriptions endpoints, the new out_of_stock_product error code is now available in the last_failure_code field when a recurrence order cannot be placed due to missing products on stock.

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.

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.