api.md

Shared Types

from metronome.types import (
    BaseUsageFilter,
    Commit,
    ContractWithoutAmendments,
    Credit,
    CreditTypeData,
    Discount,
    EventTypeFilter,
    ID,
    Override,
    PropertyFilter,
    ProService,
    Rate,
    ScheduledCharge,
    ScheduleDuration,
    SchedulePointInTime,
    Tier,
)

Alerts

Types:

from metronome.types import AlertCreateResponse, AlertArchiveResponse

Methods:

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

Plans

Types:

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

Methods:

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

CreditGrants

Types:

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

Methods:

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

PricingUnits

Types:

from metronome.types import PricingUnitListResponse

Methods:

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

Customers

Types:

from metronome.types import (
    Customer,
    CustomerDetail,
    CustomerCreateResponse,
    CustomerRetrieveResponse,
    CustomerArchiveResponse,
    CustomerListBillableMetricsResponse,
    CustomerListCostsResponse,
    CustomerSetNameResponse,
)

Methods:

• client.customers.create(**params) -> CustomerCreateResponse
• client.customers.retrieve(*, customer_id) -> CustomerRetrieveResponse
• client.customers.list(**params) -> SyncCursorPage[CustomerDetail]
• client.customers.archive(**params) -> CustomerArchiveResponse
• client.customers.list_billable_metrics(*, customer_id, **params) -> SyncCursorPage[CustomerListBillableMetricsResponse]
• client.customers.list_costs(*, customer_id, **params) -> SyncCursorPage[CustomerListCostsResponse]
• client.customers.set_ingest_aliases(*, customer_id, **params) -> None
• client.customers.set_name(*, customer_id, **params) -> CustomerSetNameResponse
• client.customers.update_config(*, customer_id, **params) -> None

Alerts

Types:

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

Methods:

• client.customers.alerts.retrieve(**params) -> AlertRetrieveResponse
• client.customers.alerts.list(**params) -> AlertListResponse
• client.customers.alerts.reset(**params) -> None

Plans

Types:

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

Methods:

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

Invoices

Types:

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

Methods:

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

BillingConfig

Types:

from metronome.types.customers import BillingConfigRetrieveResponse

Methods:

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

Commits

Types:

from metronome.types.customers import (
    CommitCreateResponse,
    CommitListResponse,
    CommitUpdateEndDateResponse,
)

Methods:

• client.customers.commits.create(**params) -> CommitCreateResponse
• client.customers.commits.list(**params) -> CommitListResponse
• client.customers.commits.update_end_date(**params) -> CommitUpdateEndDateResponse

Credits

Types:

from metronome.types.customers import (
    CreditCreateResponse,
    CreditListResponse,
    CreditUpdateEndDateResponse,
)

Methods:

• client.customers.credits.create(**params) -> CreditCreateResponse
• client.customers.credits.list(**params) -> CreditListResponse
• client.customers.credits.update_end_date(**params) -> CreditUpdateEndDateResponse

NamedSchedules

Types:

from metronome.types.customers import NamedScheduleRetrieveResponse

Methods:

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

Dashboards

Types:

from metronome.types import DashboardGetEmbeddableURLResponse

Methods:

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

Usage

Types:

from metronome.types import UsageListResponse, UsageListWithGroupsResponse

Methods:

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

AuditLogs

Types:

from metronome.types import AuditLogListResponse

Methods:

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

CustomFields

Types:

from metronome.types import CustomFieldListKeysResponse

Methods:

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

BillableMetrics

Types:

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

Methods:

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

Services

Types:

from metronome.types import ServiceListResponse

Methods:

• client.services.list() -> ServiceListResponse

Invoices

Types:

from metronome.types import InvoiceRegenerateResponse, InvoiceVoidResponse

Methods:

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

Contracts

Types:

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

Methods:

• client.contracts.create(**params) -> ContractCreateResponse
• client.contracts.retrieve(**params) -> ContractRetrieveResponse
• client.contracts.list(**params) -> ContractListResponse
• client.contracts.add_manual_balance_entry(**params) -> None
• client.contracts.amend(**params) -> ContractAmendResponse
• client.contracts.archive(**params) -> ContractArchiveResponse
• client.contracts.create_historical_invoices(**params) -> ContractCreateHistoricalInvoicesResponse
• client.contracts.list_balances(**params) -> ContractListBalancesResponse
• client.contracts.retrieve_rate_schedule(**params) -> ContractRetrieveRateScheduleResponse
• client.contracts.schedule_pro_services_invoice(**params) -> ContractScheduleProServicesInvoiceResponse
• client.contracts.set_usage_filter(**params) -> None
• client.contracts.update_end_date(**params) -> ContractUpdateEndDateResponse

Products

Types:

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

Methods:

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

RateCards

Types:

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

Methods:

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

ProductOrders

Types:

from metronome.types.contracts.rate_cards import ProductOrderUpdateResponse, ProductOrderSetResponse

Methods:

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

Rates

Types:

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

Methods:

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

NamedSchedules

Types:

from metronome.types.contracts.rate_cards import NamedScheduleRetrieveResponse

Methods:

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

NamedSchedules

Types:

from metronome.types.contracts import NamedScheduleRetrieveResponse

Methods:

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