Add churnTimePolicy to subscription cancellation (#1839)

Rebilly · Mar 29, 2024 · 6c69aca · 6c69aca
1 parent e8bccfc
commit 6c69aca
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/openapi/components/schemas/SubscriptionCancellation.yaml b/openapi/components/schemas/SubscriptionCancellation.yaml
@@ -1,7 +1,7 @@
 type: object
 required:
   - subscriptionId
-  - churnTime
+  - churnTimePolicy
 properties:
   id:
     type: string
@@ -97,6 +97,17 @@ properties:
     description: Date and time when the subscription is deactivated.
     type: string
     format: date-time
+  churnTimePolicy:
+    description: |-
+      Specifies when the subscription is to be deactivated.
+      The `churnTimePolicy` takes precedence over the `churnTime` in request.
+    type:
+      - 'string'
+      - 'null'
+    enum:
+      - 'null'
+      - 'now'
+      - 'at-next-renewal'
   lineItems:
     description: |-
       Items to be added to the new invoice.

diff --git a/openapi/paths/subscription-cancellations@{id}.yaml b/openapi/paths/subscription-cancellations@{id}.yaml
@@ -87,8 +87,6 @@ patch:
                   readOnly: true
                 status:
                   readOnly: true
-                churnTime:
-                  readOnly: true
             - $ref: ../components/schemas/SubscriptionCancellation.yaml
     description: Patch cancellation resource.
     required: true