diff --git a/openapi/components/requestBodies/Webhooks/SubscriptionAndSubscriptionPause.yaml b/openapi/components/requestBodies/Webhooks/SubscriptionAndSubscriptionPause.yaml index 8d484be97a..dbdc9e8520 100644 --- a/openapi/components/requestBodies/Webhooks/SubscriptionAndSubscriptionPause.yaml +++ b/openapi/components/requestBodies/Webhooks/SubscriptionAndSubscriptionPause.yaml @@ -9,7 +9,7 @@ content: subscriptionPauseId: type: string description: ID of the subscription pause. - example: ord_pau_01H085J3ZR1WKD120D73D7N4C9 + example: sub_pau_01H085J3ZR1WKD120D73D7N4C9 eventType: type: string description: Type of webhook event. diff --git a/openapi/components/requestBodies/Webhooks/UsageLimitWebhook.yaml b/openapi/components/requestBodies/Webhooks/UsageLimitWebhook.yaml index 6611834b2a..55e2f6fe5c 100644 --- a/openapi/components/requestBodies/Webhooks/UsageLimitWebhook.yaml +++ b/openapi/components/requestBodies/Webhooks/UsageLimitWebhook.yaml @@ -8,8 +8,8 @@ content: example: sub_01HRF27SATGE4Z6PBJE6PD8328 subscriptionItemId: type: string - description: ID of the order item. - example: ord_itm_01GYJPRKHBD6ZYHH897QCJMBS4 + description: ID of the subscription item. + example: sub_01HW2V1Y3A6QPM1NX4WCYHFSRS planId: type: string description: ID of the plan. diff --git a/openapi/components/requestBodies/storefront/PatchOrder.yaml b/openapi/components/requestBodies/storefront/PatchOrder.yaml index 3356afe8e3..5fb6e39c49 100644 --- a/openapi/components/requestBodies/storefront/PatchOrder.yaml +++ b/openapi/components/requestBodies/storefront/PatchOrder.yaml @@ -31,9 +31,9 @@ content: properties: itemId: type: string - description: ID of order item. + description: ID of the subscription item. maxLength: 50 - example: ord_itm_0YV7DENSVGDBW9S71XZNNYYQ0X + example: sub_01HW2V1Y3A6QPM1NX4WCYHFSRS limits: type: [ 'object', 'null' ] description: |- diff --git a/openapi/components/schemas/OneTimeSale.yaml b/openapi/components/schemas/OneTimeSale.yaml index e43a774ae2..f85d026d51 100644 --- a/openapi/components/schemas/OneTimeSale.yaml +++ b/openapi/components/schemas/OneTimeSale.yaml @@ -7,10 +7,10 @@ required: properties: id: type: string - description: ID of the order. + description: ID of the one-time sale. readOnly: true maxLength: 50 - example: pur_01HRF26JK5Y6TEZ9MR014HW27Z + example: ots_01HRF27SATGE4Z6PBJE6PD8328 orderId: type: string description: ID of the order (experimental). diff --git a/openapi/components/schemas/StorefrontOneTimeSale.yaml b/openapi/components/schemas/StorefrontOneTimeSale.yaml index 6a75e96de9..76dd2f3219 100644 --- a/openapi/components/schemas/StorefrontOneTimeSale.yaml +++ b/openapi/components/schemas/StorefrontOneTimeSale.yaml @@ -2,10 +2,10 @@ type: object properties: id: type: string - description: ID of the order. + description: ID of the one-time sale. readOnly: true maxLength: 50 - example: pur_01HRF26JK5Y6TEZ9MR014HW27Z + example: ots_01HRF27SATGE4Z6PBJE6PD8328 orderType: description: |- Specifies the type of order. diff --git a/openapi/components/schemas/SubscriptionCancellation.yaml b/openapi/components/schemas/SubscriptionCancellation.yaml index 388253f5e2..7ef8bc0cb0 100644 --- a/openapi/components/schemas/SubscriptionCancellation.yaml +++ b/openapi/components/schemas/SubscriptionCancellation.yaml @@ -8,7 +8,7 @@ properties: description: ID of the cancellation. readOnly: true maxLength: 50 - example: ord_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV + example: sub_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV subscriptionId: type: string description: ID of the canceled subscription order. diff --git a/openapi/components/schemas/SubscriptionOrOneTimeSaleItem.yaml b/openapi/components/schemas/SubscriptionOrOneTimeSaleItem.yaml index 232c07752d..df55441a99 100644 --- a/openapi/components/schemas/SubscriptionOrOneTimeSaleItem.yaml +++ b/openapi/components/schemas/SubscriptionOrOneTimeSaleItem.yaml @@ -7,7 +7,6 @@ properties: description: ID of the order item. readOnly: true maxLength: 50 - example: ord_itm_0YVJ6172Q2CXW9VP7KJMKHCMMX planId: description: ID of the plan. deprecated: true diff --git a/openapi/components/schemas/SubscriptionPause.yaml b/openapi/components/schemas/SubscriptionPause.yaml index cec39bfd4a..70c9cc39a0 100644 --- a/openapi/components/schemas/SubscriptionPause.yaml +++ b/openapi/components/schemas/SubscriptionPause.yaml @@ -8,7 +8,7 @@ properties: description: ID of the subscription pause. readOnly: true maxLength: 50 - example: ord_pau_01H085J3ZR1WKD120D73D7N4C9 + example: sub_pau_01H085J3ZR1WKD120D73D7N4C9 subscriptionId: type: string description: ID of the paused subscription. diff --git a/openapi/components/schemas/SubscriptionReactivation.yaml b/openapi/components/schemas/SubscriptionReactivation.yaml index e5e0c807bb..f47dbc3262 100644 --- a/openapi/components/schemas/SubscriptionReactivation.yaml +++ b/openapi/components/schemas/SubscriptionReactivation.yaml @@ -7,7 +7,7 @@ properties: description: ID of the reactivation. readOnly: true maxLength: 50 - example: ord_rct_0YVJ62AF5XCFCA6EBFAAA3Z7E0 + example: sub_rct_0YVJ62AF5XCFCA6EBFAAA3Z7E0 subscriptionId: type: string description: ID of the reactivated subscription. @@ -18,7 +18,7 @@ properties: description: ID of the related cancellation. readOnly: true maxLength: 50 - example: ord_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV + example: sub_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV description: description: Description of the reactivation reason in free form. type: diff --git a/openapi/components/schemas/Usage.yaml b/openapi/components/schemas/Usage.yaml index 2f787e05ee..8dbb9fea0d 100644 --- a/openapi/components/schemas/Usage.yaml +++ b/openapi/components/schemas/Usage.yaml @@ -9,7 +9,7 @@ properties: readOnly: true description: ID of the usage record. maxLength: 50 - example: ord_usg_0YVJ636B95DNA9M3B1638HXBCQ + example: sub_usg_0YVJ636B95DNA9M3B1638HXBCQ subscriptionId: type: string description: ID of the subscription for which a usage is reported.