diff --git a/openapi/components/schemas/Quote.yaml b/openapi/components/schemas/Quote.yaml index 74e6dd81e0..01359c1825 100644 --- a/openapi/components/schemas/Quote.yaml +++ b/openapi/components/schemas/Quote.yaml @@ -4,7 +4,7 @@ discriminator: create: ./QuoteCreateOrder.yaml change: ./QuoteChangeOrder.yaml reactivate: ./QuoteReactivateOrder.yaml - trial-conversion: ./QuoteTrialConversionOrder.yaml + trial-only-conversion: ./QuoteTrialConversionOrder.yaml oneOf: - $ref: ./QuoteCreateOrder.yaml - $ref: ./QuoteChangeOrder.yaml diff --git a/openapi/components/schemas/QuoteChangeOrder.yaml b/openapi/components/schemas/QuoteChangeOrder.yaml index d3c20b4fa3..d42085087e 100644 --- a/openapi/components/schemas/QuoteChangeOrder.yaml +++ b/openapi/components/schemas/QuoteChangeOrder.yaml @@ -5,7 +5,7 @@ required: - customerId - items - action - - orderId + - subscriptionId properties: id: readOnly: true @@ -59,8 +59,8 @@ properties: - organization isFulfilled: type: boolean - orderId: - description: ID of the related order. + subscriptionId: + description: ID of the related subscription. type: string maxLength: 50 example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ diff --git a/openapi/components/schemas/QuoteCreateOrder.yaml b/openapi/components/schemas/QuoteCreateOrder.yaml index 2139ccf0cd..d05b502082 100644 --- a/openapi/components/schemas/QuoteCreateOrder.yaml +++ b/openapi/components/schemas/QuoteCreateOrder.yaml @@ -25,7 +25,7 @@ properties: description: |- Action of the quote. When a quote is accepted, a new order is created. - The `orderId` value is filled with a new generated value from the order. + The `subscriptionId` value is filled with a new generated value from the order. type: string enum: - create @@ -59,8 +59,8 @@ properties: - organization isFulfilled: type: boolean - orderId: - description: ID of the related order. + subscriptionId: + description: ID of the related subscription or one-time purchase. readOnly: true type: - 'string' diff --git a/openapi/components/schemas/QuoteReactivateOrder.yaml b/openapi/components/schemas/QuoteReactivateOrder.yaml index 4c3d3b038e..fdaafe3cb2 100644 --- a/openapi/components/schemas/QuoteReactivateOrder.yaml +++ b/openapi/components/schemas/QuoteReactivateOrder.yaml @@ -5,7 +5,7 @@ required: - customerId - items - action - - orderId + - subscriptionId properties: id: readOnly: true @@ -59,8 +59,8 @@ properties: - organization isFulfilled: type: boolean - orderId: - description: ID of the related order. + subscriptionId: + description: ID of the related subscription. type: string maxLength: 50 example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ diff --git a/openapi/components/schemas/QuoteTrialConversionOrder.yaml b/openapi/components/schemas/QuoteTrialConversionOrder.yaml index b1169b60fd..45b30878d8 100644 --- a/openapi/components/schemas/QuoteTrialConversionOrder.yaml +++ b/openapi/components/schemas/QuoteTrialConversionOrder.yaml @@ -1,11 +1,11 @@ type: object -title: QuoteChangeOrder +title: QuoteTrialConversionOrder required: - websiteId - customerId - items - action - - orderId + - subscriptionId properties: id: readOnly: true @@ -24,12 +24,12 @@ properties: - one-time-order action: description: |- - Action of the quote for change order items. - When a quote is accepted, quote items are applied to the related order. + Action of the quote for an ended trial-only subscription. + When a quote is accepted, the related order is activated. type: string enum: - - change - example: change + - trial-only-conversion + example: trial-only-conversion acceptanceConditions: type: array writeOnly: true @@ -59,7 +59,7 @@ properties: - organization isFulfilled: type: boolean - orderId: + subscriptionId: description: ID of the related order. type: string maxLength: 50 diff --git a/openapi/components/schemas/StorefrontQuoteChangeOrder.yaml b/openapi/components/schemas/StorefrontQuoteChangeOrder.yaml index 3dcc317790..7e3aa4cef1 100644 --- a/openapi/components/schemas/StorefrontQuoteChangeOrder.yaml +++ b/openapi/components/schemas/StorefrontQuoteChangeOrder.yaml @@ -52,8 +52,8 @@ properties: - organization isFulfilled: type: boolean - orderId: - description: ID of the related order. + subscriptionId: + description: ID of the related subscription. readOnly: true type: string maxLength: 50 diff --git a/openapi/components/schemas/StorefrontQuoteCreateOrder.yaml b/openapi/components/schemas/StorefrontQuoteCreateOrder.yaml index e4957af3d7..0594d33c5f 100644 --- a/openapi/components/schemas/StorefrontQuoteCreateOrder.yaml +++ b/openapi/components/schemas/StorefrontQuoteCreateOrder.yaml @@ -19,7 +19,7 @@ properties: description: |- Action of the quote. When a quote is accepted, a new order is created. - The `orderId` value is filled with a new generated value from the order. + The `subscriptionId` value is filled with a new generated value from the order. type: string enum: - create @@ -53,8 +53,8 @@ properties: - organization isFulfilled: type: boolean - orderId: - description: ID of the related order. + subscriptionId: + description: ID of the related subscription or one-time purchase. readOnly: true type: - 'string' diff --git a/openapi/components/schemas/StorefrontQuoteReactivateOrder.yaml b/openapi/components/schemas/StorefrontQuoteReactivateOrder.yaml index 127cb85ed8..21d5ea264a 100644 --- a/openapi/components/schemas/StorefrontQuoteReactivateOrder.yaml +++ b/openapi/components/schemas/StorefrontQuoteReactivateOrder.yaml @@ -52,8 +52,8 @@ properties: - organization isFulfilled: type: boolean - orderId: - description: ID of the related order. + subscriptionId: + description: ID of the related subscription. readOnly: true type: string maxLength: 50 diff --git a/openapi/components/schemas/StorefrontQuoteTrialConversionOrder.yaml b/openapi/components/schemas/StorefrontQuoteTrialConversionOrder.yaml index 002689e9cd..01b846b101 100644 --- a/openapi/components/schemas/StorefrontQuoteTrialConversionOrder.yaml +++ b/openapi/components/schemas/StorefrontQuoteTrialConversionOrder.yaml @@ -17,13 +17,12 @@ properties: - one-time-order action: description: |- - Action of the quote. - When a quote is accepted, a new order is created. - The `orderId` value is filled with a new generated value from the order. + Action of the quote for an ended trial-only subscription. + When a quote is accepted, the related order is activated. type: string enum: - - create - example: create + - trial-only-conversion + example: trial-only-conversion acceptanceConditions: type: array writeOnly: true @@ -53,12 +52,10 @@ properties: - organization isFulfilled: type: boolean - orderId: - description: ID of the related order. + subscriptionId: + description: ID of the related subscription. readOnly: true - type: - - 'string' - - 'null' + type: string maxLength: 50 example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ invoiceId: