stripe 20.1.0-alpha.4 → 20.1.0

package/types/ShippingRates.d.ts

@@ -4,7 +4,7 @@ declare module 'stripe' {
   namespace Stripe {
     /**
      * Shipping rates describe the price of shipping presented to your customers and
-     * applied to a purchase. For more information, see [Charge for shipping](https://stripe.com/docs/payments/during-payment/charge-shipping).
+     * applied to a purchase. For more information, see [Charge for shipping](https://docs.stripe.com/payments/during-payment/charge-shipping).
      */
     interface ShippingRate {
       /**
@@ -45,7 +45,7 @@ declare module 'stripe' {
       livemode: boolean;
 
       /**
-       * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+       * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
        */
       metadata: Stripe.Metadata;
 
@@ -55,7 +55,7 @@ declare module 'stripe' {
       tax_behavior: ShippingRate.TaxBehavior | null;
 
       /**
-       * A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
+       * A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
        */
       tax_code: string | Stripe.TaxCode | null;
 

package/types/ShippingRatesResource.d.ts

@@ -24,7 +24,7 @@ declare module 'stripe' {
       fixed_amount?: ShippingRateCreateParams.FixedAmount;
 
       /**
-       * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+       * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        */
       metadata?: Stripe.MetadataParam;
 
@@ -34,7 +34,7 @@ declare module 'stripe' {
       tax_behavior?: ShippingRateCreateParams.TaxBehavior;
 
       /**
-       * A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
+       * A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
        */
       tax_code?: string;
 
@@ -155,7 +155,7 @@ declare module 'stripe' {
       fixed_amount?: ShippingRateUpdateParams.FixedAmount;
 
       /**
-       * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+       * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        */
       metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
 

package/types/Sigma/ScheduledQueryRuns.d.ts

@@ -4,7 +4,7 @@ declare module 'stripe' {
   namespace Stripe {
     namespace Sigma {
       /**
-       * If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll
+       * If you have [scheduled a Sigma query](https://docs.stripe.com/sigma/scheduled-queries), you'll
        * receive a `sigma.scheduled_query_run.created` webhook each time the query
        * runs. The webhook contains a `ScheduledQueryRun` object, which you can use to
        * retrieve the query results.

package/types/SourceMandateNotifications.d.ts

@@ -50,11 +50,11 @@ declare module 'stripe' {
        * just like a `Card` object: once chargeable, they can be charged, or can be
        * attached to customers.
        *
-       * Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).
-       * We recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).
+       * Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources).
+       * We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods).
        * This newer API provides access to our latest features and payment method types.
        *
-       * Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).
+       * Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers).
        */
       source: Stripe.Source;
 

package/types/Sources.d.ts

@@ -8,11 +8,11 @@ declare module 'stripe' {
      * just like a `Card` object: once chargeable, they can be charged, or can be
      * attached to customers.
      *
-     * Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).
-     * We recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).
+     * Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources).
+     * We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods).
      * This newer API provides access to our latest features and payment method types.
      *
-     * Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).
+     * Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers).
      */
     interface Source {
       /**
@@ -92,7 +92,7 @@ declare module 'stripe' {
       livemode: boolean;
 
       /**
-       * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+       * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
        */
       metadata: Stripe.Metadata | null;
 
@@ -105,8 +105,6 @@ declare module 'stripe' {
 
       p24?: Source.P24;
 
-      paypal?: Source.Paypal;
-
       receiver?: Source.Receiver;
 
       redirect?: Source.Redirect;
@@ -132,7 +130,7 @@ declare module 'stripe' {
       three_d_secure?: Source.ThreeDSecure;
 
       /**
-       * The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used.
+       * The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://docs.stripe.com/sources) used.
        */
       type: Source.Type;
 
@@ -238,8 +236,6 @@ declare module 'stripe' {
 
         brand?: string | null;
 
-        brand_product?: string | null;
-
         country?: string | null;
 
         cvc_check?: string | null;
@@ -280,8 +276,6 @@ declare module 'stripe' {
 
         brand?: string | null;
 
-        brand_product?: string | null;
-
         country?: string | null;
 
         cvm_type?: string;
@@ -485,26 +479,6 @@ declare module 'stripe' {
         reference?: string | null;
       }
 
-      interface Paypal {
-        billing_agreement?: string | null;
-
-        fingerprint?: string | null;
-
-        payer_id?: string | null;
-
-        reference_id?: string;
-
-        reference_transaction_amount?: string;
-
-        reference_transaction_charged?: boolean;
-
-        statement_descriptor?: string | null;
-
-        transaction_id?: string;
-
-        verified_email?: string | null;
-      }
-
       interface Receiver {
         /**
          * The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
@@ -706,8 +680,6 @@ declare module 'stripe' {
 
         brand?: string | null;
 
-        brand_product?: string | null;
-
         card?: string | null;
 
         country?: string | null;
@@ -756,7 +728,6 @@ declare module 'stripe' {
         | 'klarna'
         | 'multibanco'
         | 'p24'
-        | 'paypal'
         | 'sepa_credit_transfer'
         | 'sepa_debit'
         | 'sofort'

package/types/SourcesResource.d.ts

@@ -71,7 +71,7 @@ declare module 'stripe' {
       token?: string;
 
       /**
-       * The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide)
+       * The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://docs.stripe.com/sources/connect#cloning-card-sources) guide)
        */
       type?: string;
 
@@ -323,7 +323,7 @@ declare module 'stripe' {
       mandate?: SourceUpdateParams.Mandate;
 
       /**
-       * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+       * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        */
       metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
 

package/types/SubscriptionItems.d.ts

@@ -37,11 +37,6 @@ declare module 'stripe' {
        */
       object: 'subscription_item';
 
-      /**
-       * The time period the subscription item has been billed for.
-       */
-      billed_until?: number | null;
-
       /**
        * Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
        */
@@ -62,11 +57,6 @@ declare module 'stripe' {
        */
       current_period_start: number;
 
-      /**
-       * The current trial that is applied to this subscription item.
-       */
-      current_trial?: SubscriptionItem.CurrentTrial | null;
-
       /**
        * Always true for a deleted object
        */
@@ -78,34 +68,34 @@ declare module 'stripe' {
       discounts: Array<string | Stripe.Discount>;
 
       /**
-       * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+       * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
        */
       metadata: Stripe.Metadata;
 
       /**
-       * You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
+       * You can now model subscriptions more flexibly using the [Prices API](https://api.stripe.com#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
        *
        * Plans define the base price, currency, and billing cycle for recurring purchases of products.
-       * [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
+       * [Products](https://api.stripe.com#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
        *
        * For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
        *
-       * Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview).
+       * Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription) and more about [products and prices](https://docs.stripe.com/products-prices/overview).
        */
       plan: Stripe.Plan;
 
       /**
        * Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.
-       * [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
+       * [Products](https://api.stripe.com#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
        *
        * For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
        *
-       * Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).
+       * Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), [create an invoice](https://docs.stripe.com/billing/invoices/create), and more about [products and prices](https://docs.stripe.com/products-prices/overview).
        */
       price: Stripe.Price;
 
       /**
-       * The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed.
+       * The [quantity](https://docs.stripe.com/subscriptions/quantities) of the plan to which the customer should be subscribed.
        */
       quantity?: number;
 
@@ -118,11 +108,6 @@ declare module 'stripe' {
        * The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
        */
       tax_rates: Array<Stripe.TaxRate> | null;
-
-      /**
-       * Options that configure the trial on the subscription item.
-       */
-      trial?: SubscriptionItem.Trial | null;
     }
 
     namespace SubscriptionItem {
@@ -132,30 +117,6 @@ declare module 'stripe' {
          */
         usage_gte: number | null;
       }
-
-      interface CurrentTrial {
-        end_date: number;
-
-        start_date: number;
-
-        trial_offer: string;
-      }
-
-      interface Trial {
-        /**
-         * List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
-         */
-        converts_to?: Array<string> | null;
-
-        /**
-         * Determines the type of trial for this item.
-         */
-        type: Trial.Type;
-      }
-
-      namespace Trial {
-        type Type = 'free' | 'paid';
-      }
     }
   }
 }