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

package/src/resources/v1/customers/customers.ts

@@ -92,6 +92,18 @@ export class Customers extends APIResource {
     return this._client.post('/api/v1/customers', { body, ...options });
   }
 
+  /**
+   * 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> {
+    return this._client.get(path`/api/v1/customers/${id}/entitlements`, { query, ...options });
+  }
+
   /**
    * Restores an archived customer, allowing them to create new subscriptions again.
    */
@@ -139,6 +151,128 @@ export namespace CustomerResponse {
      */
     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
      */
@@ -147,7 +281,7 @@ export namespace CustomerResponse {
     /**
      * Customer level coupon
      */
-    couponId?: string | null;
+    couponId?: (string & {}) | '' | null;
 
     /**
      * The default payment method details
@@ -164,6 +298,11 @@ export namespace CustomerResponse {
      */
     integrations?: Array<Data.Integration>;
 
+    /**
+     * Language to use for this customer
+     */
+    language?: string | null;
+
     /**
      * Additional metadata
      */
@@ -173,6 +312,16 @@ export 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;
   }
 
   export namespace Data {
@@ -235,6 +384,328 @@ export namespace CustomerResponse {
         | 'OPEN_FGA'
         | 'APP_STORE';
     }
+
+    /**
+     * Vendor-specific billing passthrough fields.
+     */
+    export interface Passthrough {
+      /**
+       * Stripe-specific billing fields for the customer.
+       */
+      stripe?: Passthrough.Stripe;
+
+      /**
+       * Zuora-specific billing fields for the customer.
+       */
+      zuora?: Passthrough.Zuora;
+    }
+
+    export namespace Passthrough {
+      /**
+       * Stripe-specific billing fields for the customer.
+       */
+      export 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>;
+      }
+
+      export namespace Stripe {
+        /**
+         * Physical address
+         */
+        export 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
+         */
+        export 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.
+         */
+        export 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.
+       */
+      export 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;
+      }
+
+      export namespace Zuora {
+        /**
+         * Physical address
+         */
+        export 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;
+        }
+      }
+    }
   }
 }
 
@@ -262,6 +733,128 @@ export interface CustomerListResponse {
    */
   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
    */
@@ -270,7 +863,7 @@ export interface CustomerListResponse {
   /**
    * Customer level coupon
    */
-  couponId?: string | null;
+  couponId?: (string & {}) | '' | null;
 
   /**
    * The default payment method details
@@ -287,6 +880,11 @@ export interface CustomerListResponse {
    */
   integrations?: Array<CustomerListResponse.Integration>;
 
+  /**
+   * Language to use for this customer
+   */
+  language?: string | null;
+
   /**
    * Additional metadata
    */
@@ -296,6 +894,16 @@ 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 namespace CustomerListResponse {
@@ -358,6 +966,328 @@ export namespace CustomerListResponse {
       | 'OPEN_FGA'
       | 'APP_STORE';
   }
+
+  /**
+   * Vendor-specific billing passthrough fields.
+   */
+  export interface Passthrough {
+    /**
+     * Stripe-specific billing fields for the customer.
+     */
+    stripe?: Passthrough.Stripe;
+
+    /**
+     * Zuora-specific billing fields for the customer.
+     */
+    zuora?: Passthrough.Zuora;
+  }
+
+  export namespace Passthrough {
+    /**
+     * Stripe-specific billing fields for the customer.
+     */
+    export 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>;
+    }
+
+    export namespace Stripe {
+      /**
+       * Physical address
+       */
+      export 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
+       */
+      export 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.
+       */
+      export 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.
+     */
+    export 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;
+    }
+
+    export namespace Zuora {
+      /**
+       * Physical address
+       */
+      export 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;
+      }
+    }
+  }
 }
 
 /**
@@ -402,7 +1332,332 @@ export interface CustomerListResourcesResponse {
   updatedAt: string;
 }
 
+/**
+ * Response object
+ */
+export interface CustomerRetrieveEntitlementsResponse {
+  /**
+   * The effective entitlements state for a customer or resource.
+   */
+  data: CustomerRetrieveEntitlementsResponse.Data;
+}
+
+export namespace CustomerRetrieveEntitlementsResponse {
+  /**
+   * The effective entitlements state for a customer or resource.
+   */
+  export 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>;
+  }
+
+  export namespace Data {
+    export 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;
+    }
+
+    export namespace Feature {
+      export 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';
+      }
+    }
+
+    export 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;
+    }
+
+    export namespace Credit {
+      /**
+       * The currency associated with a credit entitlement.
+       */
+      export 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
    */
@@ -411,7 +1666,7 @@ export interface CustomerUpdateParams {
   /**
    * Customer level coupon
    */
-  couponId?: string | null;
+  couponId?: (string & {}) | '' | null;
 
   /**
    * The email of the customer
@@ -423,6 +1678,11 @@ export interface CustomerUpdateParams {
    */
   integrations?: Array<CustomerUpdateParams.Integration>;
 
+  /**
+   * Language to use for this customer
+   */
+  language?: string | null;
+
   /**
    * Additional metadata
    */
@@ -432,6 +1692,16 @@ 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 namespace CustomerUpdateParams {
@@ -464,6 +1734,328 @@ export namespace CustomerUpdateParams {
       | 'OPEN_FGA'
       | 'APP_STORE';
   }
+
+  /**
+   * Vendor-specific billing passthrough fields.
+   */
+  export interface Passthrough {
+    /**
+     * Stripe-specific billing fields for the customer.
+     */
+    stripe?: Passthrough.Stripe;
+
+    /**
+     * Zuora-specific billing fields for the customer.
+     */
+    zuora?: Passthrough.Zuora;
+  }
+
+  export namespace Passthrough {
+    /**
+     * Stripe-specific billing fields for the customer.
+     */
+    export 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>;
+    }
+
+    export namespace Stripe {
+      /**
+       * Physical address
+       */
+      export 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
+       */
+      export 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.
+       */
+      export 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.
+     */
+    export 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;
+    }
+
+    export namespace Zuora {
+      /**
+       * Physical address
+       */
+      export 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 {
@@ -574,6 +2166,128 @@ export interface CustomerProvisionParams {
    */
   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
    */
@@ -582,7 +2296,7 @@ export interface CustomerProvisionParams {
   /**
    * Customer level coupon
    */
-  couponId?: string | null;
+  couponId?: (string & {}) | '' | null;
 
   /**
    * The default payment method details
@@ -599,6 +2313,11 @@ export interface CustomerProvisionParams {
    */
   integrations?: Array<CustomerProvisionParams.Integration>;
 
+  /**
+   * Language to use for this customer
+   */
+  language?: string | null;
+
   /**
    * Additional metadata
    */
@@ -608,6 +2327,16 @@ 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 namespace CustomerProvisionParams {
@@ -670,6 +2399,335 @@ export namespace CustomerProvisionParams {
       | 'OPEN_FGA'
       | 'APP_STORE';
   }
+
+  /**
+   * Vendor-specific billing passthrough fields.
+   */
+  export interface Passthrough {
+    /**
+     * Stripe-specific billing fields for the customer.
+     */
+    stripe?: Passthrough.Stripe;
+
+    /**
+     * Zuora-specific billing fields for the customer.
+     */
+    zuora?: Passthrough.Zuora;
+  }
+
+  export namespace Passthrough {
+    /**
+     * Stripe-specific billing fields for the customer.
+     */
+    export 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>;
+    }
+
+    export namespace Stripe {
+      /**
+       * Physical address
+       */
+      export 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
+       */
+      export 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.
+       */
+      export 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.
+     */
+    export 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;
+    }
+
+    export namespace Zuora {
+      /**
+       * Physical address
+       */
+      export 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;
 }
 
 Customers.PaymentMethod = PaymentMethod;
@@ -681,6 +2739,7 @@ export declare namespace Customers {
     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,
@@ -688,6 +2747,7 @@ export declare namespace Customers {
     type CustomerImportParams as CustomerImportParams,
     type CustomerListResourcesParams as CustomerListResourcesParams,
     type CustomerProvisionParams as CustomerProvisionParams,
+    type CustomerRetrieveEntitlementsParams as CustomerRetrieveEntitlementsParams,
   };
 
   export { PaymentMethod as PaymentMethod, type PaymentMethodAttachParams as PaymentMethodAttachParams };