stripe 18.6.0-beta.1 → 19.0.0

package/types/PromotionCodes.d.ts

@@ -3,8 +3,8 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons).
-     * You can create multiple codes for a single coupon.
+     * A Promotion Code represents a customer-redeemable code for an underlying promotion.
+     * You can create multiple codes for a single promotion.
      *
      * If you enable promotion codes in your [customer portal configuration](https://stripe.com/docs/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal.
      * Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal.
@@ -30,13 +30,6 @@ declare module 'stripe' {
        */
       code: string;
 
-      /**
-       * A coupon contains information about a percent-off or amount-off discount you
-       * might want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),
-       * [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).
-       */
-      coupon: Stripe.Coupon;
-
       /**
        * Time at which the object was created. Measured in seconds since the Unix epoch.
        */
@@ -47,11 +40,6 @@ declare module 'stripe' {
        */
       customer: string | Stripe.Customer | Stripe.DeletedCustomer | null;
 
-      /**
-       * The account that this promotion code can be used by.
-       */
-      customer_account?: string | null;
-
       /**
        * Date at which the promotion code can no longer be redeemed.
        */
@@ -72,6 +60,8 @@ declare module 'stripe' {
        */
       metadata: Stripe.Metadata | null;
 
+      promotion: PromotionCode.Promotion;
+
       restrictions: PromotionCode.Restrictions;
 
       /**
@@ -81,6 +71,18 @@ declare module 'stripe' {
     }
 
     namespace PromotionCode {
+      interface Promotion {
+        /**
+         * If promotion `type` is `coupon`, the coupon for this promotion.
+         */
+        coupon: string | Stripe.Coupon | null;
+
+        /**
+         * The type of promotion.
+         */
+        type: 'coupon';
+      }
+
       interface Restrictions {
         /**
          * Promotion code restrictions defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).

package/types/PromotionCodesResource.d.ts

@@ -4,9 +4,9 @@ declare module 'stripe' {
   namespace Stripe {
     interface PromotionCodeCreateParams {
       /**
-       * The coupon for this promotion code.
+       * The promotion referenced by this promotion code.
        */
-      coupon: string;
+      promotion: PromotionCodeCreateParams.Promotion;
 
       /**
        * Whether the promotion code is currently active.
@@ -25,11 +25,6 @@ declare module 'stripe' {
        */
       customer?: string;
 
-      /**
-       * The account that this promotion code can be used by. If not set, the promotion code can be used by all accounts.
-       */
-      customer_account?: string;
-
       /**
        * Specifies which fields in the response should be expanded.
        */
@@ -57,6 +52,18 @@ declare module 'stripe' {
     }
 
     namespace PromotionCodeCreateParams {
+      interface Promotion {
+        /**
+         * If promotion `type` is `coupon`, the coupon for this promotion code.
+         */
+        coupon?: string;
+
+        /**
+         * Specifies the type of promotion.
+         */
+        type: 'coupon';
+      }
+
       interface Restrictions {
         /**
          * Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
@@ -166,11 +173,6 @@ declare module 'stripe' {
        */
       customer?: string;
 
-      /**
-       * Only return promotion codes that are restricted to this account.
-       */
-      customer_account?: string;
-
       /**
        * Specifies which fields in the response should be expanded.
        */
@@ -179,7 +181,7 @@ declare module 'stripe' {
 
     class PromotionCodesResource {
       /**
-       * A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
+       * A promotion code points to an underlying promotion. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
        */
       create(
         params: PromotionCodeCreateParams,