api.md

Shared Types

from metronome.types import (
    BalanceFilter,
    BaseThresholdCommit,
    BaseUsageFilter,
    Commit,
    CommitHierarchyConfiguration,
    CommitRate,
    CommitSpecifier,
    CommitSpecifierInput,
    Contract,
    ContractV2,
    ContractWithoutAmendments,
    Credit,
    CreditTypeData,
    Discount,
    EventTypeFilter,
    HierarchyConfiguration,
    ID,
    Override,
    OverrideTier,
    OverwriteRate,
    PaymentGateConfig,
    PaymentGateConfigV2,
    PrepaidBalanceThresholdConfiguration,
    PrepaidBalanceThresholdConfigurationV2,
    PropertyFilter,
    ProService,
    Rate,
    RecurringCommitSubscriptionConfig,
    ScheduledCharge,
    ScheduleDuration,
    SchedulePointInTime,
    SpendThresholdConfiguration,
    SpendThresholdConfigurationV2,
    Subscription,
    Tier,
    UpdateBaseThresholdCommit,
)

V2

Contracts

Types:

from metronome.types.v2 import (
    ContractRetrieveResponse,
    ContractListResponse,
    ContractEditResponse,
    ContractEditCommitResponse,
    ContractEditCreditResponse,
    ContractGetEditHistoryResponse,
)

Methods:

• client.v2.contracts.retrieve(**params) -> ContractRetrieveResponse
• client.v2.contracts.list(**params) -> ContractListResponse
• client.v2.contracts.edit(**params) -> ContractEditResponse
• client.v2.contracts.edit_commit(**params) -> ContractEditCommitResponse
• client.v2.contracts.edit_credit(**params) -> ContractEditCreditResponse
• client.v2.contracts.get_edit_history(**params) -> ContractGetEditHistoryResponse

V1

Alerts

Types:

from metronome.types.v1 import AlertCreateResponse, AlertArchiveResponse

Methods:

• client.v1.alerts.create(**params) -> AlertCreateResponse
• client.v1.alerts.archive(**params) -> AlertArchiveResponse

Plans

Types:

from metronome.types.v1 import (
    PlanDetail,
    PlanListResponse,
    PlanGetDetailsResponse,
    PlanListChargesResponse,
    PlanListCustomersResponse,
)

Methods:

• client.v1.plans.list(**params) -> SyncCursorPage[PlanListResponse]
• client.v1.plans.get_details(*, plan_id) -> PlanGetDetailsResponse
• client.v1.plans.list_charges(*, plan_id, **params) -> SyncCursorPage[PlanListChargesResponse]
• client.v1.plans.list_customers(*, plan_id, **params) -> SyncCursorPage[PlanListCustomersResponse]

CreditGrants

Types:

from metronome.types.v1 import (
    CreditLedgerEntry,
    RolloverAmountMaxAmount,
    RolloverAmountMaxPercentage,
    CreditGrantCreateResponse,
    CreditGrantListResponse,
    CreditGrantEditResponse,
    CreditGrantListEntriesResponse,
    CreditGrantVoidResponse,
)

Methods:

• client.v1.credit_grants.create(**params) -> CreditGrantCreateResponse
• client.v1.credit_grants.list(**params) -> SyncCursorPage[CreditGrantListResponse]
• client.v1.credit_grants.edit(**params) -> CreditGrantEditResponse
• client.v1.credit_grants.list_entries(**params) -> SyncCursorPageWithoutLimit[CreditGrantListEntriesResponse]
• client.v1.credit_grants.void(**params) -> CreditGrantVoidResponse

PricingUnits

Types:

from metronome.types.v1 import PricingUnitListResponse

Methods:

• client.v1.pricing_units.list(**params) -> SyncCursorPage[PricingUnitListResponse]

Customers

Types:

from metronome.types.v1 import (
    Customer,
    CustomerDetail,
    CustomerCreateResponse,
    CustomerRetrieveResponse,
    CustomerArchiveResponse,
    CustomerArchiveBillingConfigurationsResponse,
    CustomerListBillableMetricsResponse,
    CustomerListCostsResponse,
    CustomerPreviewEventsResponse,
    CustomerRetrieveBillingConfigurationsResponse,
    CustomerSetBillingConfigurationsResponse,
    CustomerSetNameResponse,
)

Methods:

• client.v1.customers.create(**params) -> CustomerCreateResponse
• client.v1.customers.retrieve(*, customer_id) -> CustomerRetrieveResponse
• client.v1.customers.list(**params) -> SyncCursorPage[CustomerDetail]
• client.v1.customers.archive(**params) -> CustomerArchiveResponse
• client.v1.customers.archive_billing_configurations(**params) -> CustomerArchiveBillingConfigurationsResponse
• client.v1.customers.list_billable_metrics(*, customer_id, **params) -> SyncCursorPage[CustomerListBillableMetricsResponse]
• client.v1.customers.list_costs(*, customer_id, **params) -> SyncCursorPage[CustomerListCostsResponse]
• client.v1.customers.preview_events(*, customer_id, **params) -> CustomerPreviewEventsResponse
• client.v1.customers.retrieve_billing_configurations(**params) -> CustomerRetrieveBillingConfigurationsResponse
• client.v1.customers.set_billing_configurations(**params) -> CustomerSetBillingConfigurationsResponse
• client.v1.customers.set_ingest_aliases(*, customer_id, **params) -> None
• client.v1.customers.set_name(*, customer_id, **params) -> CustomerSetNameResponse
• client.v1.customers.update_config(*, customer_id, **params) -> None

Alerts

Types:

from metronome.types.v1.customers import CustomerAlert, AlertRetrieveResponse

Methods:

• client.v1.customers.alerts.retrieve(**params) -> AlertRetrieveResponse
• client.v1.customers.alerts.list(**params) -> SyncCursorPageWithoutLimit[CustomerAlert]
• client.v1.customers.alerts.reset(**params) -> None

Plans

Types:

from metronome.types.v1.customers import (
    PlanListResponse,
    PlanAddResponse,
    PlanEndResponse,
    PlanListPriceAdjustmentsResponse,
)

Methods:

• client.v1.customers.plans.list(*, customer_id, **params) -> SyncCursorPage[PlanListResponse]
• client.v1.customers.plans.add(*, customer_id, **params) -> PlanAddResponse
• client.v1.customers.plans.end(*, customer_id, customer_plan_id, **params) -> PlanEndResponse
• client.v1.customers.plans.list_price_adjustments(*, customer_id, customer_plan_id, **params) -> SyncCursorPage[PlanListPriceAdjustmentsResponse]

Invoices

Types:

from metronome.types.v1.customers import (
    Invoice,
    InvoiceRetrieveResponse,
    InvoiceAddChargeResponse,
    InvoiceListBreakdownsResponse,
)

Methods:

• client.v1.customers.invoices.retrieve(*, customer_id, invoice_id, **params) -> InvoiceRetrieveResponse
• client.v1.customers.invoices.list(*, customer_id, **params) -> SyncCursorPage[Invoice]
• client.v1.customers.invoices.add_charge(*, customer_id, **params) -> InvoiceAddChargeResponse
• client.v1.customers.invoices.list_breakdowns(*, customer_id, **params) -> SyncCursorPage[InvoiceListBreakdownsResponse]
• client.v1.customers.invoices.retrieve_pdf(*, customer_id, invoice_id) -> BinaryAPIResponse

BillingConfig

Types:

from metronome.types.v1.customers import BillingConfigRetrieveResponse

Methods:

• client.v1.customers.billing_config.create(*, customer_id, billing_provider_type, **params) -> None
• client.v1.customers.billing_config.retrieve(*, customer_id, billing_provider_type) -> BillingConfigRetrieveResponse
• client.v1.customers.billing_config.delete(*, customer_id, billing_provider_type) -> None

Commits

Types:

from metronome.types.v1.customers import CommitCreateResponse, CommitUpdateEndDateResponse

Methods:

• client.v1.customers.commits.create(**params) -> CommitCreateResponse
• client.v1.customers.commits.list(**params) -> SyncBodyCursorPage[Commit]
• client.v1.customers.commits.update_end_date(**params) -> CommitUpdateEndDateResponse

Credits

Types:

from metronome.types.v1.customers import CreditCreateResponse, CreditUpdateEndDateResponse

Methods:

• client.v1.customers.credits.create(**params) -> CreditCreateResponse
• client.v1.customers.credits.list(**params) -> SyncBodyCursorPage[Credit]
• client.v1.customers.credits.update_end_date(**params) -> CreditUpdateEndDateResponse

NamedSchedules

Types:

from metronome.types.v1.customers import NamedScheduleRetrieveResponse

Methods:

• client.v1.customers.named_schedules.retrieve(**params) -> NamedScheduleRetrieveResponse
• client.v1.customers.named_schedules.update(**params) -> None

Dashboards

Types:

from metronome.types.v1 import DashboardGetEmbeddableURLResponse

Methods:

• client.v1.dashboards.get_embeddable_url(**params) -> DashboardGetEmbeddableURLResponse

Usage

Types:

from metronome.types.v1 import UsageListResponse, UsageListWithGroupsResponse, UsageSearchResponse

Methods:

• client.v1.usage.list(**params) -> SyncCursorPageWithoutLimit[UsageListResponse]
• client.v1.usage.ingest(**params) -> None
• client.v1.usage.list_with_groups(**params) -> SyncCursorPage[UsageListWithGroupsResponse]
• client.v1.usage.search(**params) -> UsageSearchResponse

AuditLogs

Types:

from metronome.types.v1 import AuditLogListResponse

Methods:

• client.v1.audit_logs.list(**params) -> SyncCursorPage[AuditLogListResponse]

CustomFields

Types:

from metronome.types.v1 import CustomFieldListKeysResponse

Methods:

• client.v1.custom_fields.add_key(**params) -> None
• client.v1.custom_fields.delete_values(**params) -> None
• client.v1.custom_fields.list_keys(**params) -> SyncCursorPageWithoutLimit[CustomFieldListKeysResponse]
• client.v1.custom_fields.remove_key(**params) -> None
• client.v1.custom_fields.set_values(**params) -> None

BillableMetrics

Types:

from metronome.types.v1 import (
    BillableMetricCreateResponse,
    BillableMetricRetrieveResponse,
    BillableMetricListResponse,
    BillableMetricArchiveResponse,
)

Methods:

• client.v1.billable_metrics.create(**params) -> BillableMetricCreateResponse
• client.v1.billable_metrics.retrieve(*, billable_metric_id) -> BillableMetricRetrieveResponse
• client.v1.billable_metrics.list(**params) -> SyncCursorPage[BillableMetricListResponse]
• client.v1.billable_metrics.archive(**params) -> BillableMetricArchiveResponse

Services

Types:

from metronome.types.v1 import ServiceListResponse

Methods:

• client.v1.services.list() -> ServiceListResponse

Invoices

Types:

from metronome.types.v1 import InvoiceRegenerateResponse, InvoiceVoidResponse

Methods:

• client.v1.invoices.regenerate(**params) -> InvoiceRegenerateResponse
• client.v1.invoices.void(**params) -> InvoiceVoidResponse

Contracts

Types:

from metronome.types.v1 import (
    ContractCreateResponse,
    ContractRetrieveResponse,
    ContractListResponse,
    ContractAmendResponse,
    ContractArchiveResponse,
    ContractCreateHistoricalInvoicesResponse,
    ContractGetNetBalanceResponse,
    ContractListBalancesResponse,
    ContractListSeatBalancesResponse,
    ContractRetrieveRateScheduleResponse,
    ContractRetrieveSubscriptionQuantityHistoryResponse,
    ContractScheduleProServicesInvoiceResponse,
    ContractUpdateEndDateResponse,
)

Methods:

• client.v1.contracts.create(**params) -> ContractCreateResponse
• client.v1.contracts.retrieve(**params) -> ContractRetrieveResponse
• client.v1.contracts.list(**params) -> ContractListResponse
• client.v1.contracts.add_manual_balance_entry(**params) -> None
• client.v1.contracts.amend(**params) -> ContractAmendResponse
• client.v1.contracts.archive(**params) -> ContractArchiveResponse
• client.v1.contracts.create_historical_invoices(**params) -> ContractCreateHistoricalInvoicesResponse
• client.v1.contracts.get_net_balance(**params) -> ContractGetNetBalanceResponse
• client.v1.contracts.list_balances(**params) -> SyncBodyCursorPage[ContractListBalancesResponse]
• client.v1.contracts.list_seat_balances(**params) -> ContractListSeatBalancesResponse
• client.v1.contracts.retrieve_rate_schedule(**params) -> ContractRetrieveRateScheduleResponse
• client.v1.contracts.retrieve_subscription_quantity_history(**params) -> ContractRetrieveSubscriptionQuantityHistoryResponse
• client.v1.contracts.schedule_pro_services_invoice(**params) -> ContractScheduleProServicesInvoiceResponse
• client.v1.contracts.set_usage_filter(**params) -> None
• client.v1.contracts.update_end_date(**params) -> ContractUpdateEndDateResponse

Products

Types:

from metronome.types.v1.contracts import (
    ProductListItemState,
    QuantityConversion,
    QuantityRounding,
    ProductCreateResponse,
    ProductRetrieveResponse,
    ProductUpdateResponse,
    ProductListResponse,
    ProductArchiveResponse,
)

Methods:

• client.v1.contracts.products.create(**params) -> ProductCreateResponse
• client.v1.contracts.products.retrieve(**params) -> ProductRetrieveResponse
• client.v1.contracts.products.update(**params) -> ProductUpdateResponse
• client.v1.contracts.products.list(**params) -> SyncCursorPage[ProductListResponse]
• client.v1.contracts.products.archive(**params) -> ProductArchiveResponse

RateCards

Types:

from metronome.types.v1.contracts import (
    RateCardCreateResponse,
    RateCardRetrieveResponse,
    RateCardUpdateResponse,
    RateCardListResponse,
    RateCardArchiveResponse,
    RateCardRetrieveRateScheduleResponse,
)

Methods:

• client.v1.contracts.rate_cards.create(**params) -> RateCardCreateResponse
• client.v1.contracts.rate_cards.retrieve(**params) -> RateCardRetrieveResponse
• client.v1.contracts.rate_cards.update(**params) -> RateCardUpdateResponse
• client.v1.contracts.rate_cards.list(**params) -> SyncCursorPage[RateCardListResponse]
• client.v1.contracts.rate_cards.archive(**params) -> RateCardArchiveResponse
• client.v1.contracts.rate_cards.retrieve_rate_schedule(**params) -> RateCardRetrieveRateScheduleResponse

ProductOrders

Types:

from metronome.types.v1.contracts.rate_cards import (
    ProductOrderUpdateResponse,
    ProductOrderSetResponse,
)

Methods:

• client.v1.contracts.rate_cards.product_orders.update(**params) -> ProductOrderUpdateResponse
• client.v1.contracts.rate_cards.product_orders.set(**params) -> ProductOrderSetResponse

Rates

Types:

from metronome.types.v1.contracts.rate_cards import (
    RateListResponse,
    RateAddResponse,
    RateAddManyResponse,
)

Methods:

• client.v1.contracts.rate_cards.rates.list(**params) -> SyncCursorPage[RateListResponse]
• client.v1.contracts.rate_cards.rates.add(**params) -> RateAddResponse
• client.v1.contracts.rate_cards.rates.add_many(**params) -> RateAddManyResponse

NamedSchedules

Types:

from metronome.types.v1.contracts.rate_cards import NamedScheduleRetrieveResponse

Methods:

• client.v1.contracts.rate_cards.named_schedules.retrieve(**params) -> NamedScheduleRetrieveResponse
• client.v1.contracts.rate_cards.named_schedules.update(**params) -> None

NamedSchedules

Types:

from metronome.types.v1.contracts import NamedScheduleRetrieveResponse

Methods:

• client.v1.contracts.named_schedules.retrieve(**params) -> NamedScheduleRetrieveResponse
• client.v1.contracts.named_schedules.update(**params) -> None

Packages

Types:

from metronome.types.v1 import (
    PackageCreateResponse,
    PackageRetrieveResponse,
    PackageListResponse,
    PackageArchiveResponse,
    PackageListContractsOnPackageResponse,
)

Methods:

• client.v1.packages.create(**params) -> PackageCreateResponse
• client.v1.packages.retrieve(**params) -> PackageRetrieveResponse
• client.v1.packages.list(**params) -> SyncCursorPage[PackageListResponse]
• client.v1.packages.archive(**params) -> PackageArchiveResponse
• client.v1.packages.list_contracts_on_package(**params) -> SyncCursorPage[PackageListContractsOnPackageResponse]

Settings

Types:

from metronome.types.v1 import SettingUpsertAvalaraCredentialsResponse

Methods:

• client.v1.settings.upsert_avalara_credentials(**params) -> SettingUpsertAvalaraCredentialsResponse

BillingProviders

Types:

from metronome.types.v1.settings import BillingProviderCreateResponse, BillingProviderListResponse

Methods:

• client.v1.settings.billing_providers.create(**params) -> BillingProviderCreateResponse
• client.v1.settings.billing_providers.list(**params) -> BillingProviderListResponse