Update OpenAPI specification

stripe · Mar 20, 2024 · 138c8d2 · 138c8d2
1 parent be09991
commit 138c8d2
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 43 deletions.
diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json
@@ -15470,6 +15470,10 @@
       "entitlements.feature": {
         "description": "A feature represents a monetizable ability or functionality in your system.\nFeatures can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.",
         "properties": {
+          "active": {
+            "description": "Inactive features cannot be attached to new products and will not be returned from the features list endpoint.",
+            "type": "boolean"
+          },
           "id": {
             "description": "Unique identifier for the object.",
             "maxLength": 5000,
@@ -15498,6 +15502,7 @@
           }
         },
         "required": [
+          "active",
           "id",
           "livemode",
           "lookup_key",
@@ -103594,7 +103599,7 @@
                     "type": "object"
                   },
                   "coupon": {
-                    "description": "The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string.",
+                    "description": "The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
                     "maxLength": 5000,
                     "type": "string"
                   },
@@ -103934,7 +103939,7 @@
                         "type": "string"
                       }
                     ],
-                    "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead."
+                    "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts."
                   },
                   "expand": {
                     "description": "Specifies which fields in the response should be expanded.",
@@ -106805,7 +106810,7 @@
             "style": "deepObject"
           },
           {
-            "description": "The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string.",
+            "description": "The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
             "in": "query",
             "name": "coupon",
             "required": false,
@@ -107090,7 +107095,7 @@
             "style": "deepObject"
           },
           {
-            "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead.",
+            "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.",
             "explode": true,
             "in": "query",
             "name": "discounts",
@@ -110060,7 +110065,7 @@
             "style": "deepObject"
           },
           {
-            "description": "The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string.",
+            "description": "The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
             "in": "query",
             "name": "coupon",
             "required": false,
@@ -110345,7 +110350,7 @@
             "style": "deepObject"
           },
           {
-            "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead.",
+            "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.",
             "explode": true,
             "in": "query",
             "name": "discounts",

diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml
@@ -14138,6 +14138,11 @@ components:
         purchased, Stripe will create an entitlement to the feature for the
         purchasing customer.
       properties:
+        active:
+          description: >-
+            Inactive features cannot be attached to new products and will not be
+            returned from the features list endpoint.
+          type: boolean
         id:
           description: Unique identifier for the object.
           maxLength: 5000
@@ -14167,6 +14172,7 @@ components:
             - entitlements.feature
           type: string
       required:
+        - active
         - id
         - livemode
         - lookup_key
@@ -93561,13 +93567,10 @@ paths:
                   type: object
                 coupon:
                   description: >-
-                    The code of the coupon to apply. If `subscription` or
-                    `subscription_items` is provided, the invoice returned will
-                    preview updating or creating a subscription with that
-                    coupon. Otherwise, it will preview applying that coupon to
-                    the customer for the next upcoming invoice from among the
-                    customer's subscriptions. The invoice can be previewed
-                    without a coupon by passing this value as an empty string.
+                    The identifier of the coupon to apply to this phase of the
+                    subscription schedule. This field has been deprecated and
+                    will be removed in a future API version. Use `discounts`
+                    instead.
                   maxLength: 5000
                   type: string
                 currency:
@@ -93896,12 +93899,10 @@ paths:
                   description: >-
                     The coupons to redeem into discounts for the invoice
                     preview. If not specified, inherits the discount from the
-                    customer or subscription. This only works for coupons
-                    directly applied to the invoice. To apply a coupon to a
-                    subscription, you must use the `coupon` parameter instead.
-                    Pass an empty string to avoid inheriting any discounts. To
-                    preview the upcoming invoice for a subscription that hasn't
-                    been created, use `coupon` instead.
+                    customer or subscription. This works for both coupons
+                    directly applied to an invoice and coupons applied to a
+                    subscription. Pass an empty string to avoid inheriting any
+                    discounts.
                 expand:
                   description: Specifies which fields in the response should be expanded.
                   items:
@@ -97003,13 +97004,9 @@ paths:
             type: object
           style: deepObject
         - description: >-
-            The code of the coupon to apply. If `subscription` or
-            `subscription_items` is provided, the invoice returned will preview
-            updating or creating a subscription with that coupon. Otherwise, it
-            will preview applying that coupon to the customer for the next
-            upcoming invoice from among the customer's subscriptions. The
-            invoice can be previewed without a coupon by passing this value as
-            an empty string.
+            The identifier of the coupon to apply to this phase of the
+            subscription schedule. This field has been deprecated and will be
+            removed in a future API version. Use `discounts` instead.
           in: query
           name: coupon
           required: false
@@ -97278,11 +97275,9 @@ paths:
         - description: >-
             The coupons to redeem into discounts for the invoice preview. If not
             specified, inherits the discount from the customer or subscription.
-            This only works for coupons directly applied to the invoice. To
-            apply a coupon to a subscription, you must use the `coupon`
-            parameter instead. Pass an empty string to avoid inheriting any
-            discounts. To preview the upcoming invoice for a subscription that
-            hasn't been created, use `coupon` instead.
+            This works for both coupons directly applied to an invoice and
+            coupons applied to a subscription. Pass an empty string to avoid
+            inheriting any discounts.
           explode: true
           in: query
           name: discounts
@@ -100325,13 +100320,9 @@ paths:
             type: object
           style: deepObject
         - description: >-
-            The code of the coupon to apply. If `subscription` or
-            `subscription_items` is provided, the invoice returned will preview
-            updating or creating a subscription with that coupon. Otherwise, it
-            will preview applying that coupon to the customer for the next
-            upcoming invoice from among the customer's subscriptions. The
-            invoice can be previewed without a coupon by passing this value as
-            an empty string.
+            The identifier of the coupon to apply to this phase of the
+            subscription schedule. This field has been deprecated and will be
+            removed in a future API version. Use `discounts` instead.
           in: query
           name: coupon
           required: false
@@ -100600,11 +100591,9 @@ paths:
         - description: >-
             The coupons to redeem into discounts for the invoice preview. If not
             specified, inherits the discount from the customer or subscription.
-            This only works for coupons directly applied to the invoice. To
-            apply a coupon to a subscription, you must use the `coupon`
-            parameter instead. Pass an empty string to avoid inheriting any
-            discounts. To preview the upcoming invoice for a subscription that
-            hasn't been created, use `coupon` instead.
+            This works for both coupons directly applied to an invoice and
+            coupons applied to a subscription. Pass an empty string to avoid
+            inheriting any discounts.
           explode: true
           in: query
           name: discounts