Updated API from documentation release

Author: ct-sdks[bot]

api-specs/api/examples/RecurringOrder/RecurringOrderSetExpiresAtAction.json

@@ -0,0 +1,4 @@
+{
+  "action": "setExpiresAt",
+  "expiresAt": "2025-10-15T15:00:00.000Z"
+}

api-specs/api/resources/recurring-orders.raml

@@ -35,10 +35,11 @@ post:
     - conflicting
   description: |
     Creates a Recurring Order in the Project.
-    The Cart is validated to ensure that it is convertible to an [Order](ctp:api:type:Order). If validation fails, an error is returned.
-
     Produces the [RecurringOrderCreated](ctp:api:type:RecurringOrderCreatedMessage) message.
 
+    The Cart is validated to ensure that it is convertible to an [Order](ctp:api:type:Order). If the validation fails, an error is returned.
+    If the expiration date has been reached when the [Recurring Order](ctp:api:type:RecurringOrder) is processed, its [RecurringOrderState](ctp:api:type:RecurringOrderState) will be updated to `Expired`, and no Order will be created.
+
     If a server-side problem occurs, indicated by a 500 Internal Server Error HTTP response, the Recurring Order creation may still successfully complete after the error is returned.
     If you receive this error, you should verify the status of the Recurring Order by querying a unique identifier supplied during the creation request, such as the key.
   body:

api-specs/api/types/message/RecurringOrderExpiresAtSetMessage.raml

@@ -0,0 +1,17 @@
+#%RAML 1.0 DataType
+(package): Message
+type: Message
+(beta): true
+displayName: RecurringOrderExpiresAtSetMessage
+discriminatorValue: RecurringOrderExpiresAtSet
+description: |
+  Generated after a successful [Set Expires At](ctp:api:type:RecurringOrderSetExpiresAtAction) update action.
+properties:
+  newExpiresAt:
+    type: datetime
+    description: |
+      Expiration date and time of the Recurring Order after the [Set Expires At](ctp:api:type:RecurringOrderSetExpiresAtAction) update action.
+  oldExpiresAt:
+    type: datetime
+    description: |
+      Expiration date and time of the Recurring Order before the [Set Expires At](ctp:api:type:RecurringOrderSetExpiresAtAction) update action.

api-specs/api/types/message/payload/RecurringOrderExpiresAtSetMessagePayload.raml

@@ -0,0 +1,17 @@
+#%RAML 1.0 DataType
+(package): Message
+type: MessagePayload
+(beta): true
+displayName: RecurringOrderExpiresAtSetMessagePayload
+discriminatorValue: RecurringOrderExpiresAtSet
+description: |
+  Generated after a successful [Set Expires At](ctp:api:type:RecurringOrderSetExpiresAtAction) update action.
+properties:
+  newExpiresAt:
+    type: datetime
+    description: |
+      Expiration date and time of the Recurring Order after the [Set Expires At](ctp:api:type:RecurringOrderSetExpiresAtAction) update action.
+  oldExpiresAt:
+    type: datetime
+    description: |
+      Expiration date and time of the Recurring Order before the [Set Expires At](ctp:api:type:RecurringOrderSetExpiresAtAction) update action.

api-specs/api/types/recurring-order/RecurringOrderDraft.raml

@@ -26,6 +26,10 @@ properties:
     type: datetime
     description: |
       Date and time (UTC) when the RecurringOrder will start.
+  expiresAt?:
+    type: datetime
+    description: |
+      Date and time (UTC) when the RecurringOrder will expire.
   state?:
     type: StateResourceIdentifier
     description: |

api-specs/api/types/recurring-order/updates/RecurringOrderSetExpiresAtAction.raml

@@ -0,0 +1,16 @@
+#%RAML 1.0 DataType
+(package): RecurringOrder
+type: RecurringOrderUpdateAction
+displayName: RecurringOrderSetExpiresAtAction
+(beta): true
+discriminatorValue: setExpiresAt
+example: !include ../../../examples/RecurringOrder/RecurringOrderSetExpiresAtAction.json
+description: |
+  Setting the expiration date and time generates the [RecurringOrderExpiresAtSet](ctp:api:type:RecurringOrderExpiresAtSetMessage) Message.
+properties:
+  expiresAt?:
+    type: datetime
+    description: |
+      Date and time (UTC) the Recurring Order should expire. If empty, any existing value will be removed.
+
+      If the date or time is extended or removed when the [RecurringOrderState](ctp:api:type:RecurringOrderState) is `Expired`, the state will be updated to `Active`.

api-specs/api/types/recurring-order/updates/RecurringOrderSetOrderSkipConfigurationAction.raml

@@ -13,4 +13,4 @@ properties:
   updatedExpiresAt?:
     type: datetime
     description: |
-      Date and time (UTC) the Recurring Order will resume and start to generate new orders.
+      Date and time (UTC) the Recurring Order will expire and stop generating new orders.

api-specs/api/types/types.raml

@@ -1154,6 +1154,7 @@ RecurringOrderCustomFieldRemovedMessage: !include message/RecurringOrderCustomFi
 RecurringOrderCustomTypeRemovedMessage: !include message/RecurringOrderCustomTypeRemovedMessage.raml
 RecurringOrderCustomTypeSetMessage: !include message/RecurringOrderCustomTypeSetMessage.raml
 RecurringOrderDeletedMessage: !include message/RecurringOrderDeletedMessage.raml
+RecurringOrderExpiresAtSetMessage: !include message/RecurringOrderExpiresAtSetMessage.raml
 RecurringOrderKeySetMessage: !include message/RecurringOrderKeySetMessage.raml
 RecurringOrderScheduleSetMessage: !include message/RecurringOrderScheduleSetMessage.raml
 RecurringOrderStartsAtSetMessage: !include message/RecurringOrderStartsAtSetMessage.raml
@@ -1492,6 +1493,7 @@ RecurringOrderCustomFieldRemovedMessagePayload: !include message/payload/Recurri
 RecurringOrderCustomTypeRemovedMessagePayload: !include message/payload/RecurringOrderCustomTypeRemovedMessagePayload.raml
 RecurringOrderCustomTypeSetMessagePayload: !include message/payload/RecurringOrderCustomTypeSetMessagePayload.raml
 RecurringOrderDeletedMessagePayload: !include message/payload/RecurringOrderDeletedMessagePayload.raml
+RecurringOrderExpiresAtSetMessagePayload: !include message/payload/RecurringOrderExpiresAtSetMessagePayload.raml
 RecurringOrderKeySetMessagePayload: !include message/payload/RecurringOrderKeySetMessagePayload.raml
 RecurringOrderScheduleSetMessagePayload: !include message/payload/RecurringOrderScheduleSetMessagePayload.raml
 RecurringOrderStartsAtSetMessagePayload: !include message/payload/RecurringOrderStartsAtSetMessagePayload.raml
@@ -2255,6 +2257,7 @@ SkipConfiguration: !include recurring-order/SkipConfiguration.raml
 SkipConfigurationDraft: !include recurring-order/SkipConfigurationDraft.raml
 RecurringOrderSetCustomFieldAction: !include recurring-order/updates/RecurringOrderSetCustomFieldAction.raml
 RecurringOrderSetCustomTypeAction: !include recurring-order/updates/RecurringOrderSetCustomTypeAction.raml
+RecurringOrderSetExpiresAtAction: !include recurring-order/updates/RecurringOrderSetExpiresAtAction.raml
 RecurringOrderSetKeyAction: !include recurring-order/updates/RecurringOrderSetKeyAction.raml
 # yamllint disable-line rule:line-length
 RecurringOrderSetOrderSkipConfigurationAction: !include recurring-order/updates/RecurringOrderSetOrderSkipConfigurationAction.raml

api-specs/graphql/schema.sdl

@@ -10872,6 +10872,12 @@ input RecurringOrderExpiredInput {
   dummy: String
 }
 
+type RecurringOrderExpiresAtSet implements MessagePayload {
+  newExpiresAt: DateTime
+  oldExpiresAt: DateTime
+  type: String!
+}
+
 type RecurringOrderKeySet implements MessagePayload {
   key: String
   oldKey: String
@@ -10935,6 +10941,7 @@ type RecurringOrderStateTransition implements MessagePayload {
 }
 
 input RecurringOrderUpdateAction {
+  setExpiresAt: SetRecurringOrderExpiresAt
   setKey: SetRecurringOrderKey
   setOrderSkipConfiguration: SetRecurringOrderOrderSkipConfiguration
   setCustomField: SetRecurringOrderCustomField
@@ -13430,6 +13437,10 @@ input SetRecurringOrderCustomType {
   typeId: String
 }
 
+input SetRecurringOrderExpiresAt {
+  expiresAt: DateTime
+}
+
 input SetRecurringOrderKey {
   key: String
 }