@stigg/typescript 0.1.0-alpha.21 → 0.1.0-alpha.23

package/resources/v1/customers/customers.d.ts

@@ -42,6 +42,11 @@ export declare class Customers extends APIResource {
      * single operation.
      */
     provision(body: CustomerProvisionParams, options?: RequestOptions): APIPromise<CustomerResponse>;
+    /**
+     * Retrieves the effective entitlements for a customer or resource, including
+     * feature and credit entitlements.
+     */
+    retrieveEntitlements(id: string, query?: CustomerRetrieveEntitlementsParams | null | undefined, options?: RequestOptions): APIPromise<CustomerRetrieveEntitlementsResponse>;
     /**
      * Restores an archived customer, allowing them to create new subscriptions again.
      */
@@ -79,6 +84,10 @@ export declare namespace CustomerResponse {
          * Timestamp of when the record was last updated
          */
         updatedAt: string;
+        /**
+         * The billing currency of the customer
+         */
+        billingCurrency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf' | null;
         /**
          * The unique identifier for the entity in the billing provider
          */
@@ -86,7 +95,7 @@ export declare namespace CustomerResponse {
         /**
          * Customer level coupon
          */
-        couponId?: string | null;
+        couponId?: (string & {}) | '' | null;
         /**
          * The default payment method details
          */
@@ -99,6 +108,10 @@ export declare namespace CustomerResponse {
          * List of integrations
          */
         integrations?: Array<Data.Integration>;
+        /**
+         * Language to use for this customer
+         */
+        language?: string | null;
         /**
          * Additional metadata
          */
@@ -109,6 +122,14 @@ export declare namespace CustomerResponse {
          * The name of the customer
          */
         name?: string | null;
+        /**
+         * Vendor-specific billing passthrough fields.
+         */
+        passthrough?: Data.Passthrough;
+        /**
+         * Timezone to use for this customer
+         */
+        timezone?: string | null;
     }
     namespace Data {
         /**
@@ -153,6 +174,185 @@ export declare namespace CustomerResponse {
              */
             vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
         }
+        /**
+         * Vendor-specific billing passthrough fields.
+         */
+        interface Passthrough {
+            /**
+             * Stripe-specific billing fields for the customer.
+             */
+            stripe?: Passthrough.Stripe;
+            /**
+             * Zuora-specific billing fields for the customer.
+             */
+            zuora?: Passthrough.Zuora;
+        }
+        namespace Passthrough {
+            /**
+             * Stripe-specific billing fields for the customer.
+             */
+            interface Stripe {
+                /**
+                 * Physical address
+                 */
+                billingAddress?: Stripe.BillingAddress;
+                /**
+                 * Customer name
+                 */
+                customerName?: string;
+                /**
+                 * Invoice custom fields
+                 */
+                invoiceCustomFields?: {
+                    [key: string]: string;
+                };
+                /**
+                 * Additional metadata
+                 */
+                metadata?: {
+                    [key: string]: string;
+                };
+                /**
+                 * Billing provider payment method id, attached to this customer
+                 */
+                paymentMethodId?: string;
+                /**
+                 * Physical address
+                 */
+                shippingAddress?: Stripe.ShippingAddress;
+                /**
+                 * Tax IDs
+                 */
+                taxIds?: Array<Stripe.TaxID>;
+            }
+            namespace Stripe {
+                /**
+                 * Physical address
+                 */
+                interface BillingAddress {
+                    /**
+                     * City name
+                     */
+                    city?: string;
+                    /**
+                     * Country code or name
+                     */
+                    country?: string;
+                    /**
+                     * Street address line 1
+                     */
+                    line1?: string;
+                    /**
+                     * Street address line 2
+                     */
+                    line2?: string;
+                    /**
+                     * Postal or ZIP code
+                     */
+                    postalCode?: string;
+                    /**
+                     * State or province
+                     */
+                    state?: string;
+                }
+                /**
+                 * Physical address
+                 */
+                interface ShippingAddress {
+                    /**
+                     * City name
+                     */
+                    city?: string;
+                    /**
+                     * Country code or name
+                     */
+                    country?: string;
+                    /**
+                     * Street address line 1
+                     */
+                    line1?: string;
+                    /**
+                     * Street address line 2
+                     */
+                    line2?: string;
+                    /**
+                     * Postal or ZIP code
+                     */
+                    postalCode?: string;
+                    /**
+                     * State or province
+                     */
+                    state?: string;
+                }
+                /**
+                 * Tax identifier with type and value for customer tax exemptions.
+                 */
+                interface TaxID {
+                    /**
+                     * The type of tax exemption identifier, such as VAT.
+                     */
+                    type: string;
+                    /**
+                     * The actual tax identifier value
+                     */
+                    value: string;
+                }
+            }
+            /**
+             * Zuora-specific billing fields for the customer.
+             */
+            interface Zuora {
+                /**
+                 * Physical address
+                 */
+                billingAddress?: Zuora.BillingAddress;
+                /**
+                 * Customers selected currency
+                 */
+                currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+                /**
+                 * Additional metadata
+                 */
+                metadata?: {
+                    [key: string]: string;
+                };
+                /**
+                 * Billing provider payment method id, attached to this customer
+                 */
+                paymentMethodId?: string;
+            }
+            namespace Zuora {
+                /**
+                 * Physical address
+                 */
+                interface BillingAddress {
+                    /**
+                     * City name
+                     */
+                    city?: string;
+                    /**
+                     * Country code or name
+                     */
+                    country?: string;
+                    /**
+                     * Street address line 1
+                     */
+                    line1?: string;
+                    /**
+                     * Street address line 2
+                     */
+                    line2?: string;
+                    /**
+                     * Postal or ZIP code
+                     */
+                    postalCode?: string;
+                    /**
+                     * State or province
+                     */
+                    state?: string;
+                }
+            }
+        }
     }
 }
 /**
@@ -175,6 +375,10 @@ export interface CustomerListResponse {
      * Timestamp of when the record was last updated
      */
     updatedAt: string;
+    /**
+     * The billing currency of the customer
+     */
+    billingCurrency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf' | null;
     /**
      * The unique identifier for the entity in the billing provider
      */
@@ -182,7 +386,7 @@ export interface CustomerListResponse {
     /**
      * Customer level coupon
      */
-    couponId?: string | null;
+    couponId?: (string & {}) | '' | null;
     /**
      * The default payment method details
      */
@@ -195,6 +399,10 @@ export interface CustomerListResponse {
      * List of integrations
      */
     integrations?: Array<CustomerListResponse.Integration>;
+    /**
+     * Language to use for this customer
+     */
+    language?: string | null;
     /**
      * Additional metadata
      */
@@ -205,6 +413,14 @@ export interface CustomerListResponse {
      * The name of the customer
      */
     name?: string | null;
+    /**
+     * Vendor-specific billing passthrough fields.
+     */
+    passthrough?: CustomerListResponse.Passthrough;
+    /**
+     * Timezone to use for this customer
+     */
+    timezone?: string | null;
 }
 export declare namespace CustomerListResponse {
     /**
@@ -249,6 +465,185 @@ export declare namespace CustomerListResponse {
          */
         vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
     }
+    /**
+     * Vendor-specific billing passthrough fields.
+     */
+    interface Passthrough {
+        /**
+         * Stripe-specific billing fields for the customer.
+         */
+        stripe?: Passthrough.Stripe;
+        /**
+         * Zuora-specific billing fields for the customer.
+         */
+        zuora?: Passthrough.Zuora;
+    }
+    namespace Passthrough {
+        /**
+         * Stripe-specific billing fields for the customer.
+         */
+        interface Stripe {
+            /**
+             * Physical address
+             */
+            billingAddress?: Stripe.BillingAddress;
+            /**
+             * Customer name
+             */
+            customerName?: string;
+            /**
+             * Invoice custom fields
+             */
+            invoiceCustomFields?: {
+                [key: string]: string;
+            };
+            /**
+             * Additional metadata
+             */
+            metadata?: {
+                [key: string]: string;
+            };
+            /**
+             * Billing provider payment method id, attached to this customer
+             */
+            paymentMethodId?: string;
+            /**
+             * Physical address
+             */
+            shippingAddress?: Stripe.ShippingAddress;
+            /**
+             * Tax IDs
+             */
+            taxIds?: Array<Stripe.TaxID>;
+        }
+        namespace Stripe {
+            /**
+             * Physical address
+             */
+            interface BillingAddress {
+                /**
+                 * City name
+                 */
+                city?: string;
+                /**
+                 * Country code or name
+                 */
+                country?: string;
+                /**
+                 * Street address line 1
+                 */
+                line1?: string;
+                /**
+                 * Street address line 2
+                 */
+                line2?: string;
+                /**
+                 * Postal or ZIP code
+                 */
+                postalCode?: string;
+                /**
+                 * State or province
+                 */
+                state?: string;
+            }
+            /**
+             * Physical address
+             */
+            interface ShippingAddress {
+                /**
+                 * City name
+                 */
+                city?: string;
+                /**
+                 * Country code or name
+                 */
+                country?: string;
+                /**
+                 * Street address line 1
+                 */
+                line1?: string;
+                /**
+                 * Street address line 2
+                 */
+                line2?: string;
+                /**
+                 * Postal or ZIP code
+                 */
+                postalCode?: string;
+                /**
+                 * State or province
+                 */
+                state?: string;
+            }
+            /**
+             * Tax identifier with type and value for customer tax exemptions.
+             */
+            interface TaxID {
+                /**
+                 * The type of tax exemption identifier, such as VAT.
+                 */
+                type: string;
+                /**
+                 * The actual tax identifier value
+                 */
+                value: string;
+            }
+        }
+        /**
+         * Zuora-specific billing fields for the customer.
+         */
+        interface Zuora {
+            /**
+             * Physical address
+             */
+            billingAddress?: Zuora.BillingAddress;
+            /**
+             * Customers selected currency
+             */
+            currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+            /**
+             * Additional metadata
+             */
+            metadata?: {
+                [key: string]: string;
+            };
+            /**
+             * Billing provider payment method id, attached to this customer
+             */
+            paymentMethodId?: string;
+        }
+        namespace Zuora {
+            /**
+             * Physical address
+             */
+            interface BillingAddress {
+                /**
+                 * City name
+                 */
+                city?: string;
+                /**
+                 * Country code or name
+                 */
+                country?: string;
+                /**
+                 * Street address line 1
+                 */
+                line1?: string;
+                /**
+                 * Street address line 2
+                 */
+                line2?: string;
+                /**
+                 * Postal or ZIP code
+                 */
+                postalCode?: string;
+                /**
+                 * State or province
+                 */
+                state?: string;
+            }
+        }
+    }
 }
 /**
  * Response object
@@ -287,7 +682,150 @@ export interface CustomerListResourcesResponse {
      */
     updatedAt: string;
 }
+/**
+ * Response object
+ */
+export interface CustomerRetrieveEntitlementsResponse {
+    /**
+     * The effective entitlements state for a customer or resource.
+     */
+    data: CustomerRetrieveEntitlementsResponse.Data;
+}
+export declare namespace CustomerRetrieveEntitlementsResponse {
+    /**
+     * The effective entitlements state for a customer or resource.
+     */
+    interface Data {
+        /**
+         * Reason why entitlements access was denied, if applicable
+         */
+        accessDeniedReason: 'CustomerNotFound' | 'NoActiveSubscription' | 'CustomerIsArchived' | null;
+        /**
+         * List of effective feature and credit entitlements
+         */
+        entitlements: Array<Data.Feature | Data.Credit>;
+    }
+    namespace Data {
+        interface Feature {
+            accessDeniedReason: 'FeatureNotFound' | 'CustomerNotFound' | 'CustomerIsArchived' | 'CustomerResourceNotFound' | 'NoActiveSubscription' | 'NoFeatureEntitlementInSubscription' | 'RequestedUsageExceedingLimit' | 'RequestedValuesMismatch' | 'BudgetExceeded' | 'Unknown' | 'FeatureTypeMismatch' | 'Revoked' | 'InsufficientCredits' | 'EntitlementNotFound' | null;
+            isGranted: boolean;
+            type: 'FEATURE';
+            currentUsage?: number;
+            /**
+             * Timestamp of the last update to the entitlement grant or configuration.
+             */
+            entitlementUpdatedAt?: string;
+            feature?: Feature.Feature;
+            hasUnlimitedUsage?: boolean;
+            resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
+            usageLimit?: number | null;
+            /**
+             * The anchor for calculating the usage period for metered entitlements with a
+             * reset period configured
+             */
+            usagePeriodAnchor?: string;
+            /**
+             * The end date of the usage period for metered entitlements with a reset period
+             * configured
+             */
+            usagePeriodEnd?: string;
+            /**
+             * The start date of the usage period for metered entitlements with a reset period
+             * configured
+             */
+            usagePeriodStart?: string;
+            /**
+             * The next time the entitlement should be recalculated
+             */
+            validUntil?: string;
+        }
+        namespace Feature {
+            interface Feature {
+                /**
+                 * The unique reference ID of the entitlement.
+                 */
+                id: string;
+                /**
+                 * The human-readable name of the entitlement, shown in UI elements.
+                 */
+                displayName: string;
+                /**
+                 * The current status of the feature.
+                 */
+                featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE';
+                /**
+                 * The type of feature associated with the entitlement.
+                 */
+                featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
+            }
+        }
+        interface Credit {
+            accessDeniedReason: 'FeatureNotFound' | 'CustomerNotFound' | 'CustomerIsArchived' | 'CustomerResourceNotFound' | 'NoActiveSubscription' | 'NoFeatureEntitlementInSubscription' | 'RequestedUsageExceedingLimit' | 'RequestedValuesMismatch' | 'BudgetExceeded' | 'Unknown' | 'FeatureTypeMismatch' | 'Revoked' | 'InsufficientCredits' | 'EntitlementNotFound' | null;
+            /**
+             * The currency associated with a credit entitlement.
+             */
+            currency: Credit.Currency;
+            currentUsage: number;
+            isGranted: boolean;
+            type: 'CREDIT';
+            usageLimit: number;
+            /**
+             * Timestamp of the last update to the credit usage.
+             */
+            usageUpdatedAt: string;
+            /**
+             * Timestamp of the last update to the entitlement grant or configuration.
+             */
+            entitlementUpdatedAt?: string;
+            /**
+             * The end date of the current billing period for recurring credit grants.
+             */
+            usagePeriodEnd?: string;
+            /**
+             * The next time the entitlement should be recalculated
+             */
+            validUntil?: string;
+        }
+        namespace Credit {
+            /**
+             * The currency associated with a credit entitlement.
+             */
+            interface Currency {
+                /**
+                 * The unique identifier of the custom currency.
+                 */
+                currencyId: string;
+                /**
+                 * The display name of the currency.
+                 */
+                displayName: string;
+                /**
+                 * A description of the currency.
+                 */
+                description?: string | null;
+                /**
+                 * Additional metadata associated with the currency.
+                 */
+                metadata?: {
+                    [key: string]: string;
+                } | null;
+                /**
+                 * The plural form of the currency unit.
+                 */
+                unitPlural?: string | null;
+                /**
+                 * The singular form of the currency unit.
+                 */
+                unitSingular?: string | null;
+            }
+        }
+    }
+}
 export interface CustomerUpdateParams {
+    /**
+     * The billing currency of the customer
+     */
+    billingCurrency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf' | null;
     /**
      * The unique identifier for the entity in the billing provider
      */
@@ -295,7 +833,7 @@ export interface CustomerUpdateParams {
     /**
      * Customer level coupon
      */
-    couponId?: string | null;
+    couponId?: (string & {}) | '' | null;
     /**
      * The email of the customer
      */
@@ -304,6 +842,10 @@ export interface CustomerUpdateParams {
      * List of integrations
      */
     integrations?: Array<CustomerUpdateParams.Integration>;
+    /**
+     * Language to use for this customer
+     */
+    language?: string | null;
     /**
      * Additional metadata
      */
@@ -314,6 +856,14 @@ export interface CustomerUpdateParams {
      * The name of the customer
      */
     name?: string | null;
+    /**
+     * Vendor-specific billing passthrough fields.
+     */
+    passthrough?: CustomerUpdateParams.Passthrough;
+    /**
+     * Timezone to use for this customer
+     */
+    timezone?: string | null;
 }
 export declare namespace CustomerUpdateParams {
     /**
@@ -333,6 +883,185 @@ export declare namespace CustomerUpdateParams {
          */
         vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
     }
+    /**
+     * Vendor-specific billing passthrough fields.
+     */
+    interface Passthrough {
+        /**
+         * Stripe-specific billing fields for the customer.
+         */
+        stripe?: Passthrough.Stripe;
+        /**
+         * Zuora-specific billing fields for the customer.
+         */
+        zuora?: Passthrough.Zuora;
+    }
+    namespace Passthrough {
+        /**
+         * Stripe-specific billing fields for the customer.
+         */
+        interface Stripe {
+            /**
+             * Physical address
+             */
+            billingAddress?: Stripe.BillingAddress;
+            /**
+             * Customer name
+             */
+            customerName?: string;
+            /**
+             * Invoice custom fields
+             */
+            invoiceCustomFields?: {
+                [key: string]: string;
+            };
+            /**
+             * Additional metadata
+             */
+            metadata?: {
+                [key: string]: string;
+            };
+            /**
+             * Billing provider payment method id, attached to this customer
+             */
+            paymentMethodId?: string;
+            /**
+             * Physical address
+             */
+            shippingAddress?: Stripe.ShippingAddress;
+            /**
+             * Tax IDs
+             */
+            taxIds?: Array<Stripe.TaxID>;
+        }
+        namespace Stripe {
+            /**
+             * Physical address
+             */
+            interface BillingAddress {
+                /**
+                 * City name
+                 */
+                city?: string;
+                /**
+                 * Country code or name
+                 */
+                country?: string;
+                /**
+                 * Street address line 1
+                 */
+                line1?: string;
+                /**
+                 * Street address line 2
+                 */
+                line2?: string;
+                /**
+                 * Postal or ZIP code
+                 */
+                postalCode?: string;
+                /**
+                 * State or province
+                 */
+                state?: string;
+            }
+            /**
+             * Physical address
+             */
+            interface ShippingAddress {
+                /**
+                 * City name
+                 */
+                city?: string;
+                /**
+                 * Country code or name
+                 */
+                country?: string;
+                /**
+                 * Street address line 1
+                 */
+                line1?: string;
+                /**
+                 * Street address line 2
+                 */
+                line2?: string;
+                /**
+                 * Postal or ZIP code
+                 */
+                postalCode?: string;
+                /**
+                 * State or province
+                 */
+                state?: string;
+            }
+            /**
+             * Tax identifier with type and value for customer tax exemptions.
+             */
+            interface TaxID {
+                /**
+                 * The type of tax exemption identifier, such as VAT.
+                 */
+                type: string;
+                /**
+                 * The actual tax identifier value
+                 */
+                value: string;
+            }
+        }
+        /**
+         * Zuora-specific billing fields for the customer.
+         */
+        interface Zuora {
+            /**
+             * Physical address
+             */
+            billingAddress?: Zuora.BillingAddress;
+            /**
+             * Customers selected currency
+             */
+            currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+            /**
+             * Additional metadata
+             */
+            metadata?: {
+                [key: string]: string;
+            };
+            /**
+             * Billing provider payment method id, attached to this customer
+             */
+            paymentMethodId?: string;
+        }
+        namespace Zuora {
+            /**
+             * Physical address
+             */
+            interface BillingAddress {
+                /**
+                 * City name
+                 */
+                city?: string;
+                /**
+                 * Country code or name
+                 */
+                country?: string;
+                /**
+                 * Street address line 1
+                 */
+                line1?: string;
+                /**
+                 * Street address line 2
+                 */
+                line2?: string;
+                /**
+                 * Postal or ZIP code
+                 */
+                postalCode?: string;
+                /**
+                 * State or province
+                 */
+                state?: string;
+            }
+        }
+    }
 }
 export interface CustomerListParams extends MyCursorIDPageParams {
     /**
@@ -426,6 +1155,10 @@ export interface CustomerProvisionParams {
      * Customer slug
      */
     id: string;
+    /**
+     * The billing currency of the customer
+     */
+    billingCurrency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf' | null;
     /**
      * The unique identifier for the entity in the billing provider
      */
@@ -433,7 +1166,7 @@ export interface CustomerProvisionParams {
     /**
      * Customer level coupon
      */
-    couponId?: string | null;
+    couponId?: (string & {}) | '' | null;
     /**
      * The default payment method details
      */
@@ -446,6 +1179,10 @@ export interface CustomerProvisionParams {
      * List of integrations
      */
     integrations?: Array<CustomerProvisionParams.Integration>;
+    /**
+     * Language to use for this customer
+     */
+    language?: string | null;
     /**
      * Additional metadata
      */
@@ -456,6 +1193,14 @@ export interface CustomerProvisionParams {
      * The name of the customer
      */
     name?: string | null;
+    /**
+     * Vendor-specific billing passthrough fields.
+     */
+    passthrough?: CustomerProvisionParams.Passthrough;
+    /**
+     * Timezone to use for this customer
+     */
+    timezone?: string | null;
 }
 export declare namespace CustomerProvisionParams {
     /**
@@ -500,9 +1245,194 @@ export declare namespace CustomerProvisionParams {
          */
         vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
     }
+    /**
+     * Vendor-specific billing passthrough fields.
+     */
+    interface Passthrough {
+        /**
+         * Stripe-specific billing fields for the customer.
+         */
+        stripe?: Passthrough.Stripe;
+        /**
+         * Zuora-specific billing fields for the customer.
+         */
+        zuora?: Passthrough.Zuora;
+    }
+    namespace Passthrough {
+        /**
+         * Stripe-specific billing fields for the customer.
+         */
+        interface Stripe {
+            /**
+             * Physical address
+             */
+            billingAddress?: Stripe.BillingAddress;
+            /**
+             * Customer name
+             */
+            customerName?: string;
+            /**
+             * Invoice custom fields
+             */
+            invoiceCustomFields?: {
+                [key: string]: string;
+            };
+            /**
+             * Additional metadata
+             */
+            metadata?: {
+                [key: string]: string;
+            };
+            /**
+             * Billing provider payment method id, attached to this customer
+             */
+            paymentMethodId?: string;
+            /**
+             * Physical address
+             */
+            shippingAddress?: Stripe.ShippingAddress;
+            /**
+             * Tax IDs
+             */
+            taxIds?: Array<Stripe.TaxID>;
+        }
+        namespace Stripe {
+            /**
+             * Physical address
+             */
+            interface BillingAddress {
+                /**
+                 * City name
+                 */
+                city?: string;
+                /**
+                 * Country code or name
+                 */
+                country?: string;
+                /**
+                 * Street address line 1
+                 */
+                line1?: string;
+                /**
+                 * Street address line 2
+                 */
+                line2?: string;
+                /**
+                 * Postal or ZIP code
+                 */
+                postalCode?: string;
+                /**
+                 * State or province
+                 */
+                state?: string;
+            }
+            /**
+             * Physical address
+             */
+            interface ShippingAddress {
+                /**
+                 * City name
+                 */
+                city?: string;
+                /**
+                 * Country code or name
+                 */
+                country?: string;
+                /**
+                 * Street address line 1
+                 */
+                line1?: string;
+                /**
+                 * Street address line 2
+                 */
+                line2?: string;
+                /**
+                 * Postal or ZIP code
+                 */
+                postalCode?: string;
+                /**
+                 * State or province
+                 */
+                state?: string;
+            }
+            /**
+             * Tax identifier with type and value for customer tax exemptions.
+             */
+            interface TaxID {
+                /**
+                 * The type of tax exemption identifier, such as VAT.
+                 */
+                type: string;
+                /**
+                 * The actual tax identifier value
+                 */
+                value: string;
+            }
+        }
+        /**
+         * Zuora-specific billing fields for the customer.
+         */
+        interface Zuora {
+            /**
+             * Physical address
+             */
+            billingAddress?: Zuora.BillingAddress;
+            /**
+             * Customers selected currency
+             */
+            currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+            /**
+             * Additional metadata
+             */
+            metadata?: {
+                [key: string]: string;
+            };
+            /**
+             * Billing provider payment method id, attached to this customer
+             */
+            paymentMethodId?: string;
+        }
+        namespace Zuora {
+            /**
+             * Physical address
+             */
+            interface BillingAddress {
+                /**
+                 * City name
+                 */
+                city?: string;
+                /**
+                 * Country code or name
+                 */
+                country?: string;
+                /**
+                 * Street address line 1
+                 */
+                line1?: string;
+                /**
+                 * Street address line 2
+                 */
+                line2?: string;
+                /**
+                 * Postal or ZIP code
+                 */
+                postalCode?: string;
+                /**
+                 * State or province
+                 */
+                state?: string;
+            }
+        }
+    }
+}
+export interface CustomerRetrieveEntitlementsParams {
+    /**
+     * Resource ID to scope entitlements to a specific resource
+     */
+    resourceId?: string;
 }
 export declare namespace Customers {
-    export { type CustomerResponse as CustomerResponse, type CustomerListResponse as CustomerListResponse, type CustomerImportResponse as CustomerImportResponse, type CustomerListResourcesResponse as CustomerListResourcesResponse, type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage, type CustomerListResourcesResponsesMyCursorIDPage as CustomerListResourcesResponsesMyCursorIDPage, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerImportParams as CustomerImportParams, type CustomerListResourcesParams as CustomerListResourcesParams, type CustomerProvisionParams as CustomerProvisionParams, };
+    export { type CustomerResponse as CustomerResponse, type CustomerListResponse as CustomerListResponse, type CustomerImportResponse as CustomerImportResponse, type CustomerListResourcesResponse as CustomerListResourcesResponse, type CustomerRetrieveEntitlementsResponse as CustomerRetrieveEntitlementsResponse, type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage, type CustomerListResourcesResponsesMyCursorIDPage as CustomerListResourcesResponsesMyCursorIDPage, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerImportParams as CustomerImportParams, type CustomerListResourcesParams as CustomerListResourcesParams, type CustomerProvisionParams as CustomerProvisionParams, type CustomerRetrieveEntitlementsParams as CustomerRetrieveEntitlementsParams, };
     export { PaymentMethod as PaymentMethod, type PaymentMethodAttachParams as PaymentMethodAttachParams };
     export { PromotionalEntitlements as PromotionalEntitlements, type PromotionalEntitlementCreateResponse as PromotionalEntitlementCreateResponse, type PromotionalEntitlementListResponse as PromotionalEntitlementListResponse, type PromotionalEntitlementRevokeResponse as PromotionalEntitlementRevokeResponse, type PromotionalEntitlementListResponsesMyCursorIDPage as PromotionalEntitlementListResponsesMyCursorIDPage, type PromotionalEntitlementCreateParams as PromotionalEntitlementCreateParams, type PromotionalEntitlementListParams as PromotionalEntitlementListParams, type PromotionalEntitlementRevokeParams as PromotionalEntitlementRevokeParams, };
 }