Generated Latest Changes for v2021-02-25

openapi/api.yaml

@@ -57,7 +57,7 @@ info:
 
     We encourage you to update to the latest version of the API and corresponding client library,
     as most recent versions are more performant than their predecessors. See the
-    [changelog](https://developers.recurly.com/api/changelog.html) for a comprehensive list of changes
+    [changelog](https://recurly.com/developers/api/changelog.html) for a comprehensive list of changes
     introduced in the latest API version.
 
     ### Default Versions
@@ -114,7 +114,7 @@ info:
     Please consider changing these messages in the target system to be better
     suited to the audience of the system.
 
-    Please see [transaction error codes](https://developers.recurly.com/pages/api-transaction-errors.html) for more details.
+    Please see [transaction error codes](https://recurly.com/developers/pages/api-transaction-errors.html) for more details.
 
     ## Pagination
     ### Response Schema
@@ -181,7 +181,7 @@ info:
 
     ## Change Log
 
-    A list of changes for this version can be found [in the changelog](https://developers.recurly.com/api/changelog.html#v2021-02-25---current-ga-version).
+    A list of changes for this version can be found [in the changelog](https://recurly.com/developers/api/changelog.html#v2021-02-25---current-ga-version).
   version: v2021-02-25
 security:
 - api_key: []
@@ -2694,7 +2694,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_account_coupon_redemptions
-      summary: Show the coupon redemptions for an account
+      summary: List the coupon redemptions for an account
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -2791,7 +2791,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_active_coupon_redemptions
-      summary: Show the coupon redemptions that are active on an account
+      summary: List the coupon redemptions that are active on an account
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -3944,7 +3944,7 @@ paths:
       tags:
       - note
       operationId: list_account_notes
-      summary: Fetch a list of an account's notes
+      summary: List an account's notes
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -8742,7 +8742,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_invoice_coupon_redemptions
-      summary: Show the coupon redemptions applied to an invoice
+      summary: List the coupon redemptions applied to an invoice
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -13327,7 +13327,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_subscription_coupon_redemptions
-      summary: Show the coupon redemptions for a subscription
+      summary: List the coupon redemptions for a subscription
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -14907,7 +14907,7 @@ paths:
       tags:
       - dunning_campaigns
       operationId: list_dunning_campaigns
-      summary: Show the dunning campaigns for a site
+      summary: List the dunning campaigns for a site
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -14939,7 +14939,7 @@ paths:
       tags:
       - dunning_campaigns
       operationId: get_dunning_campaign
-      summary: Show the settings for a dunning campaign
+      summary: Fetch a dunning campaign
       responses:
         '200':
           description: Settings for a dunning campaign.
@@ -15042,7 +15042,7 @@ paths:
       tags:
       - invoice_templates
       operationId: get_invoice_template
-      summary: Show the settings for an invoice template
+      summary: Fetch an invoice template
       responses:
         '200':
           description: Settings for an invoice template.
@@ -15077,7 +15077,7 @@ paths:
       tags:
       - account
       operationId: list_entitlements
-      summary: Show all entitlements granted to an account
+      summary: List entitlements granted to an account
       responses:
         '200':
           description: A list of the entitlements granted to an account.
@@ -16882,7 +16882,7 @@ components:
         token_id:
           type: string
           title: Token ID
-          description: A token [generated by Recurly.js](https://developers.recurly.com/reference/recurly-js/#getting-a-token).
+          description: A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).
           maxLength: 22
         first_name:
           type: string
@@ -19090,6 +19090,8 @@ components:
           title: Ramp Intervals
           items:
             "$ref": "#/components/schemas/PlanRampInterval"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         revenue_schedule_type:
           title: Revenue schedule type
           "$ref": "#/components/schemas/RevenueScheduleTypeEnum"
@@ -19260,6 +19262,8 @@ components:
           title: Ramp Intervals
           items:
             "$ref": "#/components/schemas/PlanRampInterval"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         revenue_schedule_type:
           title: Revenue schedule type
           "$ref": "#/components/schemas/RevenueScheduleTypeEnum"
@@ -19474,6 +19478,8 @@ components:
           title: Ramp Intervals
           items:
             "$ref": "#/components/schemas/PlanRampInterval"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         revenue_schedule_type:
           title: Revenue schedule type
           "$ref": "#/components/schemas/RevenueScheduleTypeEnum"
@@ -20491,7 +20497,7 @@ components:
             If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object
             must include one to many tiers with `ending_quantity` and `unit_amount`.
             There must be one tier without an `ending_quantity` value which represents the final tier.
-            See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html)
+            See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html)
             for an overview of how to configure quantity-based pricing models.
         percentage_tiers:
           type: array
@@ -20512,7 +20518,7 @@ components:
           description: The percentage taken of the monetary amount of usage tracked.
             This can be up to 4 decimal places. A value between 0.0 and 100.0. Required
             if `add_on_type` is usage and `usage_type` is percentage. Must be omitted
-            otherwise. `usage_percentage` does not support tiers. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html)
+            otherwise. `usage_percentage` does not support tiers. See our [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html)
             for an overview of how to configure usage add-ons.
         revenue_schedule_type:
           title: Revenue schedule type
@@ -22367,6 +22373,7 @@ components:
       enum:
       - account
       - item
+      - plan
       - subscription
     RefundTypeEnum:
       type: string
@@ -22596,15 +22603,15 @@ components:
       title: Usage Type
       description: |
         Type of usage, required if `add_on_type` is `usage`. See our
-        [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html) for an
+        [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html) for an
         overview of how to configure usage add-ons.
     TierTypeEnum:
       type: string
       title: Tier type
       description: |
         The pricing model for the add-on.  For more information,
         [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our
-        [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how
+        [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how
         to configure quantity-based pricing models.
       default: flat
       enum:

recurly/client.py

@@ -648,7 +648,7 @@ def remove_a_billing_info(self, account_id, billing_info_id, **options):
         return self._make_request("DELETE", path, None, **options)
 
     def list_account_coupon_redemptions(self, account_id, **options):
-        """Show the coupon redemptions for an account
+        """List the coupon redemptions for an account
 
         Parameters
         ----------
@@ -698,7 +698,7 @@ def list_account_coupon_redemptions(self, account_id, **options):
         return Pager(self, path, **options)
 
     def list_active_coupon_redemptions(self, account_id, **options):
-        """Show the coupon redemptions that are active on an account
+        """List the coupon redemptions that are active on an account
 
         Parameters
         ----------
@@ -1012,7 +1012,7 @@ def create_line_item(self, account_id, body, **options):
         return self._make_request("POST", path, body, **options)
 
     def list_account_notes(self, account_id, **options):
-        """Fetch a list of an account's notes
+        """List an account's notes
 
         Parameters
         ----------
@@ -2574,7 +2574,7 @@ def list_invoice_line_items(self, invoice_id, **options):
         return Pager(self, path, **options)
 
     def list_invoice_coupon_redemptions(self, invoice_id, **options):
-        """Show the coupon redemptions applied to an invoice
+        """List the coupon redemptions applied to an invoice
 
         Parameters
         ----------
@@ -3847,7 +3847,7 @@ def list_subscription_line_items(self, subscription_id, **options):
         return Pager(self, path, **options)
 
     def list_subscription_coupon_redemptions(self, subscription_id, **options):
-        """Show the coupon redemptions for a subscription
+        """List the coupon redemptions for a subscription
 
         Parameters
         ----------
@@ -4325,7 +4325,7 @@ def get_export_files(self, export_date, **options):
         return self._make_request("GET", path, None, **options)
 
     def list_dunning_campaigns(self, **options):
-        """Show the dunning campaigns for a site
+        """List the dunning campaigns for a site
 
         Keyword Arguments
         -----------------
@@ -4351,7 +4351,7 @@ def list_dunning_campaigns(self, **options):
         return Pager(self, path, **options)
 
     def get_dunning_campaign(self, dunning_campaign_id, **options):
-        """Show the settings for a dunning campaign
+        """Fetch a dunning campaign
 
         Parameters
         ----------
@@ -4429,7 +4429,7 @@ def list_invoice_templates(self, **options):
         return Pager(self, path, **options)
 
     def get_invoice_template(self, invoice_template_id, **options):
-        """Show the settings for an invoice template
+        """Fetch an invoice template
 
         Parameters
         ----------
@@ -4453,7 +4453,7 @@ def get_invoice_template(self, invoice_template_id, **options):
         return self._make_request("GET", path, None, **options)
 
     def list_entitlements(self, account_id, **options):
-        """Show all entitlements granted to an account
+        """List entitlements granted to an account
 
         Parameters
         ----------

recurly/resources.py

@@ -1927,7 +1927,7 @@ class SubscriptionAddOn(Resource):
     tier_type : str
         The pricing model for the add-on.  For more information,
         [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our
-        [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how
+        [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how
         to configure quantity-based pricing models.
     tiers : :obj:`list` of :obj:`SubscriptionAddOnTier`
         If tiers are provided in the request, all existing tiers on the Subscription Add-on will be
@@ -2343,6 +2343,8 @@ class Plan(Resource):
         Created at
     currencies : :obj:`list` of :obj:`PlanPricing`
         Pricing
+    custom_fields : :obj:`list` of :obj:`CustomField`
+        The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
     deleted_at : datetime
         Deleted at
     description : str
@@ -2400,6 +2402,7 @@ class Plan(Resource):
         "code": str,
         "created_at": datetime,
         "currencies": ["PlanPricing"],
+        "custom_fields": ["CustomField"],
         "deleted_at": datetime,
         "description": str,
         "dunning_campaign_id": str,
@@ -2552,7 +2555,7 @@ class AddOn(Resource):
     tier_type : str
         The pricing model for the add-on.  For more information,
         [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our
-        [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how
+        [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how
         to configure quantity-based pricing models.
     tiers : :obj:`list` of :obj:`Tier`
         Tiers
@@ -2764,7 +2767,7 @@ class Usage(Resource):
     tier_type : str
         The pricing model for the add-on.  For more information,
         [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our
-        [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how
+        [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how
         to configure quantity-based pricing models.
     tiers : :obj:`list` of :obj:`SubscriptionAddOnTier`
         The tiers and prices of the subscription based on the usage_timestamp. If tier_type = flat, tiers = []