Add autopay to quotes (#1814)

* Add autopay to quotes * Apply code review suggestions * Apply code review suggestions
Rebilly · Mar 1, 2024 · 1d27c68 · 1d27c68
1 parent 0899a1d
commit 1d27c68
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/openapi/components/schemas/QuoteChangeOrder.yaml b/openapi/components/schemas/QuoteChangeOrder.yaml
@@ -378,6 +378,14 @@ properties:
                 - 'number'
                 - 'null'
               format: double
+  autopay:
+    type:
+      - 'boolean'
+      - 'null'
+    description: |-
+      Specifies if payment attempts for the related subscription are made automatically.
+      If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
+      or the default payment instrument on the subscription.
   paymentTerms:
     description: Payment terms for the customer which are displayed on the quote.
     type: string

diff --git a/openapi/components/schemas/QuoteCreateOrder.yaml b/openapi/components/schemas/QuoteCreateOrder.yaml
@@ -364,6 +364,13 @@ properties:
                 - 'number'
                 - 'null'
               format: double
+  autopay:
+    type: boolean
+    default: false
+    description: |-
+      Specifies if payment attempts for the related subscription are made automatically.
+      If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
+      or the default payment instrument on the subscription.
   paymentTerms:
     description: Payment terms for the customer which are displayed on the quote.
     type: string

diff --git a/openapi/components/schemas/QuoteReactivateOrder.yaml b/openapi/components/schemas/QuoteReactivateOrder.yaml
@@ -384,6 +384,14 @@ properties:
                 - 'number'
                 - 'null'
               format: double
+  autopay:
+    type:
+      - 'boolean'
+      - 'null'
+    description: |-
+      Specifies if payment attempts for the related subscription are made automatically.
+      If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
+      or the default payment instrument on the subscription.
   paymentTerms:
     description: Payment terms for the customer which are displayed on the quote.
     type: string