@metronome/sdk 0.2.0 → 1.0.0

package/resources/v1/customers/customers.d.mts

@@ -0,0 +1,818 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as Shared from "../../shared.mjs";
+import * as AlertsAPI from "./alerts.mjs";
+import { AlertListParams, AlertResetParams, AlertRetrieveParams, AlertRetrieveResponse, Alerts, CustomerAlert, CustomerAlertsCursorPageWithoutLimit } from "./alerts.mjs";
+import * as BillingConfigAPI from "./billing-config.mjs";
+import { BillingConfig as BillingConfigAPIBillingConfig, BillingConfigCreateParams, BillingConfigDeleteParams, BillingConfigRetrieveParams, BillingConfigRetrieveResponse } from "./billing-config.mjs";
+import * as CommitsAPI from "./commits.mjs";
+import { CommitCreateParams, CommitCreateResponse, CommitListParams, CommitUpdateEndDateParams, CommitUpdateEndDateResponse, Commits } from "./commits.mjs";
+import * as CreditsAPI from "./credits.mjs";
+import { CreditCreateParams, CreditCreateResponse, CreditListParams, CreditUpdateEndDateParams, CreditUpdateEndDateResponse, Credits } from "./credits.mjs";
+import * as InvoicesAPI from "./invoices.mjs";
+import { Invoice, InvoiceAddChargeParams, InvoiceAddChargeResponse, InvoiceListBreakdownsParams, InvoiceListBreakdownsResponse, InvoiceListBreakdownsResponsesCursorPage, InvoiceListParams, InvoiceRetrieveParams, InvoiceRetrieveResponse, Invoices, InvoicesCursorPage } from "./invoices.mjs";
+import * as NamedSchedulesAPI from "./named-schedules.mjs";
+import { NamedScheduleRetrieveParams, NamedScheduleRetrieveResponse, NamedScheduleUpdateParams, NamedSchedules } from "./named-schedules.mjs";
+import * as PlansAPI from "./plans.mjs";
+import { PlanAddParams, PlanAddResponse, PlanEndParams, PlanEndResponse, PlanListParams, PlanListPriceAdjustmentsParams, PlanListPriceAdjustmentsResponse, PlanListPriceAdjustmentsResponsesCursorPage, PlanListResponse, PlanListResponsesCursorPage, Plans } from "./plans.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../../../core/pagination.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+export declare class Customers extends APIResource {
+    alerts: AlertsAPI.Alerts;
+    plans: PlansAPI.Plans;
+    invoices: InvoicesAPI.Invoices;
+    billingConfig: BillingConfigAPI.BillingConfig;
+    commits: CommitsAPI.Commits;
+    credits: CreditsAPI.Credits;
+    namedSchedules: NamedSchedulesAPI.NamedSchedules;
+    /**
+     * Create a new customer in Metronome and optionally the billing configuration
+     * (recommended) which dictates where invoices for the customer will be sent or
+     * where payment will be collected.
+     *
+     * ### Use this endpoint to:
+     *
+     * Execute your customer provisioning workflows for either PLG motions, where
+     * customers originate in your platform, or SLG motions, where customers originate
+     * in your sales system.
+     *
+     * ### Key response fields:
+     *
+     * This end-point returns the `customer_id` created by the request. This id can be
+     * used to fetch relevant billing configurations and create contracts.
+     *
+     * ### Example workflow:
+     *
+     * - Generally, Metronome recommends first creating the customer in the downstream
+     *   payment / ERP system when payment method is collected and then creating the
+     *   customer in Metronome using the response (i.e. `customer_id`) from the
+     *   downstream system. If you do not create a billing configuration on customer
+     *   creation, you can add it later.
+     * - Once a customer is created, you can then create a contract for the customer.
+     *   In the contract creation process, you will need to add the customer billing
+     *   configuration to the contract to ensure Metronome invoices the customer
+     *   correctly. This is because a customer can have multiple configurations.
+     * - As part of the customer creation process, set the ingest alias for the
+     *   customer which will ensure usage is accurately mapped to the customer. Ingest
+     *   aliases can be added or changed after the creation process as well.
+     *
+     * ### Usage guidelines:
+     *
+     * For details on different billing configurations for different systems, review
+     * the `/setCustomerBillingConfiguration` end-point.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.v1.customers.create({
+     *   name: 'Example, Inc.',
+     *   customer_billing_provider_configurations: [
+     *     {
+     *       billing_provider: 'stripe',
+     *       delivery_method: 'direct_to_billing_provider',
+     *       configuration: {
+     *         stripe_customer_id: 'cus_123',
+     *         stripe_collection_method: 'charge_automatically',
+     *       },
+     *     },
+     *   ],
+     *   ingest_aliases: ['team@example.com'],
+     * });
+     * ```
+     */
+    create(body: CustomerCreateParams, options?: RequestOptions): APIPromise<CustomerCreateResponse>;
+    /**
+     * Get detailed information for a specific customer by their Metronome ID. Returns
+     * customer profile data including name, creation date, ingest aliases,
+     * configuration settings, and custom fields. Use this endpoint to fetch complete
+     * customer details for billing operations or account management.
+     *
+     * Note: If searching for a customer billing configuration, use the
+     * `/getCustomerBillingConfigurations` endpoint.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.v1.customers.retrieve({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     * });
+     * ```
+     */
+    retrieve(params: CustomerRetrieveParams, options?: RequestOptions): APIPromise<CustomerRetrieveResponse>;
+    /**
+     * Gets a paginated list of all customers in your Metronome account. Use this
+     * endpoint to browse your customer base, implement customer search functionality,
+     * or sync customer data with external systems. Returns customer details including
+     * IDs, names, and configuration settings. Supports filtering and pagination
+     * parameters for efficient data retrieval.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customerDetail of client.v1.customers.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: CustomerListParams | null | undefined, options?: RequestOptions): PagePromise<CustomerDetailsCursorPage, CustomerDetail>;
+    /**
+     * Use this endpoint to archive a customer while preserving auditability. Archiving
+     * a customer will automatically archive all contracts as of the current date and
+     * void all corresponding invoices. Use this endpoint if a customer is onboarded by
+     * mistake.
+     *
+     * ### Usage guidelines:
+     *
+     * - Once a customer is archived, it cannot be unarchived.
+     * - Archived customers can still be viewed through the API or the UI for audit
+     *   purposes.
+     * - Ingest aliases remain idempotent for archived customers. In order to reuse an
+     *   ingest alias, first remove the ingest alias from the customer prior to
+     *   archiving.
+     * - Any alerts associated with the customer will no longer be triggered.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.archive({
+     *   id: '8deed800-1b7a-495d-a207-6c52bac54dc9',
+     * });
+     * ```
+     */
+    archive(body: CustomerArchiveParams, options?: RequestOptions): APIPromise<CustomerArchiveResponse>;
+    /**
+     * Get all billable metrics available for a specific customer. Supports pagination
+     * and filtering by current plan status or archived metrics. Use this endpoint to
+     * see which metrics are being tracked for billing calculations for a given
+     * customer.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customerListBillableMetricsResponse of client.v1.customers.listBillableMetrics(
+     *   { customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    listBillableMetrics(params: CustomerListBillableMetricsParams, options?: RequestOptions): PagePromise<CustomerListBillableMetricsResponsesCursorPage, CustomerListBillableMetricsResponse>;
+    /**
+     * Fetch daily pending costs for the specified customer, broken down by credit type
+     * and line items. Note: this is not supported for customers whose plan includes a
+     * UNIQUE-type billable metric.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customerListCostsResponse of client.v1.customers.listCosts(
+     *   {
+     *     customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     ending_before: '2019-12-27T18:11:19.117Z',
+     *     starting_on: '2019-12-27T18:11:19.117Z',
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    listCosts(params: CustomerListCostsParams, options?: RequestOptions): PagePromise<CustomerListCostsResponsesCursorPage, CustomerListCostsResponse>;
+    /**
+     * Preview how a set of events will affect a customer's invoice. Generates a draft
+     * invoice for a customer using their current contract configuration and the
+     * provided events. This is useful for testing how new events will affect the
+     * customer's invoice before they are actually processed.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.previewEvents({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   events: [
+     *     {
+     *       event_type: 'heartbeat',
+     *       timestamp: '2021-01-01T00:00:00Z',
+     *       properties: { cpu_hours: 100, memory_gb_hours: 200 },
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    previewEvents(params: CustomerPreviewEventsParams, options?: RequestOptions): APIPromise<CustomerPreviewEventsResponse>;
+    /**
+     * Returns all billing configurations previously set for the customer. Use during
+     * the contract provisioning process to fetch the
+     * `billing_provider_configuration_id` needed to set the contract billing
+     * configuration.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.customers.retrieveBillingConfigurations({
+     *     customer_id: '6a37bb88-8538-48c5-b37b-a41c836328bd',
+     *   });
+     * ```
+     */
+    retrieveBillingConfigurations(body: CustomerRetrieveBillingConfigurationsParams, options?: RequestOptions): APIPromise<CustomerRetrieveBillingConfigurationsResponse>;
+    /**
+     * Create a billing configuration for a customer. Once created, these
+     * configurations are available to associate to a contract and dictates which
+     * downstream system to collect payment in or send the invoice to. You can create
+     * multiple configurations per customer. The configuration formats are distinct for
+     * each downstream provider.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Add the initial configuration to an existing customer. Once created, the
+     *   billing configuration can then be associated to the customer's contract.
+     * - Add a new configuration to an existing customer. This might be used as part of
+     *   an upgrade or downgrade workflow where the customer was previously billed
+     *   through system A (e.g. Stripe) but will now be billed through system B (e.g.
+     *   AWS). Once created, the new configuration can then be associated to the
+     *   customer's contract.
+     *
+     * ### Delivery method options:
+     *
+     * - `direct_to_billing_provider`: Use when Metronome should send invoices directly
+     *   to the billing provider's API (e.g., Stripe, NetSuite). This is the most
+     *   common method for automated billing workflows.
+     * - `tackle`: Use specifically for AWS Marketplace transactions that require
+     *   Tackle's co-selling platform for partner attribution and commission tracking.
+     * - `aws_sqs`: Use when you want invoice data delivered to an AWS SQS queue for
+     *   custom processing before sending to your billing system.
+     * - `aws_sns`: Use when you want invoice notifications published to an AWS SNS
+     *   topic for event-driven billing workflows.
+     *
+     * ### Key response fields:
+     *
+     * The id for the customer billing configuration. This id can be used to associate
+     * the billing configuration to a contract.
+     *
+     * ### Usage guidelines:
+     *
+     * Must use the `delivery_method_id` if you have multiple Stripe accounts connected
+     * to Metronome.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.setBillingConfigurations({
+     *   data: [
+     *     {
+     *       customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
+     *       billing_provider: 'stripe',
+     *       configuration: { ... },
+     *       delivery_method: 'direct_to_billing_provider',
+     *     },
+     *     {
+     *       customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
+     *       billing_provider: 'aws_marketplace',
+     *       configuration: { ... },
+     *       delivery_method: 'direct_to_billing_provider',
+     *     },
+     *     {
+     *       customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
+     *       billing_provider: 'azure_marketplace',
+     *       configuration: { ... },
+     *       delivery_method_id: '5b9e3072-415b-4842-94f0-0b6700c8b6be',
+     *     },
+     *     {
+     *       customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
+     *       billing_provider: 'aws_marketplace',
+     *       configuration: { ... },
+     *       delivery_method: 'direct_to_billing_provider',
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    setBillingConfigurations(body: CustomerSetBillingConfigurationsParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Sets the ingest aliases for a customer. Use this endpoint to associate a
+     * Metronome customer with an internal ID for easier tracking between systems.
+     * Ingest aliases can be used in the `customer_id` field when sending usage events
+     * to Metronome.
+     *
+     * ### Usage guidelines:
+     *
+     * - This call is idempotent and fully replaces the set of ingest aliases for the
+     *   given customer.
+     * - Switching an ingest alias from one customer to another will associate all
+     *   corresponding usage to the new customer.
+     * - Use multiple ingest aliases to model child organizations within a single
+     *   Metronome customer.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.setIngestAliases({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   ingest_aliases: ['team@example.com'],
+     * });
+     * ```
+     */
+    setIngestAliases(params: CustomerSetIngestAliasesParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Updates the display name for a customer record. Use this to correct customer
+     * names, update business names after rebranding, or maintain accurate customer
+     * information for invoicing and reporting. Returns the updated customer object
+     * with the new name applied immediately across all billing documents and
+     * interfaces.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.setName({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   name: 'Example, Inc.',
+     * });
+     * ```
+     */
+    setName(params: CustomerSetNameParams, options?: RequestOptions): APIPromise<CustomerSetNameResponse>;
+    /**
+     * Update configuration settings for a specific customer, such as external system
+     * integrations (e.g., Salesforce account ID) and other customer-specific billing
+     * parameters. Use this endpoint to modify customer configurations without
+     * affecting core customer data like name or ingest aliases.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.updateConfig({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   salesforce_account_id: '0015500001WO1ZiABL',
+     * });
+     * ```
+     */
+    updateConfig(params: CustomerUpdateConfigParams, options?: RequestOptions): APIPromise<void>;
+}
+export type CustomerDetailsCursorPage = CursorPage<CustomerDetail>;
+export type CustomerListBillableMetricsResponsesCursorPage = CursorPage<CustomerListBillableMetricsResponse>;
+export type CustomerListCostsResponsesCursorPage = CursorPage<CustomerListCostsResponse>;
+export interface Customer {
+    /**
+     * the Metronome ID of the customer
+     */
+    id: string;
+    /**
+     * (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
+     * alias) that can be used in usage events
+     */
+    external_id: string;
+    /**
+     * aliases for this customer that can be used instead of the Metronome customer ID
+     * in usage events
+     */
+    ingest_aliases: Array<string>;
+    name: string;
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
+    custom_fields?: {
+        [key: string]: string;
+    };
+}
+export interface CustomerDetail {
+    /**
+     * the Metronome ID of the customer
+     */
+    id: string;
+    /**
+     * RFC 3339 timestamp indicating when the customer was created.
+     */
+    created_at: string;
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
+    custom_fields: {
+        [key: string]: string;
+    };
+    customer_config: CustomerDetail.CustomerConfig;
+    /**
+     * (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
+     * alias) that can be used in usage events
+     */
+    external_id: string;
+    /**
+     * aliases for this customer that can be used instead of the Metronome customer ID
+     * in usage events
+     */
+    ingest_aliases: Array<string>;
+    name: string;
+    /**
+     * RFC 3339 timestamp indicating when the customer was archived. Null if the
+     * customer is active.
+     */
+    archived_at?: string | null;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    current_billable_status?: CustomerDetail.CurrentBillableStatus;
+}
+export declare namespace CustomerDetail {
+    interface CustomerConfig {
+        /**
+         * The Salesforce account ID for the customer
+         */
+        salesforce_account_id: string | null;
+    }
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    interface CurrentBillableStatus {
+        value: 'billable' | 'unbillable';
+        effective_at?: string | null;
+    }
+}
+export interface CustomerCreateResponse {
+    data: Customer;
+}
+export interface CustomerRetrieveResponse {
+    data: CustomerDetail;
+}
+export interface CustomerArchiveResponse {
+    data: Shared.ID;
+}
+export interface CustomerListBillableMetricsResponse {
+    id: string;
+    name: string;
+    /**
+     * (DEPRECATED) use aggregation_type instead
+     */
+    aggregate?: string;
+    /**
+     * (DEPRECATED) use aggregation_key instead
+     */
+    aggregate_keys?: Array<string>;
+    /**
+     * A key that specifies which property of the event is used to aggregate data. This
+     * key must be one of the property filter names and is not applicable when the
+     * aggregation type is 'count'.
+     */
+    aggregation_key?: string;
+    /**
+     * Specifies the type of aggregation performed on matching events.
+     */
+    aggregation_type?: 'COUNT' | 'LATEST' | 'MAX' | 'SUM' | 'UNIQUE';
+    /**
+     * RFC 3339 timestamp indicating when the billable metric was archived. If not
+     * provided, the billable metric is not archived.
+     */
+    archived_at?: string;
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
+    custom_fields?: {
+        [key: string]: string;
+    };
+    /**
+     * An optional filtering rule to match the 'event_type' property of an event.
+     */
+    event_type_filter?: Shared.EventTypeFilter;
+    /**
+     * (DEPRECATED) use property_filters & event_type_filter instead
+     */
+    filter?: {
+        [key: string]: unknown;
+    };
+    /**
+     * (DEPRECATED) use group_keys instead
+     */
+    group_by?: Array<string>;
+    /**
+     * Property names that are used to group usage costs on an invoice. Each entry
+     * represents a set of properties used to slice events into distinct buckets.
+     */
+    group_keys?: Array<Array<string>>;
+    /**
+     * A list of filters to match events to this billable metric. Each filter defines a
+     * rule on an event property. All rules must pass for the event to match the
+     * billable metric.
+     */
+    property_filters?: Array<Shared.PropertyFilter>;
+    /**
+     * The SQL query associated with the billable metric
+     */
+    sql?: string;
+}
+export interface CustomerListCostsResponse {
+    credit_types: {
+        [key: string]: CustomerListCostsResponse.CreditTypes;
+    };
+    end_timestamp: string;
+    start_timestamp: string;
+}
+export declare namespace CustomerListCostsResponse {
+    interface CreditTypes {
+        cost?: number;
+        line_item_breakdown?: Array<CreditTypes.LineItemBreakdown>;
+        name?: string;
+    }
+    namespace CreditTypes {
+        interface LineItemBreakdown {
+            cost: number;
+            name: string;
+            group_key?: string;
+            group_value?: string | null;
+        }
+    }
+}
+export interface CustomerPreviewEventsResponse {
+    data: InvoicesAPI.Invoice;
+}
+export interface CustomerRetrieveBillingConfigurationsResponse {
+    data: Array<CustomerRetrieveBillingConfigurationsResponse.Data>;
+}
+export declare namespace CustomerRetrieveBillingConfigurationsResponse {
+    interface Data {
+        /**
+         * ID of this configuration; can be provided as the
+         * billing_provider_configuration_id when creating a contract.
+         */
+        id: string;
+        archived_at: string | null;
+        /**
+         * The billing provider set for this configuration.
+         */
+        billing_provider: 'aws_marketplace' | 'stripe' | 'netsuite' | 'custom' | 'azure_marketplace' | 'quickbooks_online' | 'workday' | 'gcp_marketplace';
+        /**
+         * Configuration for the billing provider. The structure of this object is specific
+         * to the billing provider.
+         */
+        configuration: {
+            [key: string]: unknown;
+        };
+        customer_id: string;
+        /**
+         * The method to use for delivering invoices to this customer.
+         */
+        delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
+        /**
+         * Configuration for the delivery method. The structure of this object is specific
+         * to the delivery method.
+         */
+        delivery_method_configuration: {
+            [key: string]: unknown;
+        };
+        /**
+         * ID of the delivery method to use for this customer.
+         */
+        delivery_method_id: string;
+    }
+}
+export interface CustomerSetNameResponse {
+    data: Customer;
+}
+export interface CustomerCreateParams {
+    /**
+     * This will be truncated to 160 characters if the provided name is longer.
+     */
+    name: string;
+    billing_config?: CustomerCreateParams.BillingConfig;
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
+    custom_fields?: {
+        [key: string]: string;
+    };
+    customer_billing_provider_configurations?: Array<CustomerCreateParams.CustomerBillingProviderConfiguration>;
+    /**
+     * (deprecated, use ingest_aliases instead) an alias that can be used to refer to
+     * this customer in usage events
+     */
+    external_id?: string;
+    /**
+     * Aliases that can be used to refer to this customer in usage events
+     */
+    ingest_aliases?: Array<string>;
+}
+export declare namespace CustomerCreateParams {
+    interface BillingConfig {
+        billing_provider_customer_id: string;
+        billing_provider_type: 'aws_marketplace' | 'stripe' | 'netsuite' | 'custom' | 'azure_marketplace' | 'quickbooks_online' | 'workday' | 'gcp_marketplace';
+        /**
+         * True if the aws_product_code is a SAAS subscription product, false otherwise.
+         */
+        aws_is_subscription_product?: boolean;
+        aws_product_code?: string;
+        aws_region?: 'af-south-1' | 'ap-east-1' | 'ap-northeast-1' | 'ap-northeast-2' | 'ap-northeast-3' | 'ap-south-1' | 'ap-southeast-1' | 'ap-southeast-2' | 'ca-central-1' | 'cn-north-1' | 'cn-northwest-1' | 'eu-central-1' | 'eu-north-1' | 'eu-south-1' | 'eu-west-1' | 'eu-west-2' | 'eu-west-3' | 'me-south-1' | 'sa-east-1' | 'us-east-1' | 'us-east-2' | 'us-gov-east-1' | 'us-gov-west-1' | 'us-west-1' | 'us-west-2';
+        stripe_collection_method?: 'charge_automatically' | 'send_invoice' | 'auto_charge_payment_intent' | 'manually_charge_payment_intent';
+    }
+    interface CustomerBillingProviderConfiguration {
+        /**
+         * The billing provider set for this configuration.
+         */
+        billing_provider: 'aws_marketplace' | 'azure_marketplace' | 'gcp_marketplace' | 'stripe' | 'netsuite';
+        /**
+         * Configuration for the billing provider. The structure of this object is specific
+         * to the billing provider and delivery provider combination. Defaults to an empty
+         * object, however, for most billing provider + delivery method combinations, it
+         * will not be a valid configuration.
+         */
+        configuration?: {
+            [key: string]: unknown;
+        };
+        /**
+         * The method to use for delivering invoices to this customer. If not provided, the
+         * `delivery_method_id` must be provided.
+         */
+        delivery_method?: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
+        /**
+         * ID of the delivery method to use for this customer. If not provided, the
+         * `delivery_method` must be provided.
+         */
+        delivery_method_id?: string;
+        /**
+         * Specifies which tax provider Metronome should use for tax calculation when
+         * billing through Stripe. This is only supported for Stripe billing provider
+         * configurations with auto_charge_payment_intent or manual_charge_payment_intent
+         * collection methods.
+         */
+        tax_provider?: 'anrok' | 'avalara' | 'stripe';
+    }
+}
+export interface CustomerRetrieveParams {
+    customer_id: string;
+}
+export interface CustomerListParams extends CursorPageParams {
+    /**
+     * Filter the customer list by customer_id. Up to 100 ids can be provided.
+     */
+    customer_ids?: Array<string>;
+    /**
+     * Filter the customer list by ingest_alias
+     */
+    ingest_alias?: string;
+    /**
+     * Filter the customer list to only return archived customers. By default, only
+     * active customers are returned.
+     */
+    only_archived?: boolean;
+    /**
+     * Filter the customer list by salesforce_account_id. Up to 100 ids can be
+     * provided.
+     */
+    salesforce_account_ids?: Array<string>;
+}
+export interface CustomerArchiveParams {
+    id: string;
+}
+export interface CustomerListBillableMetricsParams extends CursorPageParams {
+    /**
+     * Path param:
+     */
+    customer_id: string;
+    /**
+     * Query param: If true, the list of returned metrics will include archived metrics
+     */
+    include_archived?: boolean;
+    /**
+     * Query param: If true, the list of metrics will be filtered to just ones that are
+     * on the customer's current plan
+     */
+    on_current_plan?: boolean;
+}
+export interface CustomerListCostsParams extends CursorPageParams {
+    /**
+     * Path param:
+     */
+    customer_id: string;
+    /**
+     * Query param: RFC 3339 timestamp (exclusive)
+     */
+    ending_before: string;
+    /**
+     * Query param: RFC 3339 timestamp (inclusive)
+     */
+    starting_on: string;
+}
+export interface CustomerPreviewEventsParams {
+    /**
+     * Path param:
+     */
+    customer_id: string;
+    /**
+     * Body param:
+     */
+    events: Array<CustomerPreviewEventsParams.Event>;
+    /**
+     * Body param: If set to "replace", the preview will be generated as if those were
+     * the only events for the specified customer. If set to "merge", the events will
+     * be merged with any existing events for the specified customer. Defaults to
+     * "replace".
+     */
+    mode?: 'replace' | 'merge';
+    /**
+     * Body param: If set, all zero quantity line items will be filtered out of the
+     * response.
+     */
+    skip_zero_qty_line_items?: boolean;
+}
+export declare namespace CustomerPreviewEventsParams {
+    interface Event {
+        event_type: string;
+        /**
+         * This has no effect for preview events, but may be set for consistency with Event
+         * objects. They will be processed even if they do not match the customer's ID or
+         * ingest aliases.
+         */
+        customer_id?: string;
+        properties?: {
+            [key: string]: unknown;
+        };
+        /**
+         * RFC 3339 formatted. If not provided, the current time will be used.
+         */
+        timestamp?: string;
+        /**
+         * This has no effect for preview events, but may be set for consistency with Event
+         * objects. Duplicate transaction_ids are NOT filtered out, even within the same
+         * request.
+         */
+        transaction_id?: string;
+    }
+}
+export interface CustomerRetrieveBillingConfigurationsParams {
+    customer_id: string;
+    include_archived?: boolean;
+}
+export interface CustomerSetBillingConfigurationsParams {
+    data: Array<CustomerSetBillingConfigurationsParams.Data>;
+}
+export declare namespace CustomerSetBillingConfigurationsParams {
+    interface Data {
+        /**
+         * The billing provider set for this configuration.
+         */
+        billing_provider: 'aws_marketplace' | 'stripe' | 'netsuite' | 'custom' | 'azure_marketplace' | 'quickbooks_online' | 'workday' | 'gcp_marketplace';
+        customer_id: string;
+        /**
+         * Configuration for the billing provider. The structure of this object is specific
+         * to the billing provider and delivery method combination. Defaults to an empty
+         * object, however, for most billing provider + delivery method combinations, it
+         * will not be a valid configuration. For AWS marketplace configurations, the
+         * aws_is_subscription_product flag can be used to indicate a product with
+         * usage-based pricing. More information can be found
+         * [here](https://docs.metronome.com/invoice-customers/solutions/marketplaces/invoice-aws/#provision-aws-marketplace-customers-in-metronome).
+         */
+        configuration?: {
+            [key: string]: unknown;
+        };
+        /**
+         * The method to use for delivering invoices to this customer. If not provided, the
+         * `delivery_method_id` must be provided.
+         */
+        delivery_method?: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
+        /**
+         * ID of the delivery method to use for this customer. If not provided, the
+         * `delivery_method` must be provided.
+         */
+        delivery_method_id?: string;
+        /**
+         * Specifies which tax provider Metronome should use for tax calculation when
+         * billing through Stripe. This is only supported for Stripe billing provider
+         * configurations with auto_charge_payment_intent or manual_charge_payment_intent
+         * collection methods.
+         */
+        tax_provider?: 'anrok' | 'avalara' | 'stripe';
+    }
+}
+export interface CustomerSetIngestAliasesParams {
+    /**
+     * Path param:
+     */
+    customer_id: string;
+    /**
+     * Body param:
+     */
+    ingest_aliases: Array<string>;
+}
+export interface CustomerSetNameParams {
+    /**
+     * Path param:
+     */
+    customer_id: string;
+    /**
+     * Body param: The new name for the customer. This will be truncated to 160
+     * characters if the provided name is longer.
+     */
+    name: string;
+}
+export interface CustomerUpdateConfigParams {
+    /**
+     * Path param:
+     */
+    customer_id: string;
+    /**
+     * Body param: Leave in draft or set to auto-advance on invoices sent to Stripe.
+     * Falls back to the client-level config if unset, which defaults to true if unset.
+     */
+    leave_stripe_invoices_in_draft?: boolean | null;
+    /**
+     * Body param: The Salesforce account ID for the customer
+     */
+    salesforce_account_id?: string | null;
+}
+export declare namespace Customers {
+    export { type Customer as Customer, type CustomerDetail as CustomerDetail, type CustomerCreateResponse as CustomerCreateResponse, type CustomerRetrieveResponse as CustomerRetrieveResponse, type CustomerArchiveResponse as CustomerArchiveResponse, type CustomerListBillableMetricsResponse as CustomerListBillableMetricsResponse, type CustomerListCostsResponse as CustomerListCostsResponse, type CustomerPreviewEventsResponse as CustomerPreviewEventsResponse, type CustomerRetrieveBillingConfigurationsResponse as CustomerRetrieveBillingConfigurationsResponse, type CustomerSetNameResponse as CustomerSetNameResponse, type CustomerDetailsCursorPage as CustomerDetailsCursorPage, type CustomerListBillableMetricsResponsesCursorPage as CustomerListBillableMetricsResponsesCursorPage, type CustomerListCostsResponsesCursorPage as CustomerListCostsResponsesCursorPage, type CustomerCreateParams as CustomerCreateParams, type CustomerRetrieveParams as CustomerRetrieveParams, type CustomerListParams as CustomerListParams, type CustomerArchiveParams as CustomerArchiveParams, type CustomerListBillableMetricsParams as CustomerListBillableMetricsParams, type CustomerListCostsParams as CustomerListCostsParams, type CustomerPreviewEventsParams as CustomerPreviewEventsParams, type CustomerRetrieveBillingConfigurationsParams as CustomerRetrieveBillingConfigurationsParams, type CustomerSetBillingConfigurationsParams as CustomerSetBillingConfigurationsParams, type CustomerSetIngestAliasesParams as CustomerSetIngestAliasesParams, type CustomerSetNameParams as CustomerSetNameParams, type CustomerUpdateConfigParams as CustomerUpdateConfigParams, };
+    export { Alerts as Alerts, type CustomerAlert as CustomerAlert, type AlertRetrieveResponse as AlertRetrieveResponse, type CustomerAlertsCursorPageWithoutLimit as CustomerAlertsCursorPageWithoutLimit, type AlertRetrieveParams as AlertRetrieveParams, type AlertListParams as AlertListParams, type AlertResetParams as AlertResetParams, };
+    export { Plans as Plans, type PlanListResponse as PlanListResponse, type PlanAddResponse as PlanAddResponse, type PlanEndResponse as PlanEndResponse, type PlanListPriceAdjustmentsResponse as PlanListPriceAdjustmentsResponse, type PlanListResponsesCursorPage as PlanListResponsesCursorPage, type PlanListPriceAdjustmentsResponsesCursorPage as PlanListPriceAdjustmentsResponsesCursorPage, type PlanListParams as PlanListParams, type PlanAddParams as PlanAddParams, type PlanEndParams as PlanEndParams, type PlanListPriceAdjustmentsParams as PlanListPriceAdjustmentsParams, };
+    export { Invoices as Invoices, type Invoice as Invoice, type InvoiceRetrieveResponse as InvoiceRetrieveResponse, type InvoiceAddChargeResponse as InvoiceAddChargeResponse, type InvoiceListBreakdownsResponse as InvoiceListBreakdownsResponse, type InvoicesCursorPage as InvoicesCursorPage, type InvoiceListBreakdownsResponsesCursorPage as InvoiceListBreakdownsResponsesCursorPage, type InvoiceRetrieveParams as InvoiceRetrieveParams, type InvoiceListParams as InvoiceListParams, type InvoiceAddChargeParams as InvoiceAddChargeParams, type InvoiceListBreakdownsParams as InvoiceListBreakdownsParams, };
+    export { BillingConfigAPIBillingConfig as BillingConfig, type BillingConfigRetrieveResponse as BillingConfigRetrieveResponse, type BillingConfigCreateParams as BillingConfigCreateParams, type BillingConfigRetrieveParams as BillingConfigRetrieveParams, type BillingConfigDeleteParams as BillingConfigDeleteParams, };
+    export { Commits as Commits, type CommitCreateResponse as CommitCreateResponse, type CommitUpdateEndDateResponse as CommitUpdateEndDateResponse, type CommitCreateParams as CommitCreateParams, type CommitListParams as CommitListParams, type CommitUpdateEndDateParams as CommitUpdateEndDateParams, };
+    export { Credits as Credits, type CreditCreateResponse as CreditCreateResponse, type CreditUpdateEndDateResponse as CreditUpdateEndDateResponse, type CreditCreateParams as CreditCreateParams, type CreditListParams as CreditListParams, type CreditUpdateEndDateParams as CreditUpdateEndDateParams, };
+    export { NamedSchedules as NamedSchedules, type NamedScheduleRetrieveResponse as NamedScheduleRetrieveResponse, type NamedScheduleRetrieveParams as NamedScheduleRetrieveParams, type NamedScheduleUpdateParams as NamedScheduleUpdateParams, };
+}
+//# sourceMappingURL=customers.d.mts.map