<!--
{
  "documentType" : "article",
  "framework" : "RetentionMessaging",
  "identifier" : "/documentation/RetentionMessaging/retention-messaging-changelog",
  "metadataVersion" : "0.1.0",
  "role" : "article",
  "title" : "Retention Messaging API changelog"
}
-->

# Retention Messaging API changelog

Learn about new features and updates in the Retention Messaging API.

## Discussion

Use this changelog to learn about feature updates, deprecations, and removals for the Retention Messaging API.

### Server update  — 2026/05/05

Updated recommended domain from `api.storekit.itunes.apple.com` to `api.storekit.apple.com`, and `api.storekit-sandbox.itunes.apple.com` to `api.storekit-sandbox.apple.com`. The previous domains will continue to be supported.

### 1.5 2026/04/27

**New features**

- Added the new property [`billingPlanType`](/documentation/RetentionMessaging/billingPlanType) to [`alternateProduct`](/documentation/RetentionMessaging/alternateProduct) to support monthly subscriptions with 12-month commitments.

### 1.4  2026/03/31

**New features**

- Added [`Configure Realtime URL`](/documentation/RetentionMessaging/Configure-Realtime-URL), [`Get Realtime URL`](/documentation/RetentionMessaging/Get-Realtime-URL), [`Delete Realtime URL`](/documentation/RetentionMessaging/Delete-Realtime-URL), and [`Get Default Message`](/documentation/RetentionMessaging/Get-Default-Message) endpoints.
- Added objects, properties, and types related to the new endpoints, including: [`BulletPoint`](/documentation/RetentionMessaging/BulletPoint), [`bulletPointText`](/documentation/RetentionMessaging/bulletPointText), [`headerPosition`](/documentation/RetentionMessaging/headerPosition), [`imageSize`](/documentation/RetentionMessaging/imageSize), [`realtimeURL`](/documentation/RetentionMessaging/realtimeURL), and [`RealtimeUrlRequest`](/documentation/RetentionMessaging/RealtimeUrlRequest).
- Added [Error codes](/documentation/RetentionMessaging/error-codes) to indicate bad requests and other errors related to the added endpoints.
- Updated [`GetImageListResponseItem`](/documentation/RetentionMessaging/GetImageListResponseItem) and [`Upload Image`](/documentation/RetentionMessaging/Upload-Image) to add support for the `imageSize` parameter.
- Updated [`UploadMessageRequestBody`](/documentation/RetentionMessaging/UploadMessageRequestBody) to add support for the `bulletPoints` and [`headerPosition`](/documentation/RetentionMessaging/headerPosition) parameters.

### 1.3  2025/12/09

**New features**

- The framework now supports the ability to test server response times for real time retention messaging using the [`Initiate Performance Test`](/documentation/RetentionMessaging/Initiate-Performance-Test) and [`Get Performance Test Results`](/documentation/RetentionMessaging/Get-Performance-Test-Results) endpoints.

### 1.2  2025/11/05

**New features**

- Updated the [`RealtimeResponseBody`](/documentation/RetentionMessaging/RealtimeResponseBody) to include the [`advancedCommerceInfo`](/documentation/RetentionMessaging/advancedCommerceInfo) object.

### 1.1  2025/09/04

**New features**

- Updated the [`DecodedRealtimeRequestBody`](/documentation/RetentionMessaging/DecodedRealtimeRequestBody) to include the [`environment`](/documentation/RetentionMessaging/environment) and [`signedDate`](/documentation/RetentionMessaging/signedDate) fields.

### 1.0  2025/07/16

Initial pre-release.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)