Merge pull request #329 from recurly/v3-v2021-02-25-8993209395

Generated Latest Changes for v2021-02-25 (Proration Settings)

lib/recurly.d.ts

@@ -5903,6 +5903,10 @@ export interface SubscriptionChangeCreate {
     * The new set of ramp intervals for the subscription.
     */
   rampIntervals?: SubscriptionRampInterval[] | null;
+  /**
+    * Allows you to control how any resulting charges and credits will be calculated and prorated.
+    */
+  prorationSettings?: ProrationSettings | null;
 
 }
 
@@ -5979,6 +5983,18 @@ export interface SubscriptionChangeBillingInfoCreate {
 
 }
 
+export interface ProrationSettings {
+  /**
+    * Determines how the amount charged is determined for this change
+    */
+  charge?: string | null;
+  /**
+    * Determines how the amount credited is determined for this change
+    */
+  credit?: string | null;
+
+}
+
 export interface UsageCreate {
   /**
     * Custom field for recording the id in your own system associated with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint.

openapi/api.yaml

@@ -21253,6 +21253,34 @@ components:
           description: |
             The percentage taken of the monetary amount of usage tracked.
             This can be up to 4 decimal places represented as a string.
+    ProrationSettings:
+      type: object
+      title: Proration Settings
+      description: Allows you to control how any resulting charges and credits will
+        be calculated and prorated.
+      properties:
+        charge:
+          "$ref": "#/components/schemas/ProrationSettingsChargeEnum"
+        credit:
+          "$ref": "#/components/schemas/ProrationSettingsCreditEnum"
+    ProrationSettingsChargeEnum:
+      type: string
+      title: Charge
+      description: Determines how the amount charged is determined for this change
+      default: prorated_amount
+      enum:
+      - full_amount
+      - prorated_amount
+      - none
+    ProrationSettingsCreditEnum:
+      type: string
+      title: Credit
+      description: Determines how the amount credited is determined for this change
+      default: prorated_amount
+      enum:
+      - full_amount
+      - prorated_amount
+      - none
     Settings:
       type: object
       properties:
@@ -22476,6 +22504,8 @@ components:
           description: The new set of ramp intervals for the subscription.
           items:
             "$ref": "#/components/schemas/SubscriptionRampInterval"
+        proration_settings:
+          "$ref": "#/components/schemas/ProrationSettings"
     SubscriptionChangeShippingCreate:
       type: object
       title: Shipping details that will be changed on a subscription