stripe 21.1.0-beta.2 → 22.0.0

package/esm/resources/ConfirmationTokens.js

@@ -1,9 +1,11 @@
 // File generated from our OpenAPI spec
 import { StripeResource } from '../StripeResource.js';
-const stripeMethod = StripeResource.method;
-export const ConfirmationTokens = StripeResource.extend({
-    retrieve: stripeMethod({
-        method: 'GET',
-        fullPath: '/v1/confirmation_tokens/{confirmation_token}',
-    }),
-});
+export class ConfirmationTokenResource extends StripeResource {
+    /**
+     * Retrieves an existing ConfirmationToken object
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/confirmation_tokens/${id}`, params, options);
+    }
+}
+//# sourceMappingURL=ConfirmationTokens.js.map

package/esm/resources/ConfirmationTokens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfirmationTokens.js","sourceRoot":"","sources":["../../src/resources/ConfirmationTokens.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAOpD,MAAM,OAAO,yBAA0B,SAAQ,cAAc;IAC3D;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,2BAA2B,EAAE,EAAE,EAC/B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}

package/esm/resources/ConnectCollectionTransfers.d.ts

@@ -0,0 +1,27 @@
+import { Account } from './Accounts.js';
+export interface ConnectCollectionTransfer {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'connect_collection_transfer';
+    /**
+     * Amount transferred, 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;
+    /**
+     * ID of the account that funds are being collected for.
+     */
+    destination: string | Account;
+    /**
+     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+     */
+    livemode: boolean;
+}

package/esm/resources/ConnectCollectionTransfers.js

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec
+export {};
+//# sourceMappingURL=ConnectCollectionTransfers.js.map

package/esm/resources/ConnectCollectionTransfers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectCollectionTransfers.js","sourceRoot":"","sources":["../../src/resources/ConnectCollectionTransfers.ts"],"names":[],"mappings":"AAAA,uCAAuC"}

package/esm/resources/CountrySpecs.d.ts

@@ -0,0 +1,86 @@
+import { StripeResource } from '../StripeResource.js';
+import { PaginationParams } from '../shared.js';
+import { RequestOptions, ApiListPromise, Response } from '../lib.js';
+export declare class CountrySpecResource extends StripeResource {
+    /**
+     * Lists all Country Spec objects available in the API.
+     */
+    list(params?: CountrySpecListParams, options?: RequestOptions): ApiListPromise<CountrySpec>;
+    /**
+     * Returns a Country Spec for a given Country code.
+     */
+    retrieve(id: string, params?: CountrySpecRetrieveParams, options?: RequestOptions): Promise<Response<CountrySpec>>;
+}
+export interface CountrySpec {
+    /**
+     * Unique identifier for the object. Represented as the ISO country code for this country.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'country_spec';
+    /**
+     * The default currency for this country. This applies to both payment methods and bank accounts.
+     */
+    default_currency: string;
+    /**
+     * Currencies that can be accepted in the specific country (for transfers).
+     */
+    supported_bank_account_currencies: {
+        [key: string]: Array<string>;
+    };
+    /**
+     * Currencies that can be accepted in the specified country (for payments).
+     */
+    supported_payment_currencies: Array<string>;
+    /**
+     * Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges).
+     */
+    supported_payment_methods: Array<string>;
+    /**
+     * Countries that can accept transfers from the specified country.
+     */
+    supported_transfer_countries: Array<string>;
+    verification_fields: CountrySpec.VerificationFields;
+}
+export declare namespace CountrySpec {
+    interface VerificationFields {
+        company: VerificationFields.Company;
+        individual: VerificationFields.Individual;
+    }
+    namespace VerificationFields {
+        interface Company {
+            /**
+             * Additional fields which are only required for some users.
+             */
+            additional: Array<string>;
+            /**
+             * Fields which every account must eventually provide.
+             */
+            minimum: Array<string>;
+        }
+        interface Individual {
+            /**
+             * Additional fields which are only required for some users.
+             */
+            additional: Array<string>;
+            /**
+             * Fields which every account must eventually provide.
+             */
+            minimum: Array<string>;
+        }
+    }
+}
+export interface CountrySpecRetrieveParams {
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+}
+export interface CountrySpecListParams extends PaginationParams {
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+}

package/esm/resources/CountrySpecs.js

@@ -1,14 +1,19 @@
 // File generated from our OpenAPI spec
 import { StripeResource } from '../StripeResource.js';
-const stripeMethod = StripeResource.method;
-export const CountrySpecs = StripeResource.extend({
-    retrieve: stripeMethod({
-        method: 'GET',
-        fullPath: '/v1/country_specs/{country}',
-    }),
-    list: stripeMethod({
-        method: 'GET',
-        fullPath: '/v1/country_specs',
-        methodType: 'list',
-    }),
-});
+export class CountrySpecResource extends StripeResource {
+    /**
+     * Lists all Country Spec objects available in the API.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v1/country_specs', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Returns a Country Spec for a given Country code.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/country_specs/${id}`, params, options);
+    }
+}
+//# sourceMappingURL=CountrySpecs.js.map

package/esm/resources/CountrySpecs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CountrySpecs.js","sourceRoot":"","sources":["../../src/resources/CountrySpecs.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAIpD,MAAM,OAAO,mBAAoB,SAAQ,cAAc;IACrD;;OAEG;IACH,IAAI,CACF,MAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,OAAO,EAAE;YACpE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,qBAAqB,EAAE,EAAE,EACzB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}

package/esm/resources/Coupons.d.ts

@@ -0,0 +1,246 @@
+import { StripeResource } from '../StripeResource.js';
+import { Emptyable, MetadataParam, PaginationParams, RangeQueryParam, Metadata } from '../shared.js';
+import { RequestOptions, Response, ApiListPromise } from '../lib.js';
+export declare class CouponResource extends StripeResource {
+    /**
+     * You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.
+     */
+    del(id: string, params?: CouponDeleteParams, options?: RequestOptions): Promise<Response<DeletedCoupon>>;
+    /**
+     * Retrieves the coupon with the given ID.
+     */
+    retrieve(id: string, params?: CouponRetrieveParams, options?: RequestOptions): Promise<Response<Coupon>>;
+    /**
+     * Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
+     */
+    update(id: string, params?: CouponUpdateParams, options?: RequestOptions): Promise<Response<Coupon>>;
+    /**
+     * Returns a list of your coupons.
+     */
+    list(params?: CouponListParams, options?: RequestOptions): ApiListPromise<Coupon>;
+    /**
+     * You can create coupons easily via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.
+     *
+     * A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice's subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.
+     */
+    create(params?: CouponCreateParams, options?: RequestOptions): Promise<Response<Coupon>>;
+}
+export interface Coupon {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'coupon';
+    /**
+     * Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.
+     */
+    amount_off: number | null;
+    applies_to?: Coupon.AppliesTo;
+    /**
+     * Time at which the object was created. Measured in seconds since the Unix epoch.
+     */
+    created: number;
+    /**
+     * If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off.
+     */
+    currency: string | null;
+    /**
+     * Coupons 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).
+     */
+    currency_options?: {
+        [key: string]: Coupon.CurrencyOptions;
+    };
+    /**
+     * Always true for a deleted object
+     */
+    deleted?: void;
+    /**
+     * One of `forever`, `once`, or `repeating`. Describes how long a customer who applies this coupon will get the discount.
+     */
+    duration: Coupon.Duration;
+    /**
+     * If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.
+     */
+    duration_in_months: number | 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;
+    /**
+     * Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
+     */
+    max_redemptions: number | null;
+    /**
+     * 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: Metadata | null;
+    /**
+     * Name of the coupon displayed to customers on for instance invoices or receipts.
+     */
+    name: string | null;
+    /**
+     * Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.
+     */
+    percent_off: number | null;
+    /**
+     * Date after which the coupon can no longer be redeemed.
+     */
+    redeem_by: number | null;
+    /**
+     * Number of times this coupon has been applied to a customer.
+     */
+    times_redeemed: number;
+    /**
+     * Taking account of the above properties, whether this coupon can still be applied to a customer.
+     */
+    valid: boolean;
+}
+export interface DeletedCoupon {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'coupon';
+    /**
+     * Always true for a deleted object
+     */
+    deleted: true;
+}
+export declare namespace Coupon {
+    interface AppliesTo {
+        /**
+         * A list of product IDs this coupon applies to
+         */
+        products: Array<string>;
+    }
+    interface CurrencyOptions {
+        /**
+         * Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.
+         */
+        amount_off: number;
+    }
+    type Duration = 'forever' | 'once' | 'repeating';
+}
+export interface CouponCreateParams {
+    /**
+     * A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
+     */
+    amount_off?: number;
+    /**
+     * A hash containing directions for what this Coupon will apply discounts to.
+     */
+    applies_to?: CouponCreateParams.AppliesTo;
+    /**
+     * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
+     */
+    currency?: string;
+    /**
+     * Coupons defined in each available currency option (only supported if `amount_off` is passed). 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).
+     */
+    currency_options?: {
+        [key: string]: CouponCreateParams.CurrencyOptions;
+    };
+    /**
+     * Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
+     */
+    duration?: CouponCreateParams.Duration;
+    /**
+     * Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
+     */
+    duration_in_months?: number;
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.
+     */
+    id?: string;
+    /**
+     * A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.
+     */
+    max_redemptions?: number;
+    /**
+     * 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?: Emptyable<MetadataParam>;
+    /**
+     * Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
+     */
+    name?: string;
+    /**
+     * A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
+     */
+    percent_off?: number;
+    /**
+     * Unix timestamp specifying the last time at which the coupon can be redeemed (cannot be set to more than 5 years in the future). After the redeem_by date, the coupon can no longer be applied to new customers.
+     */
+    redeem_by?: number;
+}
+export declare namespace CouponCreateParams {
+    interface AppliesTo {
+        /**
+         * An array of Product IDs that this Coupon will apply to.
+         */
+        products?: Array<string>;
+    }
+    interface CurrencyOptions {
+        /**
+         * A positive integer representing the amount to subtract from an invoice total.
+         */
+        amount_off: number;
+    }
+    type Duration = 'forever' | 'once' | 'repeating';
+}
+export interface CouponRetrieveParams {
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+}
+export interface CouponUpdateParams {
+    /**
+     * Coupons defined in each available currency option (only supported if the coupon is amount-based). 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).
+     */
+    currency_options?: {
+        [key: string]: CouponUpdateParams.CurrencyOptions;
+    };
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * 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?: Emptyable<MetadataParam>;
+    /**
+     * Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
+     */
+    name?: string;
+}
+export declare namespace CouponUpdateParams {
+    interface CurrencyOptions {
+        /**
+         * A positive integer representing the amount to subtract from an invoice total.
+         */
+        amount_off: number;
+    }
+}
+export interface CouponListParams extends PaginationParams {
+    /**
+     * A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
+     */
+    created?: RangeQueryParam | number;
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+}
+export interface CouponDeleteParams {
+}

package/esm/resources/Coupons.js

@@ -1,14 +1,39 @@
 // File generated from our OpenAPI spec
 import { StripeResource } from '../StripeResource.js';
-const stripeMethod = StripeResource.method;
-export const Coupons = StripeResource.extend({
-    create: stripeMethod({ method: 'POST', fullPath: '/v1/coupons' }),
-    retrieve: stripeMethod({ method: 'GET', fullPath: '/v1/coupons/{coupon}' }),
-    update: stripeMethod({ method: 'POST', fullPath: '/v1/coupons/{coupon}' }),
-    list: stripeMethod({
-        method: 'GET',
-        fullPath: '/v1/coupons',
-        methodType: 'list',
-    }),
-    del: stripeMethod({ method: 'DELETE', fullPath: '/v1/coupons/{coupon}' }),
-});
+export class CouponResource extends StripeResource {
+    /**
+     * You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.
+     */
+    del(id, params, options) {
+        return this._makeRequest('DELETE', `/v1/coupons/${id}`, params, options);
+    }
+    /**
+     * Retrieves the coupon with the given ID.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/coupons/${id}`, params, options);
+    }
+    /**
+     * Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
+     */
+    update(id, params, options) {
+        return this._makeRequest('POST', `/v1/coupons/${id}`, params, options);
+    }
+    /**
+     * Returns a list of your coupons.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v1/coupons', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * You can create coupons easily via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.
+     *
+     * A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice's subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v1/coupons', params, options);
+    }
+}
+//# sourceMappingURL=Coupons.js.map

package/esm/resources/Coupons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Coupons.js","sourceRoot":"","sources":["../../src/resources/Coupons.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAUpD,MAAM,OAAO,cAAe,SAAQ,cAAc;IAChD;;OAEG;IACH,GAAG,CACD,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,QAAQ,EACR,eAAe,EAAE,EAAE,EACnB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,eAAe,EAAE,EAAE,EACnB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,eAAe,EAAE,EAAE,EACnB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,IAAI,CACF,MAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;YAC9D,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;;;OAIG;IACH,MAAM,CACJ,MAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,CAAQ,CAAC;IAC1E,CAAC;CACF"}

package/esm/resources/CreditNoteLineItems.d.ts

@@ -0,0 +1,140 @@
+import { TaxRate } from './TaxRates.js';
+import { Discount, DeletedDiscount } from './Discounts.js';
+import * as Billing from './Billing/index.js';
+import { Metadata, Decimal } from '../shared.js';
+export interface CreditNoteLineItem {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'credit_note_line_item';
+    /**
+     * The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
+     */
+    amount: number;
+    /**
+     * Description of the item being credited.
+     */
+    description: string | null;
+    /**
+     * The integer amount in cents (or local equivalent) representing the discount being credited for this line item.
+     */
+    discount_amount: number;
+    /**
+     * The amount of discount calculated per discount for this line item
+     */
+    discount_amounts: Array<CreditNoteLineItem.DiscountAmount>;
+    /**
+     * ID of the invoice line item being credited
+     */
+    invoice_line_item?: string;
+    /**
+     * 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: Metadata | null;
+    /**
+     * The pretax credit amounts (ex: discount, credit grants, etc) for this line item.
+     */
+    pretax_credit_amounts: Array<CreditNoteLineItem.PretaxCreditAmount>;
+    /**
+     * The number of units of product being credited.
+     */
+    quantity: number | null;
+    /**
+     * The tax rates which apply to the line item.
+     */
+    tax_rates: Array<TaxRate>;
+    /**
+     * The tax information of the line item.
+     */
+    taxes: Array<CreditNoteLineItem.Tax> | null;
+    /**
+     * The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.
+     */
+    type: CreditNoteLineItem.Type;
+    /**
+     * The cost of each unit of product being credited.
+     */
+    unit_amount: number | null;
+    /**
+     * Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
+     */
+    unit_amount_decimal: Decimal | null;
+}
+export declare namespace CreditNoteLineItem {
+    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 | Discount | DeletedDiscount;
+    }
+    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 | Billing.CreditBalanceTransaction;
+        /**
+         * The discount that was applied to get this pretax credit amount.
+         */
+        discount?: string | Discount | DeletedDiscount;
+        /**
+         * Type of the pretax credit amount referenced.
+         */
+        type: PretaxCreditAmount.Type;
+    }
+    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';
+    }
+    type Type = 'custom_line_item' | 'invoice_line_item';
+    namespace PretaxCreditAmount {
+        type Type = 'credit_balance_transaction' | 'discount';
+    }
+    namespace Tax {
+        type TaxBehavior = 'exclusive' | 'inclusive';
+        interface TaxRateDetails {
+            /**
+             * ID of the tax rate
+             */
+            tax_rate: string;
+        }
+        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';
+    }
+}

package/esm/resources/CreditNoteLineItems.js

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec
+export {};
+//# sourceMappingURL=CreditNoteLineItems.js.map

package/esm/resources/CreditNoteLineItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CreditNoteLineItems.js","sourceRoot":"","sources":["../../src/resources/CreditNoteLineItems.ts"],"names":[],"mappings":"AAAA,uCAAuC"}