stripe 20.1.0-alpha.4 → 20.1.0

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

@@ -1,189 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Billing {
-        interface MeteredItemCreateParams {
-          /**
-           * Description that customers will see in the invoice line item.
-           * Maximum length of 250 characters.
-           */
-          display_name: string;
-
-          /**
-           * ID of the Meter that measures usage for this Metered Item.
-           */
-          meter: string;
-
-          /**
-           * Optional array of Meter dimensions to group event dimension keys for invoice line items.
-           */
-          invoice_presentation_dimensions?: Array<string>;
-
-          /**
-           * An internal key you can use to search for a particular billable item.
-           * Must be unique among billable items.
-           * 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.MetadataParam;
-
-          /**
-           * Optional array of Meter segments to filter event dimension keys for billing.
-           */
-          meter_segment_conditions?: Array<
-            MeteredItemCreateParams.MeterSegmentCondition
-          >;
-
-          /**
-           * Stripe Tax details.
-           */
-          tax_details?: MeteredItemCreateParams.TaxDetails;
-
-          /**
-           * The unit to use when displaying prices for this billable item in places like Checkout. For example, set this field
-           * to "CPU-hour" for Checkout to display "(price) per CPU-hour", or "1 million events" to display "(price) per 1
-           * million events".
-           * Maximum length of 100 characters.
-           */
-          unit_label?: string;
-        }
-
-        namespace MeteredItemCreateParams {
-          interface MeterSegmentCondition {
-            /**
-             * A Meter dimension.
-             */
-            dimension: string;
-
-            /**
-             * To count usage towards this metered item, the dimension must have this value.
-             */
-            value: string;
-          }
-
-          interface TaxDetails {
-            /**
-             * Product tax code (PTC).
-             */
-            tax_code: string;
-          }
-        }
-      }
-
-      namespace Billing {
-        interface MeteredItemRetrieveParams {}
-      }
-
-      namespace Billing {
-        interface MeteredItemUpdateParams {
-          /**
-           * Description that customers will see in the invoice line item.
-           * Maximum length of 250 characters.
-           */
-          display_name?: string;
-
-          /**
-           * An internal key you can use to search for a particular billable item.
-           * Maximum length of 200 characters.
-           * To remove the lookup_key from the object, set it to null in the request.
-           */
-          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.MetadataParam;
-
-          /**
-           * Stripe Tax details.
-           */
-          tax_details?: MeteredItemUpdateParams.TaxDetails;
-
-          /**
-           * The unit to use when displaying prices for this billable item in places like Checkout. For example, set this field
-           * to "CPU-hour" for Checkout to display "(price) per CPU-hour", or "1 million events" to display "(price) per 1
-           * million events".
-           * Maximum length of 100 characters.
-           * To remove the unit_label from the object, set it to null in the request.
-           */
-          unit_label?: string;
-        }
-
-        namespace MeteredItemUpdateParams {
-          interface TaxDetails {
-            /**
-             * Product tax code (PTC).
-             */
-            tax_code: string;
-          }
-        }
-      }
-
-      namespace Billing {
-        interface MeteredItemListParams {
-          /**
-           * Optionally set the maximum number of results per page. Defaults to 20.
-           */
-          limit?: number;
-
-          /**
-           * Filter by lookup keys.
-           * You can specify up to 10 lookup keys.
-           */
-          lookup_keys?: Array<string>;
-        }
-      }
-
-      namespace Billing {
-        class MeteredItemsResource {
-          /**
-           * Create a Metered Item object.
-           */
-          create(
-            params: MeteredItemCreateParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Billing.MeteredItem>>;
-
-          /**
-           * Retrieve a Metered Item object.
-           */
-          retrieve(
-            id: string,
-            params?: MeteredItemRetrieveParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Billing.MeteredItem>>;
-          retrieve(
-            id: string,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Billing.MeteredItem>>;
-
-          /**
-           * Update a Metered Item object. At least one of the fields is required.
-           */
-          update(
-            id: string,
-            params?: MeteredItemUpdateParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Billing.MeteredItem>>;
-
-          /**
-           * List all Metered Item objects in reverse chronological order of creation.
-           */
-          list(
-            params?: MeteredItemListParams,
-            options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.Billing.MeteredItem>;
-          list(
-            options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.Billing.MeteredItem>;
-        }
-      }
-    }
-  }
-}

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

@@ -1,109 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Billing {
-        /**
-         * The PricingPlanComponent object.
-         */
-        interface PricingPlanComponent {
-          /**
-           * 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.pricing_plan_component';
-
-          /**
-           * Time at which the object was created.
-           */
-          created: string;
-
-          /**
-           * Details if this component is a License Fee.
-           */
-          license_fee?: PricingPlanComponent.LicenseFee;
-
-          /**
-           * 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 PricingPlanComponent.
-           */
-          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 ID of the Pricing Plan this component belongs to.
-           */
-          pricing_plan: string;
-
-          /**
-           * The ID of the Pricing Plan Version this component belongs to.
-           */
-          pricing_plan_version: string;
-
-          /**
-           * Details if this component is a Rate Card.
-           */
-          rate_card?: PricingPlanComponent.RateCard;
-
-          /**
-           * Details if this component is a Service Action.
-           */
-          service_action?: PricingPlanComponent.ServiceAction;
-
-          /**
-           * The type of the PricingPlanComponent.
-           */
-          type: PricingPlanComponent.Type;
-        }
-
-        namespace PricingPlanComponent {
-          interface LicenseFee {
-            /**
-             * The ID of the License Fee.
-             */
-            id: string;
-
-            /**
-             * The version of the LicenseFee. Defaults to 'latest', if not specified.
-             */
-            version?: string;
-          }
-
-          interface RateCard {
-            /**
-             * The ID of the Rate Card.
-             */
-            id: string;
-
-            /**
-             * The version of the RateCard. Defaults to 'latest', if not specified.
-             */
-            version?: string;
-          }
-
-          interface ServiceAction {
-            /**
-             * The ID of the service action.
-             */
-            id: string;
-          }
-
-          type Type = 'license_fee' | 'rate_card' | 'service_action';
-        }
-      }
-    }
-  }
-}

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

@@ -1,57 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Billing {
-        /**
-         * A set of component subscriptions for a Pricing Plan Subscription.
-         */
-        interface PricingPlanSubscriptionComponents {
-          /**
-           * String representing the object's type. Objects of the same type share the same value of the object field.
-           */
-          object: 'v2.billing.pricing_plan_subscription_components';
-
-          /**
-           * The component subscriptions of the Pricing Plan Subscription.
-           */
-          components: Array<PricingPlanSubscriptionComponents.Component>;
-
-          /**
-           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-           */
-          livemode: boolean;
-        }
-
-        namespace PricingPlanSubscriptionComponents {
-          interface Component {
-            /**
-             * The Pricing Plan Component associated with this component subscription.
-             */
-            pricing_plan_component: string;
-
-            /**
-             * The type of subscription.
-             */
-            type: Component.Type;
-
-            /**
-             * The ID of the License Fee Subscription.
-             */
-            license_fee_subscription?: string;
-
-            /**
-             * The ID of the Rate Card Subscription.
-             */
-            rate_card_subscription?: string;
-          }
-
-          namespace Component {
-            type Type = 'license_fee_subscription' | 'rate_card_subscription';
-          }
-        }
-      }
-    }
-  }
-}

package/types/V2/Billing/PricingPlanSubscriptions/ComponentsResource.d.ts

@@ -1,40 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Billing {
-        namespace PricingPlanSubscriptions {
-          interface ComponentRetrieveParams {}
-        }
-      }
-
-      namespace Billing {
-        namespace PricingPlanSubscriptions {
-          class ComponentsResource {
-            /**
-             * Retrieve a Pricing Plan Subscription's components.
-             */
-            retrieve(
-              id: string,
-              params?: ComponentRetrieveParams,
-              options?: RequestOptions
-            ): Promise<
-              Stripe.Response<
-                Stripe.V2.Billing.PricingPlanSubscriptionComponents
-              >
-            >;
-            retrieve(
-              id: string,
-              options?: RequestOptions
-            ): Promise<
-              Stripe.Response<
-                Stripe.V2.Billing.PricingPlanSubscriptionComponents
-              >
-            >;
-          }
-        }
-      }
-    }
-  }
-}

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

@@ -1,144 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Billing {
-        /**
-         * The PricingPlanSubscription object.
-         */
-        interface PricingPlanSubscription {
-          /**
-           * 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.pricing_plan_subscription';
-
-          /**
-           * The ID of the Billing Cadence this subscription is billed on.
-           */
-          billing_cadence: string;
-
-          /**
-           * Current collection status of this subscription.
-           */
-          collection_status: PricingPlanSubscription.CollectionStatus;
-
-          /**
-           * Timestamps for collection status transitions.
-           */
-          collection_status_transitions: PricingPlanSubscription.CollectionStatusTransitions;
-
-          /**
-           * Time at which the object was created.
-           */
-          created: 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](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 ID of the Pricing Plan for this subscription.
-           */
-          pricing_plan: string;
-
-          /**
-           * The ID of the Pricing Plan Version for this subscription.
-           */
-          pricing_plan_version: string;
-
-          /**
-           * Current servicing status of this subscription.
-           */
-          servicing_status: PricingPlanSubscription.ServicingStatus;
-
-          /**
-           * Timestamps for servicing status transitions.
-           */
-          servicing_status_transitions: PricingPlanSubscription.ServicingStatusTransitions;
-
-          /**
-           * The ID of the Test Clock of the associated Billing Cadence, if any.
-           */
-          test_clock?: string;
-        }
-
-        namespace PricingPlanSubscription {
-          type CollectionStatus =
-            | 'awaiting_customer_action'
-            | 'current'
-            | 'past_due'
-            | 'paused'
-            | 'unpaid';
-
-          interface CollectionStatusTransitions {
-            /**
-             * When the collection status transitioned to awaiting customer action.
-             */
-            awaiting_customer_action_at?: string;
-
-            /**
-             * When the collection status transitioned to current.
-             */
-            current_at?: string;
-
-            /**
-             * When the collection status transitioned to past due.
-             */
-            past_due_at?: string;
-
-            /**
-             * When the collection status transitioned to paused.
-             */
-            paused_at?: string;
-
-            /**
-             * When the collection status transitioned to unpaid.
-             */
-            unpaid_at?: string;
-          }
-
-          type ServicingStatus = 'active' | 'canceled' | 'paused' | 'pending';
-
-          interface ServicingStatusTransitions {
-            /**
-             * When the servicing status transitioned to activated.
-             */
-            activated_at?: string;
-
-            /**
-             * When the servicing status transitioned to canceled.
-             */
-            canceled_at?: string;
-
-            /**
-             * When the servicing status transitioned to paused.
-             */
-            paused_at?: string;
-
-            /**
-             * When the servicing is scheduled to transition to activate.
-             */
-            will_activate_at?: string;
-
-            /**
-             * When the servicing is scheduled to cancel.
-             */
-            will_cancel_at?: string;
-          }
-        }
-      }
-    }
-  }
-}

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

@@ -1,120 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Billing {
-        interface PricingPlanSubscriptionRetrieveParams {}
-      }
-
-      namespace Billing {
-        interface PricingPlanSubscriptionUpdateParams {
-          /**
-           * When set to true, the `servicing_status_transition.will_cancel_at` field will be cleared.
-           */
-          clear_cancel_at?: boolean;
-
-          /**
-           * 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.MetadataParam;
-        }
-      }
-
-      namespace Billing {
-        interface PricingPlanSubscriptionListParams {
-          /**
-           * Filter by Billing Cadence ID. Mutually exclusive with `payer`, `pricing_plan`, and `pricing_plan_version`.
-           */
-          billing_cadence?: string;
-
-          /**
-           * Optionally set the maximum number of results per page. Defaults to 20.
-           */
-          limit?: number;
-
-          /**
-           * Filter by payer. Mutually exclusive with `billing_cadence`, `pricing_plan`, and `pricing_plan_version`.
-           */
-          payer?: PricingPlanSubscriptionListParams.Payer;
-
-          /**
-           * Filter by PricingPlan ID. Mutually exlcusive with `billing_cadence`, `payer`, and `pricing_plan_version`.
-           */
-          pricing_plan?: string;
-
-          /**
-           * Filter by Pricing Plan Version ID. Mutually exlcusive with `billing_cadence`, `payer`, and `pricing_plan`.
-           */
-          pricing_plan_version?: string;
-
-          /**
-           * Filter by servicing status.
-           */
-          servicing_status?: PricingPlanSubscriptionListParams.ServicingStatus;
-        }
-
-        namespace PricingPlanSubscriptionListParams {
-          interface Payer {
-            /**
-             * The ID of the Customer object. If provided, only Pricing Plan Subscriptions that are subscribed on the cadences with the specified payer will be returned.
-             */
-            customer?: string;
-
-            /**
-             * A string identifying the type of the payer. Currently the only supported value is `customer`.
-             */
-            type: 'customer';
-          }
-
-          type ServicingStatus = 'active' | 'canceled' | 'paused' | 'pending';
-        }
-      }
-
-      namespace Billing {
-        class PricingPlanSubscriptionsResource {
-          components: Stripe.V2.Billing.PricingPlanSubscriptions.ComponentsResource;
-
-          /**
-           * Retrieve a Pricing Plan Subscription object.
-           */
-          retrieve(
-            id: string,
-            params?: PricingPlanSubscriptionRetrieveParams,
-            options?: RequestOptions
-          ): Promise<
-            Stripe.Response<Stripe.V2.Billing.PricingPlanSubscription>
-          >;
-          retrieve(
-            id: string,
-            options?: RequestOptions
-          ): Promise<
-            Stripe.Response<Stripe.V2.Billing.PricingPlanSubscription>
-          >;
-
-          /**
-           * Update a Pricing Plan Subscription object.
-           */
-          update(
-            id: string,
-            params?: PricingPlanSubscriptionUpdateParams,
-            options?: RequestOptions
-          ): Promise<
-            Stripe.Response<Stripe.V2.Billing.PricingPlanSubscription>
-          >;
-
-          /**
-           * List all Pricing Plan Subscription objects.
-           */
-          list(
-            params?: PricingPlanSubscriptionListParams,
-            options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.Billing.PricingPlanSubscription>;
-          list(
-            options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.Billing.PricingPlanSubscription>;
-        }
-      }
-    }
-  }
-}