@depup/stripe 21.0.0-depup.0

package/types/InvoiceLineItems.d.ts

@@ -0,0 +1,366 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Invoice Line Items represent the individual lines within an [invoice](https://docs.stripe.com/api/invoices) and only exist within the context of an invoice.
+     *
+     * Each line item is backed by either an [invoice item](https://docs.stripe.com/api/invoiceitems) or a [subscription item](https://docs.stripe.com/api/subscription_items).
+     */
+    interface InvoiceLineItem {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'line_item';
+
+      /**
+       * The amount, in cents (or local equivalent).
+       */
+      amount: number;
+
+      /**
+       * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+       */
+      currency: string;
+
+      /**
+       * An arbitrary string attached to the object. Often useful for displaying to users.
+       */
+      description: string | null;
+
+      /**
+       * The amount of discount calculated per discount for this line item.
+       */
+      discount_amounts: Array<InvoiceLineItem.DiscountAmount> | null;
+
+      /**
+       * If true, discounts will apply to this line item. Always false for prorations.
+       */
+      discountable: boolean;
+
+      /**
+       * The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
+       */
+      discounts: Array<string | Stripe.Discount>;
+
+      /**
+       * The ID of the invoice that contains this line item.
+       */
+      invoice: string | null;
+
+      /**
+       * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+       */
+      livemode: boolean;
+
+      /**
+       * 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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
+       */
+      metadata: Stripe.Metadata;
+
+      /**
+       * The parent that generated this line item.
+       */
+      parent: InvoiceLineItem.Parent | null;
+
+      period: InvoiceLineItem.Period;
+
+      /**
+       * Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.
+       */
+      pretax_credit_amounts: Array<InvoiceLineItem.PretaxCreditAmount> | null;
+
+      /**
+       * The pricing information of the line item.
+       */
+      pricing: InvoiceLineItem.Pricing | null;
+
+      /**
+       * Quantity of units for the invoice line item in integer format, with any decimal precision truncated. For the line item's full-precision decimal quantity, use `quantity_decimal`. This field will be deprecated in favor of `quantity_decimal` in a future version. If the line item is a proration or subscription, the quantity of the subscription that the proration was computed for.
+       */
+      quantity: number | null;
+
+      /**
+       * Non-negative decimal with at most 12 decimal places. The quantity of units for the line item.
+       */
+      quantity_decimal: Decimal | null;
+
+      subscription: string | Stripe.Subscription | null;
+
+      /**
+       * The subtotal of the line item, in cents (or local equivalent), before any discounts or taxes.
+       */
+      subtotal: number;
+
+      /**
+       * The tax information of the line item.
+       */
+      taxes: Array<InvoiceLineItem.Tax> | null;
+    }
+
+    namespace InvoiceLineItem {
+      interface DiscountAmount {
+        /**
+         * The amount, in cents (or local equivalent), of the discount.
+         */
+        amount: number;
+
+        /**
+         * The discount that was applied to get this discount amount.
+         */
+        discount: string | Stripe.Discount | Stripe.DeletedDiscount;
+      }
+
+      interface Parent {
+        /**
+         * Details about the invoice item that generated this line item
+         */
+        invoice_item_details: Parent.InvoiceItemDetails | null;
+
+        /**
+         * Details about the subscription item that generated this line item
+         */
+        subscription_item_details: Parent.SubscriptionItemDetails | null;
+
+        /**
+         * The type of parent that generated this line item
+         */
+        type: Parent.Type;
+      }
+
+      namespace Parent {
+        interface InvoiceItemDetails {
+          /**
+           * The invoice item that generated this line item
+           */
+          invoice_item: string;
+
+          /**
+           * Whether this is a proration
+           */
+          proration: boolean;
+
+          /**
+           * Additional details for proration line items
+           */
+          proration_details: InvoiceItemDetails.ProrationDetails | null;
+
+          /**
+           * The subscription that the invoice item belongs to
+           */
+          subscription: string | null;
+        }
+
+        namespace InvoiceItemDetails {
+          interface ProrationDetails {
+            /**
+             * For a credit proration `line_item`, the original debit line_items to which the credit proration applies.
+             */
+            credited_items: ProrationDetails.CreditedItems | null;
+          }
+
+          namespace ProrationDetails {
+            interface CreditedItems {
+              /**
+               * Invoice containing the credited invoice line items
+               */
+              invoice: string;
+
+              /**
+               * Credited invoice line items
+               */
+              invoice_line_items: Array<string>;
+            }
+          }
+        }
+
+        interface SubscriptionItemDetails {
+          /**
+           * The invoice item that generated this line item
+           */
+          invoice_item: string | null;
+
+          /**
+           * Whether this is a proration
+           */
+          proration: boolean;
+
+          /**
+           * Additional details for proration line items
+           */
+          proration_details: SubscriptionItemDetails.ProrationDetails | null;
+
+          /**
+           * The subscription that the subscription item belongs to
+           */
+          subscription: string | null;
+
+          /**
+           * The subscription item that generated this line item
+           */
+          subscription_item: string;
+        }
+
+        namespace SubscriptionItemDetails {
+          interface ProrationDetails {
+            /**
+             * For a credit proration `line_item`, the original debit line_items to which the credit proration applies.
+             */
+            credited_items: ProrationDetails.CreditedItems | null;
+          }
+
+          namespace ProrationDetails {
+            interface CreditedItems {
+              /**
+               * Invoice containing the credited invoice line items
+               */
+              invoice: string;
+
+              /**
+               * Credited invoice line items
+               */
+              invoice_line_items: Array<string>;
+            }
+          }
+        }
+
+        type Type = 'invoice_item_details' | 'subscription_item_details';
+      }
+
+      interface Period {
+        /**
+         * The end of the period, which must be greater than or equal to the start. This value is inclusive.
+         */
+        end: number;
+
+        /**
+         * The start of the period. This value is inclusive.
+         */
+        start: number;
+      }
+
+      interface PretaxCreditAmount {
+        /**
+         * The amount, in cents (or local equivalent), of the pretax credit amount.
+         */
+        amount: number;
+
+        /**
+         * The credit balance transaction that was applied to get this pretax credit amount.
+         */
+        credit_balance_transaction?:
+          | string
+          | Stripe.Billing.CreditBalanceTransaction
+          | null;
+
+        /**
+         * The discount that was applied to get this pretax credit amount.
+         */
+        discount?: string | Stripe.Discount | Stripe.DeletedDiscount;
+
+        /**
+         * Type of the pretax credit amount referenced.
+         */
+        type: PretaxCreditAmount.Type;
+      }
+
+      namespace PretaxCreditAmount {
+        type Type = 'credit_balance_transaction' | 'discount';
+      }
+
+      interface Pricing {
+        price_details?: Pricing.PriceDetails;
+
+        /**
+         * The type of the pricing details.
+         */
+        type: 'price_details';
+
+        /**
+         * The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
+         */
+        unit_amount_decimal: Decimal | null;
+      }
+
+      namespace Pricing {
+        interface PriceDetails {
+          /**
+           * The ID of the price this item is associated with.
+           */
+          price: string | Stripe.Price;
+
+          /**
+           * The ID of the product this item is associated with.
+           */
+          product: string;
+        }
+      }
+
+      interface Tax {
+        /**
+         * The amount of the tax, in cents (or local equivalent).
+         */
+        amount: number;
+
+        /**
+         * Whether this tax is inclusive or exclusive.
+         */
+        tax_behavior: Tax.TaxBehavior;
+
+        /**
+         * Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
+         */
+        tax_rate_details: Tax.TaxRateDetails | null;
+
+        /**
+         * The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
+         */
+        taxability_reason: Tax.TaxabilityReason;
+
+        /**
+         * The amount on which tax is calculated, in cents (or local equivalent).
+         */
+        taxable_amount: number | null;
+
+        /**
+         * The type of tax information.
+         */
+        type: 'tax_rate_details';
+      }
+
+      namespace Tax {
+        type TaxabilityReason =
+          | 'customer_exempt'
+          | 'not_available'
+          | 'not_collecting'
+          | 'not_subject_to_tax'
+          | 'not_supported'
+          | 'portion_product_exempt'
+          | 'portion_reduced_rated'
+          | 'portion_standard_rated'
+          | 'product_exempt'
+          | 'product_exempt_holiday'
+          | 'proportionally_rated'
+          | 'reduced_rated'
+          | 'reverse_charge'
+          | 'standard_rated'
+          | 'taxable_basis_reduced'
+          | 'zero_rated';
+
+        type TaxBehavior = 'exclusive' | 'inclusive';
+
+        interface TaxRateDetails {
+          /**
+           * ID of the tax rate
+           */
+          tax_rate: string;
+        }
+      }
+    }
+  }
+}

package/types/InvoicePayments.d.ts

@@ -0,0 +1,111 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Invoice Payments represent payments made against invoices. Invoice Payments can
+     * be accessed in two ways:
+     * 1. By expanding the `payments` field on the [Invoice](https://api.stripe.com#invoice) resource.
+     * 2. By using the Invoice Payment retrieve and list endpoints.
+     *
+     * Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices.
+     * This resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and
+     * monitor the allocation details of the payments.
+     */
+    interface InvoicePayment {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'invoice_payment';
+
+      /**
+       * Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent's `amount_received` is not sufficient to pay all of the invoices that it is attached to.
+       */
+      amount_paid: number | null;
+
+      /**
+       * Amount intended to be paid toward this invoice, in cents (or local equivalent)
+       */
+      amount_requested: number;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+       */
+      currency: string;
+
+      /**
+       * The invoice that was paid.
+       */
+      invoice: string | Stripe.Invoice | Stripe.DeletedInvoice;
+
+      /**
+       * Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice's `amount_remaining`. The PaymentIntent associated with the default payment can't be edited or canceled directly.
+       */
+      is_default: boolean;
+
+      /**
+       * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+       */
+      livemode: boolean;
+
+      payment: InvoicePayment.Payment;
+
+      /**
+       * The status of the payment, one of `open`, `paid`, or `canceled`.
+       */
+      status: string;
+
+      status_transitions: InvoicePayment.StatusTransitions;
+    }
+
+    namespace InvoicePayment {
+      interface Payment {
+        /**
+         * ID of the successful charge for this payment when `type` is `charge`.Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead.
+         */
+        charge?: string | Stripe.Charge;
+
+        /**
+         * ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019.
+         */
+        payment_intent?: string | Stripe.PaymentIntent;
+
+        /**
+         * ID of the PaymentRecord associated with this payment when `type` is `payment_record`.
+         */
+        payment_record?: string | Stripe.PaymentRecord;
+
+        /**
+         * Type of payment object associated with this invoice payment.
+         */
+        type: Payment.Type;
+      }
+
+      namespace Payment {
+        type Type = 'charge' | 'payment_intent' | 'payment_record';
+      }
+
+      interface StatusTransitions {
+        /**
+         * The time that the payment was canceled.
+         */
+        canceled_at: number | null;
+
+        /**
+         * The time that the payment succeeded.
+         */
+        paid_at: number | null;
+      }
+    }
+  }
+}

package/types/InvoicePaymentsResource.d.ts

@@ -0,0 +1,88 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface InvoicePaymentRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface InvoicePaymentListParams extends PaginationParams {
+      /**
+       * Only return invoice payments that were created during the given date interval.
+       */
+      created?: Stripe.RangeQueryParam | number;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * The identifier of the invoice whose payments to return.
+       */
+      invoice?: string;
+
+      /**
+       * The payment details of the invoice payments to return.
+       */
+      payment?: InvoicePaymentListParams.Payment;
+
+      /**
+       * The status of the invoice payments to return.
+       */
+      status?: InvoicePaymentListParams.Status;
+    }
+
+    namespace InvoicePaymentListParams {
+      interface Payment {
+        /**
+         * Only return invoice payments associated by this payment intent ID.
+         */
+        payment_intent?: string;
+
+        /**
+         * Only return invoice payments associated by this payment record ID.
+         */
+        payment_record?: string;
+
+        /**
+         * Only return invoice payments associated by this payment type.
+         */
+        type: Payment.Type;
+      }
+
+      namespace Payment {
+        type Type = 'payment_intent' | 'payment_record';
+      }
+
+      type Status = 'canceled' | 'open' | 'paid';
+    }
+
+    class InvoicePaymentsResource {
+      /**
+       * Retrieves the invoice payment with the given ID.
+       */
+      retrieve(
+        id: string,
+        params?: InvoicePaymentRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.InvoicePayment>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.InvoicePayment>>;
+
+      /**
+       * When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
+       */
+      list(
+        params?: InvoicePaymentListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.InvoicePayment>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.InvoicePayment>;
+    }
+  }
+}

package/types/InvoiceRenderingTemplates.d.ts

@@ -0,0 +1,55 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates
+     * can be created from within the Dashboard, and they can be used over the API when creating invoices.
+     */
+    interface InvoiceRenderingTemplate {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'invoice_rendering_template';
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+       */
+      livemode: boolean;
+
+      /**
+       * 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;
+
+      /**
+       * A brief description of the template, hidden from customers
+       */
+      nickname: string | null;
+
+      /**
+       * The status of the template, one of `active` or `archived`.
+       */
+      status: InvoiceRenderingTemplate.Status;
+
+      /**
+       * Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering
+       */
+      version: number;
+    }
+
+    namespace InvoiceRenderingTemplate {
+      type Status = 'active' | 'archived';
+    }
+  }
+}