src/openapi/customers/SE-customers.yaml

@@ -201,6 +201,29 @@ paths:
                   summary: No product-instances found on token
                   value:
                     productInstances: []
+                getSingleProductInstance:
+                  summary: One product-instance found on token
+                  value:
+                    {
+                      "productInstances": [
+                        {
+                          "productId": 1,
+                          "name": "HTM 90% Korting",
+                          "status": "Active",
+                          "fromInclusive": "2024-11-25T13:25:00+01:00",
+                          "untilInclusive": "2024-12-25T03:59:59+01:00",
+                          "productCategory": {
+                            "productCategoryId": 1,
+                            "name": "Kortingsabonnement"
+                          },
+                          "gboTypeOfProduct": "discount",
+                          "purchasedProductId": 1,
+                          "orderId": "501B17EF-36C4-4039-B92C-6517969B464E",
+                          "orderLineId": "38B17EF-36C4-4039-B92C-4817969B464E",
+                          "contractId": "string"
+                        }
+                      ]
+                    }
 components:
   schemas:
     CustomersResponse:
@@ -571,5 +594,50 @@ components:
               productId:
                 type: integer
                 example: 1
+              name: 
+                type: string
+                example: HTM 90% Korting
+              status:
+                type: string
+                example: Active
+              fromInclusive:
+                type: string
+                format: date-time-offset
+                example: "2024-11-25T13:25:00+01:00"
+              untilInclusive:
+                type: string
+                format: date-time-offset
+                description: >- 
+                  If not present, this product-instance represents a subscription/contract without a real end. If present, it can be either the natural end date or the refund timestamp.
+                example: "2024-12-25T03:59:59+01:00"
+              productCategory:
+                type: object
+                description: The category of the originating HTM product definition
+                properties:
+                  productCategoryId:
+                    type: integer
+                    example: 1
+                  name:
+                    type: string
+                    example: Kortingsabonnement 
+              gboTypeOfProduct:
+                type: string
+                example: discount
+                description: The type of the product instance as GBO defines it
+              purchasedProductId:
+                type: integer
+                example: 1
+              orderId:
+                type: string
+                format: uuid
+                example: 501B17EF-36C4-4039-B92C-6517969B464E
+              orderLineId:
+                type: string
+                format: uuid
+                example: 38B17EF-36C4-4039-B92C-4817969B464E
+              contractId:
+                description: doen? of via purchasedProductId?
+
+