stripe 19.3.1 → 19.4.0-alpha.2

package/types/V2/Billing/LicenseFeeSubscriptions.d.ts

@@ -0,0 +1,64 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * The LicenseFeeSubscription object.
+         */
+        interface LicenseFeeSubscription {
+          /**
+           * Unique identifier for the object.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.billing.license_fee_subscription';
+
+          /**
+           * The ID of the Billing Cadence.
+           */
+          billing_cadence: string;
+
+          /**
+           * Timestamp of when the object was created.
+           */
+          created: string;
+
+          /**
+           * The ID of the License Fee.
+           */
+          license_fee: string;
+
+          /**
+           * The ID of the License Fee Version.
+           */
+          license_fee_version: string;
+
+          /**
+           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+           */
+          livemode: boolean;
+
+          /**
+           * Set of key-value pairs 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;
+
+          /**
+           * Quantity of the License Fee subscribed to.
+           */
+          quantity: number;
+
+          /**
+           * The ID of the Test Clock, if any.
+           */
+          test_clock?: string;
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/LicenseFeeSubscriptionsResource.d.ts

@@ -0,0 +1,28 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        interface LicenseFeeSubscriptionRetrieveParams {}
+      }
+
+      namespace Billing {
+        class LicenseFeeSubscriptionsResource {
+          /**
+           * Retrieve a License Fee Subscription object.
+           */
+          retrieve(
+            id: string,
+            params?: LicenseFeeSubscriptionRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.LicenseFeeSubscription>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.LicenseFeeSubscription>>;
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/LicenseFeeVersions.d.ts

@@ -0,0 +1,106 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * The LicenseFeeVersion object.
+         */
+        interface LicenseFeeVersion {
+          /**
+           * Unique identifier for the object.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.billing.license_fee_version';
+
+          /**
+           * Timestamp of when the object was created.
+           */
+          created: string;
+
+          /**
+           * The ID of the parent License Fee.
+           */
+          license_fee_id: string;
+
+          /**
+           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+           */
+          livemode: boolean;
+
+          /**
+           * Defines whether the tiering price should be graduated or volume-based. In volume-based tiering, the maximum
+           * quantity within a period determines the per-unit price. In graduated tiering, the pricing changes as the quantity
+           * grows into new tiers. Can only be set if `tiers` is set.
+           */
+          tiering_mode?: LicenseFeeVersion.TieringMode;
+
+          /**
+           * Each element represents a pricing tier. Cannot be set if `unit_amount` is provided.
+           */
+          tiers: Array<LicenseFeeVersion.Tier>;
+
+          /**
+           * Apply a transformation to the reported usage or set quantity before computing the amount billed.
+           */
+          transform_quantity?: LicenseFeeVersion.TransformQuantity;
+
+          /**
+           * The per-unit amount to be charged, represented as a decimal string in minor currency units with at most 12 decimal
+           * places. Cannot be set if `tiers` is provided.
+           */
+          unit_amount?: string;
+        }
+
+        namespace LicenseFeeVersion {
+          interface Tier {
+            /**
+             * Price for the entire tier, represented as a decimal string in minor currency units with at most 12 decimal places.
+             */
+            flat_amount?: string;
+
+            /**
+             * Per-unit price for units included in this tier, represented as a decimal string in minor currency units with at
+             * most 12 decimal places.
+             */
+            unit_amount?: string;
+
+            /**
+             * Up to and including this quantity will be contained in the tier. Only one of `up_to_decimal` and `up_to_inf` may
+             * be set.
+             */
+            up_to_decimal?: string;
+
+            /**
+             * No upper bound to this tier. Only one of `up_to_decimal` and `up_to_inf` may be set.
+             */
+            up_to_inf?: 'inf';
+          }
+
+          type TieringMode = 'graduated' | 'volume';
+
+          interface TransformQuantity {
+            /**
+             * Divide usage by this number.
+             */
+            divide_by: number;
+
+            /**
+             * After division, round the result up or down.
+             */
+            round: TransformQuantity.Round;
+          }
+
+          namespace TransformQuantity {
+            type Round = 'down' | 'up';
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/LicenseFees/VersionsResource.d.ts

@@ -0,0 +1,58 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        namespace LicenseFees {
+          interface VersionRetrieveParams {}
+        }
+      }
+
+      namespace Billing {
+        namespace LicenseFees {
+          interface VersionListParams {
+            /**
+             * Optionally set the maximum number of results per page. Defaults to 20.
+             */
+            limit?: number;
+          }
+        }
+      }
+
+      namespace Billing {
+        namespace LicenseFees {
+          class VersionsResource {
+            /**
+             * Retrieve a License Fee Version object.
+             */
+            retrieve(
+              licenseFeeId: string,
+              id: string,
+              params?: VersionRetrieveParams,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.LicenseFeeVersion>>;
+            retrieve(
+              licenseFeeId: string,
+              id: string,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.LicenseFeeVersion>>;
+
+            /**
+             * List all versions of a License Fee object.
+             */
+            list(
+              id: string,
+              params?: VersionListParams,
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Billing.LicenseFeeVersion>;
+            list(
+              id: string,
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Billing.LicenseFeeVersion>;
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/LicenseFees.d.ts

@@ -0,0 +1,164 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * The LicenseFee object.
+         */
+        interface LicenseFee {
+          /**
+           * Unique identifier for the object.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.billing.license_fee';
+
+          /**
+           * Whether this License Fee is active. Inactive License Fees cannot be used in new activations or be modified.
+           */
+          active: boolean;
+
+          /**
+           * Timestamp of when the object was created.
+           */
+          created: string;
+
+          /**
+           * Three-letter ISO currency code, in lowercase. Must be a supported currency.
+           */
+          currency: string;
+
+          /**
+           * A customer-facing name for the license fee.
+           * This name is used in Stripe-hosted products like the Customer Portal and Checkout. It does not show up on Invoices.
+           * Maximum length of 250 characters.
+           */
+          display_name: string;
+
+          /**
+           * The ID of the license fee's most recently created version.
+           */
+          latest_version: string;
+
+          /**
+           * A Licensed Item represents a billable item whose pricing is based on license fees. You can use license fees
+           * to specify the pricing and create subscriptions to these items.
+           */
+          licensed_item: Stripe.V2.Billing.LicensedItem;
+
+          /**
+           * The ID of the License Fee Version that will be used by all subscriptions when no specific version is specified.
+           */
+          live_version: string;
+
+          /**
+           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+           */
+          livemode: boolean;
+
+          /**
+           * An internal key you can use to search for a particular License Fee. Maximum length of 200 characters.
+           */
+          lookup_key?: string;
+
+          /**
+           * Set of [key-value pairs](https://docs.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.
+           */
+          metadata?: Stripe.Metadata;
+
+          /**
+           * The interval for assessing service.
+           */
+          service_interval: LicenseFee.ServiceInterval;
+
+          /**
+           * The length of the interval for assessing service. For example, set this to 3 and `service_interval` to `"month"` in
+           * order to specify quarterly service.
+           */
+          service_interval_count: number;
+
+          /**
+           * The Stripe Tax tax behavior - whether the license fee is inclusive or exclusive of tax.
+           */
+          tax_behavior: LicenseFee.TaxBehavior;
+
+          /**
+           * Defines whether the tiering price should be graduated or volume-based. In volume-based tiering, the maximum
+           * quantity within a period determines the per-unit price. In graduated tiering, the pricing changes as the quantity
+           * grows into new tiers. Can only be set if `tiers` is set.
+           */
+          tiering_mode?: LicenseFee.TieringMode;
+
+          /**
+           * Each element represents a pricing tier. Cannot be set if `unit_amount` is provided.
+           */
+          tiers: Array<LicenseFee.Tier>;
+
+          /**
+           * Apply a transformation to the reported usage or set quantity before computing the amount billed.
+           */
+          transform_quantity?: LicenseFee.TransformQuantity;
+
+          /**
+           * The per-unit amount to be charged, represented as a decimal string in minor currency units with at most 12 decimal
+           * places. Cannot be set if `tiers` is provided.
+           */
+          unit_amount?: string;
+        }
+
+        namespace LicenseFee {
+          type ServiceInterval = 'day' | 'month' | 'week' | 'year';
+
+          type TaxBehavior = 'exclusive' | 'inclusive';
+
+          interface Tier {
+            /**
+             * Price for the entire tier, represented as a decimal string in minor currency units with at most 12 decimal places.
+             */
+            flat_amount?: string;
+
+            /**
+             * Per-unit price for units included in this tier, represented as a decimal string in minor currency units with at
+             * most 12 decimal places.
+             */
+            unit_amount?: string;
+
+            /**
+             * Up to and including this quantity will be contained in the tier. Only one of `up_to_decimal` and `up_to_inf` may
+             * be set.
+             */
+            up_to_decimal?: string;
+
+            /**
+             * No upper bound to this tier. Only one of `up_to_decimal` and `up_to_inf` may be set.
+             */
+            up_to_inf?: 'inf';
+          }
+
+          type TieringMode = 'graduated' | 'volume';
+
+          interface TransformQuantity {
+            /**
+             * Divide usage by this number.
+             */
+            divide_by: number;
+
+            /**
+             * After division, round the result up or down.
+             */
+            round: TransformQuantity.Round;
+          }
+
+          namespace TransformQuantity {
+            type Round = 'down' | 'up';
+          }
+        }
+      }
+    }
+  }
+}