api.md

Shared Params Types

• shared.BaseUsageFilterParam
• shared.EventTypeFilterParam
• shared.IDParam
• shared.PropertyFilterParam
• shared.TierParam

Shared Response Types

• shared.BaseUsageFilter
• shared.Commit
• shared.ContractWithoutAmendments
• shared.Credit
• shared.CreditType
• shared.Discount
• shared.EventTypeFilter
• shared.ID
• shared.Override
• shared.PropertyFilter
• shared.ProService
• shared.Rate
• shared.ScheduledCharge
• shared.ScheduleDuration
• shared.SchedulePointInTime
• shared.Tier

Alerts

Response Types:

• metronome.AlertNewResponse
• metronome.AlertArchiveResponse

Methods:

• client.Alerts.New(ctx context.Context, body metronome.AlertNewParams) (metronome.AlertNewResponse, error)
• client.Alerts.Archive(ctx context.Context, body metronome.AlertArchiveParams) (metronome.AlertArchiveResponse, error)

Plans

Response Types:

• metronome.PlanDetail
• metronome.PlanListResponse
• metronome.PlanGetDetailsResponse
• metronome.PlanListChargesResponse
• metronome.PlanListCustomersResponse

Methods:

• client.Plans.List(ctx context.Context, query metronome.PlanListParams) (pagination.CursorPage[metronome.PlanListResponse], error)
• client.Plans.GetDetails(ctx context.Context, planID string) (metronome.PlanGetDetailsResponse, error)
• client.Plans.ListCharges(ctx context.Context, planID string, query metronome.PlanListChargesParams) (pagination.CursorPage[metronome.PlanListChargesResponse], error)
• client.Plans.ListCustomers(ctx context.Context, planID string, query metronome.PlanListCustomersParams) (pagination.CursorPage[metronome.PlanListCustomersResponse], error)

CreditGrants

Params Types:

• metronome.RolloverAmountMaxAmountParam
• metronome.RolloverAmountMaxPercentageParam

Response Types:

• metronome.CreditLedgerEntry
• metronome.CreditGrantNewResponse
• metronome.CreditGrantListResponse
• metronome.CreditGrantEditResponse
• metronome.CreditGrantListCreditTypesResponse
• metronome.CreditGrantListEntriesResponse
• metronome.CreditGrantVoidResponse

Methods:

• client.CreditGrants.New(ctx context.Context, body metronome.CreditGrantNewParams) (metronome.CreditGrantNewResponse, error)
• client.CreditGrants.List(ctx context.Context, params metronome.CreditGrantListParams) (pagination.CursorPage[metronome.CreditGrantListResponse], error)
• client.CreditGrants.Edit(ctx context.Context, body metronome.CreditGrantEditParams) (metronome.CreditGrantEditResponse, error)
• client.CreditGrants.ListCreditTypes(ctx context.Context, query metronome.CreditGrantListCreditTypesParams) (pagination.CursorPage[metronome.CreditGrantListCreditTypesResponse], error)
• client.CreditGrants.ListEntries(ctx context.Context, params metronome.CreditGrantListEntriesParams) (metronome.CreditGrantListEntriesResponse, error)
• client.CreditGrants.Void(ctx context.Context, body metronome.CreditGrantVoidParams) (metronome.CreditGrantVoidResponse, error)

Customers

Response Types:

• metronome.Customer
• metronome.CustomerDetail
• metronome.CustomerNewResponse
• metronome.CustomerGetResponse
• metronome.CustomerArchiveResponse
• metronome.CustomerListBillableMetricsResponse
• metronome.CustomerListCostsResponse
• metronome.CustomerSetNameResponse

Methods:

• client.Customers.New(ctx context.Context, body metronome.CustomerNewParams) (metronome.CustomerNewResponse, error)
• client.Customers.Get(ctx context.Context, customerID string) (metronome.CustomerGetResponse, error)
• client.Customers.List(ctx context.Context, query metronome.CustomerListParams) (pagination.CursorPage[metronome.CustomerDetail], error)
• client.Customers.Archive(ctx context.Context, body metronome.CustomerArchiveParams) (metronome.CustomerArchiveResponse, error)
• client.Customers.ListBillableMetrics(ctx context.Context, customerID string, query metronome.CustomerListBillableMetricsParams) (pagination.CursorPage[metronome.CustomerListBillableMetricsResponse], error)
• client.Customers.ListCosts(ctx context.Context, customerID string, query metronome.CustomerListCostsParams) (pagination.CursorPage[metronome.CustomerListCostsResponse], error)
• client.Customers.SetIngestAliases(ctx context.Context, customerID string, body metronome.CustomerSetIngestAliasesParams) error
• client.Customers.SetName(ctx context.Context, customerID string, body metronome.CustomerSetNameParams) (metronome.CustomerSetNameResponse, error)
• client.Customers.UpdateConfig(ctx context.Context, customerID string, body metronome.CustomerUpdateConfigParams) error

Alerts

Response Types:

• metronome.CustomerAlert
• metronome.CustomerAlertGetResponse
• metronome.CustomerAlertListResponse

Methods:

• client.Customers.Alerts.Get(ctx context.Context, body metronome.CustomerAlertGetParams) (metronome.CustomerAlertGetResponse, error)
• client.Customers.Alerts.List(ctx context.Context, params metronome.CustomerAlertListParams) (metronome.CustomerAlertListResponse, error)
• client.Customers.Alerts.Reset(ctx context.Context, body metronome.CustomerAlertResetParams) error

Plans

Response Types:

• metronome.CustomerPlanListResponse
• metronome.CustomerPlanAddResponse
• metronome.CustomerPlanEndResponse
• metronome.CustomerPlanListPriceAdjustmentsResponse

Methods:

• client.Customers.Plans.List(ctx context.Context, customerID string, query metronome.CustomerPlanListParams) (pagination.CursorPage[metronome.CustomerPlanListResponse], error)
• client.Customers.Plans.Add(ctx context.Context, customerID string, body metronome.CustomerPlanAddParams) (metronome.CustomerPlanAddResponse, error)
• client.Customers.Plans.End(ctx context.Context, customerID string, customerPlanID string, body metronome.CustomerPlanEndParams) (metronome.CustomerPlanEndResponse, error)
• client.Customers.Plans.ListPriceAdjustments(ctx context.Context, customerID string, customerPlanID string, query metronome.CustomerPlanListPriceAdjustmentsParams) (pagination.CursorPage[metronome.CustomerPlanListPriceAdjustmentsResponse], error)

Invoices

Response Types:

• metronome.Invoice
• metronome.CustomerInvoiceGetResponse
• metronome.CustomerInvoiceAddChargeResponse
• metronome.CustomerInvoiceListBreakdownsResponse

Methods:

• client.Customers.Invoices.Get(ctx context.Context, customerID string, invoiceID string, query metronome.CustomerInvoiceGetParams) (metronome.CustomerInvoiceGetResponse, error)
• client.Customers.Invoices.List(ctx context.Context, customerID string, query metronome.CustomerInvoiceListParams) (pagination.CursorPage[metronome.Invoice], error)
• client.Customers.Invoices.AddCharge(ctx context.Context, customerID string, body metronome.CustomerInvoiceAddChargeParams) (metronome.CustomerInvoiceAddChargeResponse, error)
• client.Customers.Invoices.ListBreakdowns(ctx context.Context, customerID string, query metronome.CustomerInvoiceListBreakdownsParams) (pagination.CursorPage[metronome.CustomerInvoiceListBreakdownsResponse], error)

BillingConfig

Response Types:

• metronome.CustomerBillingConfigGetResponse

Methods:

• client.Customers.BillingConfig.New(ctx context.Context, customerID string, billingProviderType metronome.CustomerBillingConfigNewParamsBillingProviderType, body metronome.CustomerBillingConfigNewParams) error
• client.Customers.BillingConfig.Get(ctx context.Context, customerID string, billingProviderType metronome.CustomerBillingConfigGetParamsBillingProviderType) (metronome.CustomerBillingConfigGetResponse, error)
• client.Customers.BillingConfig.Delete(ctx context.Context, customerID string, billingProviderType metronome.CustomerBillingConfigDeleteParamsBillingProviderType) error

Commits

Response Types:

• metronome.CustomerCommitNewResponse
• metronome.CustomerCommitListResponse
• metronome.CustomerCommitUpdateEndDateResponse

Methods:

• client.Customers.Commits.New(ctx context.Context, body metronome.CustomerCommitNewParams) (metronome.CustomerCommitNewResponse, error)
• client.Customers.Commits.List(ctx context.Context, body metronome.CustomerCommitListParams) (metronome.CustomerCommitListResponse, error)
• client.Customers.Commits.UpdateEndDate(ctx context.Context, body metronome.CustomerCommitUpdateEndDateParams) (metronome.CustomerCommitUpdateEndDateResponse, error)

Credits

Response Types:

• metronome.CustomerCreditNewResponse
• metronome.CustomerCreditListResponse
• metronome.CustomerCreditUpdateEndDateResponse

Methods:

• client.Customers.Credits.New(ctx context.Context, body metronome.CustomerCreditNewParams) (metronome.CustomerCreditNewResponse, error)
• client.Customers.Credits.List(ctx context.Context, body metronome.CustomerCreditListParams) (metronome.CustomerCreditListResponse, error)
• client.Customers.Credits.UpdateEndDate(ctx context.Context, body metronome.CustomerCreditUpdateEndDateParams) (metronome.CustomerCreditUpdateEndDateResponse, error)

NamedSchedules

Response Types:

• metronome.CustomerNamedScheduleGetResponse

Methods:

• client.Customers.NamedSchedules.Get(ctx context.Context, body metronome.CustomerNamedScheduleGetParams) (metronome.CustomerNamedScheduleGetResponse, error)
• client.Customers.NamedSchedules.Update(ctx context.Context, body metronome.CustomerNamedScheduleUpdateParams) error

Dashboards

Response Types:

• metronome.DashboardGetEmbeddableURLResponse

Methods:

• client.Dashboards.GetEmbeddableURL(ctx context.Context, body metronome.DashboardGetEmbeddableURLParams) (metronome.DashboardGetEmbeddableURLResponse, error)

Usage

Response Types:

• metronome.UsageListResponse
• metronome.UsageListWithGroupsResponse

Methods:

• client.Usage.List(ctx context.Context, params metronome.UsageListParams) (metronome.UsageListResponse, error)
• client.Usage.Ingest(ctx context.Context, body metronome.UsageIngestParams) error
• client.Usage.ListWithGroups(ctx context.Context, params metronome.UsageListWithGroupsParams) (pagination.CursorPage[metronome.UsageListWithGroupsResponse], error)

AuditLogs

Response Types:

• metronome.AuditLogListResponse

Methods:

• client.AuditLogs.List(ctx context.Context, query metronome.AuditLogListParams) (pagination.CursorPage[metronome.AuditLogListResponse], error)

CustomFields

Response Types:

• metronome.CustomFieldListKeysResponse

Methods:

• client.CustomFields.AddKey(ctx context.Context, body metronome.CustomFieldAddKeyParams) error
• client.CustomFields.DeleteValues(ctx context.Context, body metronome.CustomFieldDeleteValuesParams) error
• client.CustomFields.ListKeys(ctx context.Context, params metronome.CustomFieldListKeysParams) (metronome.CustomFieldListKeysResponse, error)
• client.CustomFields.RemoveKey(ctx context.Context, body metronome.CustomFieldRemoveKeyParams) error
• client.CustomFields.SetValues(ctx context.Context, body metronome.CustomFieldSetValuesParams) error

BillableMetrics

Response Types:

• metronome.BillableMetricNewResponse
• metronome.BillableMetricGetResponse
• metronome.BillableMetricListResponse
• metronome.BillableMetricArchiveResponse

Methods:

• client.BillableMetrics.New(ctx context.Context, body metronome.BillableMetricNewParams) (metronome.BillableMetricNewResponse, error)
• client.BillableMetrics.Get(ctx context.Context, billableMetricID string) (metronome.BillableMetricGetResponse, error)
• client.BillableMetrics.List(ctx context.Context, query metronome.BillableMetricListParams) (pagination.CursorPage[metronome.BillableMetricListResponse], error)
• client.BillableMetrics.Archive(ctx context.Context, body metronome.BillableMetricArchiveParams) (metronome.BillableMetricArchiveResponse, error)

Services

Response Types:

• metronome.ServiceListResponse

Methods:

• client.Services.List(ctx context.Context) (metronome.ServiceListResponse, error)

Invoices

Response Types:

• metronome.InvoiceRegenerateResponse
• metronome.InvoiceVoidResponse

Methods:

• client.Invoices.Regenerate(ctx context.Context, body metronome.InvoiceRegenerateParams) (metronome.InvoiceRegenerateResponse, error)
• client.Invoices.Void(ctx context.Context, body metronome.InvoiceVoidParams) (metronome.InvoiceVoidResponse, error)

Contracts

Response Types:

• metronome.ContractNewResponse
• metronome.ContractGetResponse
• metronome.ContractListResponse
• metronome.ContractAmendResponse
• metronome.ContractArchiveResponse
• metronome.ContractNewHistoricalInvoicesResponse
• metronome.ContractListBalancesResponse
• metronome.ContractGetRateScheduleResponse
• metronome.ContractScheduleProServicesInvoiceResponse
• metronome.ContractUpdateEndDateResponse

Methods:

• client.Contracts.New(ctx context.Context, body metronome.ContractNewParams) (metronome.ContractNewResponse, error)
• client.Contracts.Get(ctx context.Context, body metronome.ContractGetParams) (metronome.ContractGetResponse, error)
• client.Contracts.List(ctx context.Context, body metronome.ContractListParams) (metronome.ContractListResponse, error)
• client.Contracts.AddManualBalanceEntry(ctx context.Context, body metronome.ContractAddManualBalanceEntryParams) error
• client.Contracts.Amend(ctx context.Context, body metronome.ContractAmendParams) (metronome.ContractAmendResponse, error)
• client.Contracts.Archive(ctx context.Context, body metronome.ContractArchiveParams) (metronome.ContractArchiveResponse, error)
• client.Contracts.NewHistoricalInvoices(ctx context.Context, body metronome.ContractNewHistoricalInvoicesParams) (metronome.ContractNewHistoricalInvoicesResponse, error)
• client.Contracts.ListBalances(ctx context.Context, body metronome.ContractListBalancesParams) (metronome.ContractListBalancesResponse, error)
• client.Contracts.GetRateSchedule(ctx context.Context, params metronome.ContractGetRateScheduleParams) (metronome.ContractGetRateScheduleResponse, error)
• client.Contracts.ScheduleProServicesInvoice(ctx context.Context, body metronome.ContractScheduleProServicesInvoiceParams) (metronome.ContractScheduleProServicesInvoiceResponse, error)
• client.Contracts.SetUsageFilter(ctx context.Context, body metronome.ContractSetUsageFilterParams) error
• client.Contracts.UpdateEndDate(ctx context.Context, body metronome.ContractUpdateEndDateParams) (metronome.ContractUpdateEndDateResponse, error)

Products

Params Types:

• metronome.QuantityConversionParam
• metronome.QuantityRoundingParam

Response Types:

• metronome.ProductListItemState
• metronome.QuantityConversion
• metronome.QuantityRounding
• metronome.ContractProductNewResponse
• metronome.ContractProductGetResponse
• metronome.ContractProductUpdateResponse
• metronome.ContractProductListResponse
• metronome.ContractProductArchiveResponse

Methods:

• client.Contracts.Products.New(ctx context.Context, body metronome.ContractProductNewParams) (metronome.ContractProductNewResponse, error)
• client.Contracts.Products.Get(ctx context.Context, body metronome.ContractProductGetParams) (metronome.ContractProductGetResponse, error)
• client.Contracts.Products.Update(ctx context.Context, body metronome.ContractProductUpdateParams) (metronome.ContractProductUpdateResponse, error)
• client.Contracts.Products.List(ctx context.Context, params metronome.ContractProductListParams) (pagination.CursorPage[metronome.ContractProductListResponse], error)
• client.Contracts.Products.Archive(ctx context.Context, body metronome.ContractProductArchiveParams) (metronome.ContractProductArchiveResponse, error)

RateCards

Response Types:

• metronome.ContractRateCardNewResponse
• metronome.ContractRateCardGetResponse
• metronome.ContractRateCardUpdateResponse
• metronome.ContractRateCardListResponse
• metronome.ContractRateCardGetRateScheduleResponse

Methods:

• client.Contracts.RateCards.New(ctx context.Context, body metronome.ContractRateCardNewParams) (metronome.ContractRateCardNewResponse, error)
• client.Contracts.RateCards.Get(ctx context.Context, body metronome.ContractRateCardGetParams) (metronome.ContractRateCardGetResponse, error)
• client.Contracts.RateCards.Update(ctx context.Context, body metronome.ContractRateCardUpdateParams) (metronome.ContractRateCardUpdateResponse, error)
• client.Contracts.RateCards.List(ctx context.Context, params metronome.ContractRateCardListParams) (pagination.CursorPage[metronome.ContractRateCardListResponse], error)
• client.Contracts.RateCards.GetRateSchedule(ctx context.Context, params metronome.ContractRateCardGetRateScheduleParams) (metronome.ContractRateCardGetRateScheduleResponse, error)

ProductOrders

Response Types:

• metronome.ContractRateCardProductOrderUpdateResponse
• metronome.ContractRateCardProductOrderSetResponse

Methods:

• client.Contracts.RateCards.ProductOrders.Update(ctx context.Context, body metronome.ContractRateCardProductOrderUpdateParams) (metronome.ContractRateCardProductOrderUpdateResponse, error)
• client.Contracts.RateCards.ProductOrders.Set(ctx context.Context, body metronome.ContractRateCardProductOrderSetParams) (metronome.ContractRateCardProductOrderSetResponse, error)

Rates

Response Types:

• metronome.ContractRateCardRateListResponse
• metronome.ContractRateCardRateAddResponse
• metronome.ContractRateCardRateAddManyResponse

Methods:

• client.Contracts.RateCards.Rates.List(ctx context.Context, params metronome.ContractRateCardRateListParams) (pagination.CursorPage[metronome.ContractRateCardRateListResponse], error)
• client.Contracts.RateCards.Rates.Add(ctx context.Context, body metronome.ContractRateCardRateAddParams) (metronome.ContractRateCardRateAddResponse, error)
• client.Contracts.RateCards.Rates.AddMany(ctx context.Context, body metronome.ContractRateCardRateAddManyParams) (metronome.ContractRateCardRateAddManyResponse, error)

NamedSchedules

Response Types:

• metronome.ContractRateCardNamedScheduleGetResponse

Methods:

• client.Contracts.RateCards.NamedSchedules.Get(ctx context.Context, body metronome.ContractRateCardNamedScheduleGetParams) (metronome.ContractRateCardNamedScheduleGetResponse, error)
• client.Contracts.RateCards.NamedSchedules.Update(ctx context.Context, body metronome.ContractRateCardNamedScheduleUpdateParams) error

NamedSchedules

Response Types:

• metronome.ContractNamedScheduleGetResponse

Methods:

• client.Contracts.NamedSchedules.Get(ctx context.Context, body metronome.ContractNamedScheduleGetParams) (metronome.ContractNamedScheduleGetResponse, error)
• client.Contracts.NamedSchedules.Update(ctx context.Context, body metronome.ContractNamedScheduleUpdateParams) error