@metronome/sdk 2.1.0 → 3.0.0

package/src/resources/v1/custom-fields.ts

@@ -180,7 +180,11 @@ export interface CustomFieldListKeysResponse {
     | 'product'
     | 'rate_card'
     | 'scheduled_charge'
-    | 'subscription';
+    | 'subscription'
+    | 'package_commit'
+    | 'package_credit'
+    | 'package_subscription'
+    | 'package_scheduled_charge';
 
   key: string;
 }
@@ -206,7 +210,11 @@ export interface CustomFieldAddKeyParams {
     | 'product'
     | 'rate_card'
     | 'scheduled_charge'
-    | 'subscription';
+    | 'subscription'
+    | 'package_commit'
+    | 'package_credit'
+    | 'package_subscription'
+    | 'package_scheduled_charge';
 
   key: string;
 }
@@ -230,7 +238,11 @@ export interface CustomFieldDeleteValuesParams {
     | 'product'
     | 'rate_card'
     | 'scheduled_charge'
-    | 'subscription';
+    | 'subscription'
+    | 'package_commit'
+    | 'package_credit'
+    | 'package_subscription'
+    | 'package_scheduled_charge';
 
   entity_id: string;
 
@@ -260,6 +272,10 @@ export interface CustomFieldListKeysParams extends CursorPageWithoutLimitParams
     | 'rate_card'
     | 'scheduled_charge'
     | 'subscription'
+    | 'package_commit'
+    | 'package_credit'
+    | 'package_subscription'
+    | 'package_scheduled_charge'
   >;
 }
 
@@ -282,7 +298,11 @@ export interface CustomFieldRemoveKeyParams {
     | 'product'
     | 'rate_card'
     | 'scheduled_charge'
-    | 'subscription';
+    | 'subscription'
+    | 'package_commit'
+    | 'package_credit'
+    | 'package_subscription'
+    | 'package_scheduled_charge';
 
   key: string;
 }
@@ -311,7 +331,11 @@ export interface CustomFieldSetValuesParams {
     | 'product'
     | 'rate_card'
     | 'scheduled_charge'
-    | 'subscription';
+    | 'subscription'
+    | 'package_commit'
+    | 'package_credit'
+    | 'package_subscription'
+    | 'package_scheduled_charge';
 
   entity_id: string;
 }

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

@@ -283,6 +283,12 @@ export namespace CustomerAlert {
      */
     invoice_types_filter?: Array<string>;
 
+    /**
+     * Only present for low_remaining_seat_balance_reached notifications. The seat
+     * group key or seat group key-value pair the alert is scoped to.
+     */
+    seat_filter?: Alert.SeatFilter;
+
     /**
      * Prevents the creation of duplicates. If a request to create a record is made
      * with a previously used uniqueness key, a new record will not be created and the
@@ -315,6 +321,22 @@ export namespace CustomerAlert {
 
       value?: string;
     }
+
+    /**
+     * Only present for low_remaining_seat_balance_reached notifications. The seat
+     * group key or seat group key-value pair the alert is scoped to.
+     */
+    export interface SeatFilter {
+      /**
+       * The seat group key (e.g., "seat_id", "user_id") that the alert is scoped to.
+       */
+      seat_group_key: string;
+
+      /**
+       * The seat group value that the alert is scoped to.
+       */
+      seat_group_value?: string;
+    }
   }
 }
 
@@ -344,6 +366,12 @@ export interface AlertRetrieveParams {
    * denotes whether to fetch notifications for plans or contracts.
    */
   plans_or_contracts?: 'PLANS' | 'CONTRACTS';
+
+  /**
+   * Only allowed for `low_remaining_seat_balance_reached` notifications. This
+   * filters alerts by the seat group key-value pair.
+   */
+  seat_filter?: AlertRetrieveParams.SeatFilter;
 }
 
 export namespace AlertRetrieveParams {
@@ -356,6 +384,22 @@ export namespace AlertRetrieveParams {
 
     value: string;
   }
+
+  /**
+   * Only allowed for `low_remaining_seat_balance_reached` notifications. This
+   * filters alerts by the seat group key-value pair.
+   */
+  export interface SeatFilter {
+    /**
+     * The seat group key (e.g., "seat_id", "user_id")
+     */
+    seat_group_key: string;
+
+    /**
+     * The specific seat identifier to filter by
+     */
+    seat_group_value: string;
+  }
 }
 
 export interface AlertListParams extends CursorPageWithoutLimitParams {

package/src/resources/v1/customers/billing-config.ts

@@ -82,6 +82,10 @@ export interface BillingConfigRetrieveResponse {
 
 export namespace BillingConfigRetrieveResponse {
   export interface Data {
+    aws_customer_account_id?: string;
+
+    aws_customer_id?: string;
+
     /**
      * Contract expiration date for the customer. The expected format is RFC 3339 and
      * can be retrieved from
@@ -157,7 +161,7 @@ export namespace BillingConfigRetrieveResponse {
 
 export interface BillingConfigCreateParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -182,12 +186,22 @@ export interface BillingConfigCreateParams {
   billing_provider_customer_id: string;
 
   /**
-   * Body param:
+   * Body param
+   */
+  aws_customer_account_id?: string;
+
+  /**
+   * Body param
+   */
+  aws_customer_id?: string;
+
+  /**
+   * Body param
    */
   aws_product_code?: string;
 
   /**
-   * Body param:
+   * Body param
    */
   aws_region?:
     | 'af-south-1'

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

@@ -372,7 +372,7 @@ export class Customers extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.customers.setBillingConfigurations({
+   * const response = await client.v1.customers.setBillingConfigurations({
    *   data: [
    *     {
    *       customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
@@ -398,6 +398,12 @@ export class Customers extends APIResource {
    *       configuration: { ... },
    *       delivery_method: 'direct_to_billing_provider',
    *     },
+   *     {
+   *       customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
+   *       billing_provider: 'gcp_marketplace',
+   *       configuration: { ... },
+   *       delivery_method: 'direct_to_billing_provider',
+   *     },
    *   ],
    * });
    * ```
@@ -405,12 +411,8 @@ export class Customers extends APIResource {
   setBillingConfigurations(
     body: CustomerSetBillingConfigurationsParams,
     options?: RequestOptions,
-  ): APIPromise<void> {
-    return this._client.post('/v1/setCustomerBillingProviderConfigurations', {
-      body,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  ): APIPromise<CustomerSetBillingConfigurationsResponse> {
+    return this._client.post('/v1/setCustomerBillingProviderConfigurations', { body, ...options });
   }
 
   /**
@@ -760,6 +762,54 @@ export namespace CustomerRetrieveBillingConfigurationsResponse {
   }
 }
 
+export interface CustomerSetBillingConfigurationsResponse {
+  data: Array<CustomerSetBillingConfigurationsResponse.Data>;
+}
+
+export namespace CustomerSetBillingConfigurationsResponse {
+  export interface Data {
+    /**
+     * ID of the created configuration
+     */
+    id?: string;
+
+    /**
+     * The billing provider set for this configuration.
+     */
+    billing_provider?:
+      | 'aws_marketplace'
+      | 'stripe'
+      | 'netsuite'
+      | 'custom'
+      | 'azure_marketplace'
+      | 'quickbooks_online'
+      | 'workday'
+      | 'gcp_marketplace'
+      | 'metronome';
+
+    /**
+     * Configuration for the billing provider. The structure of this object is specific
+     * to the billing provider and delivery method combination.
+     */
+    configuration?: { [key: string]: unknown };
+
+    /**
+     * ID of the customer this configuration is associated with.
+     */
+    customer_id?: string;
+
+    /**
+     * ID of the delivery method used for this customer configuration.
+     */
+    delivery_method_id?: string;
+
+    /**
+     * The tax provider set for this configuration.
+     */
+    tax_provider?: 'anrok' | 'avalara' | 'stripe';
+  }
+}
+
 export interface CustomerSetNameResponse {
   data: Customer;
 }
@@ -779,6 +829,8 @@ export interface CustomerCreateParams {
 
   customer_billing_provider_configurations?: Array<CustomerCreateParams.CustomerBillingProviderConfiguration>;
 
+  customer_revenue_system_configurations?: Array<CustomerCreateParams.CustomerRevenueSystemConfiguration>;
+
   /**
    * (deprecated, use ingest_aliases instead) an alias that can be used to refer to
    * this customer in usage events
@@ -806,6 +858,10 @@ export namespace CustomerCreateParams {
       | 'gcp_marketplace'
       | 'metronome';
 
+    aws_customer_account_id?: string;
+
+    aws_customer_id?: string;
+
     /**
      * True if the aws_product_code is a SAAS subscription product, false otherwise.
      */
@@ -885,6 +941,32 @@ export namespace CustomerCreateParams {
      */
     tax_provider?: 'anrok' | 'avalara' | 'stripe';
   }
+
+  export interface CustomerRevenueSystemConfiguration {
+    /**
+     * The revenue system provider set for this configuration.
+     */
+    provider: 'netsuite';
+
+    /**
+     * Configuration for the revenue system provider. The structure of this object is
+     * specific to the revenue system provider. For NetSuite, this should contain
+     * `netsuite_customer_id`.
+     */
+    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';
+
+    /**
+     * ID of the delivery method to use for this customer. If not provided, the
+     * `delivery_method` must be provided.
+     */
+    delivery_method_id?: string;
+  }
 }
 
 export interface CustomerRetrieveParams {
@@ -921,7 +1003,7 @@ export interface CustomerArchiveParams {
 
 export interface CustomerListBillableMetricsParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -939,7 +1021,7 @@ export interface CustomerListBillableMetricsParams extends CursorPageParams {
 
 export interface CustomerListCostsParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -956,7 +1038,7 @@ export interface CustomerListCostsParams extends CursorPageParams {
 
 export interface CustomerPreviewEventsParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -1064,19 +1146,19 @@ export namespace CustomerSetBillingConfigurationsParams {
 
 export interface CustomerSetIngestAliasesParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
   /**
-   * Body param:
+   * Body param
    */
   ingest_aliases: Array<string>;
 }
 
 export interface CustomerSetNameParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -1089,7 +1171,7 @@ export interface CustomerSetNameParams {
 
 export interface CustomerUpdateConfigParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -1124,6 +1206,7 @@ export declare namespace Customers {
     type CustomerListCostsResponse as CustomerListCostsResponse,
     type CustomerPreviewEventsResponse as CustomerPreviewEventsResponse,
     type CustomerRetrieveBillingConfigurationsResponse as CustomerRetrieveBillingConfigurationsResponse,
+    type CustomerSetBillingConfigurationsResponse as CustomerSetBillingConfigurationsResponse,
     type CustomerSetNameResponse as CustomerSetNameResponse,
     type CustomerDetailsCursorPage as CustomerDetailsCursorPage,
     type CustomerListBillableMetricsResponsesCursorPage as CustomerListBillableMetricsResponsesCursorPage,

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

@@ -43,6 +43,7 @@ export {
   type CustomerListCostsResponse,
   type CustomerPreviewEventsResponse,
   type CustomerRetrieveBillingConfigurationsResponse,
+  type CustomerSetBillingConfigurationsResponse,
   type CustomerSetNameResponse,
   type CustomerCreateParams,
   type CustomerRetrieveParams,

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

@@ -367,6 +367,8 @@ export interface Invoice {
    */
   reseller_royalty?: Invoice.ResellerRoyalty;
 
+  revenue_system_invoices?: Array<Invoice.RevenueSystemInvoice> | null;
+
   /**
    * This field's availability is dependent on your client's configuration.
    */
@@ -738,10 +740,16 @@ export namespace Invoice {
        */
       billing_provider_error?: string;
 
+      /**
+       * The ID of the payment in the external system, if available.
+       */
+      external_payment_id?: string;
+
       external_status?:
         | 'DRAFT'
         | 'FINALIZED'
         | 'PAID'
+        | 'PARTIALLY_PAID'
         | 'UNCOLLECTIBLE'
         | 'VOID'
         | 'DELETED'
@@ -816,10 +824,16 @@ export namespace Invoice {
      */
     billing_provider_error?: string;
 
+    /**
+     * The ID of the payment in the external system, if available.
+     */
+    external_payment_id?: string;
+
     external_status?:
       | 'DRAFT'
       | 'FINALIZED'
       | 'PAID'
+      | 'PARTIALLY_PAID'
       | 'UNCOLLECTIBLE'
       | 'VOID'
       | 'DELETED'
@@ -931,6 +945,21 @@ export namespace Invoice {
       gcp_offer_id?: string;
     }
   }
+
+  export interface RevenueSystemInvoice {
+    revenue_system_external_entity_type: string;
+
+    revenue_system_provider: string;
+
+    sync_status: string;
+
+    /**
+     * The error message from the revenue system, if available.
+     */
+    error_message?: string;
+
+    revenue_system_external_entity_id?: string;
+  }
 }
 
 export interface InvoiceRetrieveResponse {
@@ -947,12 +976,12 @@ export interface InvoiceListBreakdownsResponse extends Invoice {
 
 export interface InvoiceRetrieveParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
   /**
-   * Path param:
+   * Path param
    */
   invoice_id: string;
 
@@ -965,7 +994,7 @@ export interface InvoiceRetrieveParams {
 
 export interface InvoiceListParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -1006,7 +1035,7 @@ export interface InvoiceListParams extends CursorPageParams {
 
 export interface InvoiceAddChargeParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -1023,7 +1052,7 @@ export interface InvoiceAddChargeParams {
   customer_plan_id: string;
 
   /**
-   * Body param:
+   * Body param
    */
   description: string;
 
@@ -1039,14 +1068,14 @@ export interface InvoiceAddChargeParams {
   price: number;
 
   /**
-   * Body param:
+   * Body param
    */
   quantity: number;
 }
 
 export interface InvoiceListBreakdownsParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 

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

@@ -184,6 +184,8 @@ export namespace PlanListPriceAdjustmentsResponse {
      */
     adjustment_type: 'fixed' | 'quantity' | 'percentage' | 'override';
 
+    quantity?: number;
+
     /**
      * Used in pricing tiers. Indicates at what metric value the price applies.
      */
@@ -195,19 +197,19 @@ export namespace PlanListPriceAdjustmentsResponse {
 
 export interface PlanListParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 }
 
 export interface PlanAddParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
   /**
-   * Body param:
+   * Body param
    */
   plan_id: string;
 
@@ -324,7 +326,7 @@ export namespace PlanAddParams {
 
 export interface PlanEndParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -357,7 +359,7 @@ export interface PlanEndParams {
 
 export interface PlanListPriceAdjustmentsParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 

package/src/resources/v1/index.ts

@@ -92,6 +92,7 @@ export {
   type CustomerListCostsResponse,
   type CustomerPreviewEventsResponse,
   type CustomerRetrieveBillingConfigurationsResponse,
+  type CustomerSetBillingConfigurationsResponse,
   type CustomerSetNameResponse,
   type CustomerCreateParams,
   type CustomerRetrieveParams,

package/src/resources/v1/payments.ts

@@ -95,6 +95,8 @@ export interface Payment {
 
   payment_gateway?: Payment.PaymentGateway;
 
+  revenue_system_payments?: Array<Payment.RevenueSystemPayment>;
+
   status?: PaymentStatus;
 
   updated_at?: string;
@@ -126,6 +128,19 @@ export namespace Payment {
       }
     }
   }
+
+  export interface RevenueSystemPayment {
+    revenue_system_provider: string;
+
+    sync_status: string;
+
+    /**
+     * The error message from the revenue system, if available.
+     */
+    error_message?: string;
+
+    revenue_system_external_payment_id?: string;
+  }
 }
 
 export type PaymentStatus = 'pending' | 'requires_intervention' | 'paid' | 'canceled';

package/src/resources/v1/plans.ts

@@ -306,14 +306,14 @@ export interface PlanGetDetailsParams {
 
 export interface PlanListChargesParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   plan_id: string;
 }
 
 export interface PlanListCustomersParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   plan_id: string;
 

package/src/resources/v1/settings/billing-providers.ts

@@ -107,7 +107,7 @@ export interface BillingProviderCreateParams {
   /**
    * The billing provider set for this configuration.
    */
-  billing_provider: 'aws_marketplace' | 'azure_marketplace';
+  billing_provider: 'aws_marketplace' | 'azure_marketplace' | 'gcp_marketplace';
 
   /**
    * Account-level configuration for the billing provider. The structure of this

package/src/resources/v1/settings/settings.ts

@@ -33,6 +33,7 @@ export class Settings extends APIResource {
    *     delivery_method_ids: [
    *       '9a906ebb-fbc7-42e8-8e29-53bfd2db3aca',
    *     ],
+   *     commit_transactions: true,
    *   });
    * ```
    */
@@ -67,6 +68,12 @@ export interface SettingUpsertAvalaraCredentialsParams {
    * found in the response of the `/listConfiguredBillingProviders` endpoint.
    */
   delivery_method_ids: Array<string>;
+
+  /**
+   * Commit transactions if you want Metronome tax calculations used for reporting
+   * and tax filings.
+   */
+  commit_transactions?: boolean;
 }
 
 Settings.BillingProviders = BillingProviders;