Customers

API Reference

Customers

Archive a customer

client.V1.Customers.Archive(ctx, body) (*, error)

post/v1/customers/archive

Create a customer

client.V1.Customers.New(ctx, body) (*, error)

post/v1/customers

List customers

client.V1.Customers.List(ctx, query) (*CursorPage[], error)

get/v1/customers

Get billable metrics for a customer

client.V1.Customers.ListBillableMetrics(ctx, params) (*CursorPage[], error)

get/v1/customers/{customer_id}/billable-metrics

Get customer costs

client.V1.Customers.ListCosts(ctx, params) (*CursorPage[], error)

get/v1/customers/{customer_id}/costs

Preview events

client.V1.Customers.PreviewEvents(ctx, params) (*, error)

post/v1/customers/{customer_id}/previewEvents

Get a customer

client.V1.Customers.Get(ctx, query) (*, error)

get/v1/customers/{customer_id}

Create or update customer ingest aliases

client.V1.Customers.SetIngestAliases(ctx, params) error

post/v1/customers/{customer_id}/setIngestAliases

Update a customer name

client.V1.Customers.SetName(ctx, params) (*, error)

post/v1/customers/{customer_id}/setName

Update a customer configuration

client.V1.Customers.UpdateConfig(ctx, params) error

post/v1/customers/{customer_id}/updateConfig

Customer

Customerstruct

ShowShow

IDstring

the Metronome ID of the customer

formatuuid

ExternalIDstring

(deprecated, use ingest_aliases instead) the first ID (Metronome or ingest alias) that can be used in usage events

IngestAliasesarray

[]string

aliases for this customer that can be used instead of the Metronome customer ID in usage events

Namestring

CustomFieldsmap

optional

map[string, string]

Customer Detail

CustomerDetailstruct

ShowShow

IDstring

the Metronome ID of the customer

formatuuid

CreatedAtTime

RFC 3339 timestamp indicating when the customer was created.

formatdate-time

CustomFieldsmap

map[string, string]

CustomerConfig

Hide ParametersShow Parameters

SalesforceAccountIDstring

The Salesforce account ID for the customer

ExternalIDstring

(deprecated, use ingest_aliases instead) the first ID (Metronome or ingest alias) that can be used in usage events

IngestAliasesarray

[]string

aliases for this customer that can be used instead of the Metronome customer ID in usage events

Namestring

ArchivedAtTime

optional

RFC 3339 timestamp indicating when the customer was archived. Null if the customer is active.

formatdate-time

CurrentBillableStatus

optional

This field's availability is dependent on your client's configuration.

Hide ParametersShow Parameters

Value

Hide ParametersShow Parameters

CustomerDetailCurrentBillableStatusValueBillableconst

"billable"

CustomerDetailCurrentBillableStatusValueUnbillableconst

"unbillable"

EffectiveAtTime

optional

formatdate-time

CustomersAlerts

List customer alerts

client.V1.Customers.Alerts.List(ctx, params) (*, error)

post/v1/customer-alerts/list

Reset an alert for a customer

client.V1.Customers.Alerts.Reset(ctx, body) error

post/v1/customer-alerts/reset

Get an alert

client.V1.Customers.Alerts.Get(ctx, body) (*, error)

post/v1/customer-alerts/get

Customer Alert

CustomerAlertstruct

ShowShow

Alert

Hide ParametersShow Parameters

IDstring

the Metronome ID of the alert

Namestring

Name of the alert

Status

Status of the alert

Hide ParametersShow Parameters

CustomerAlertAlertStatusEnabledconst

"enabled"

CustomerAlertAlertStatusArchivedconst

"archived"

CustomerAlertAlertStatusDisabledconst

"disabled"

Thresholdfloat64

Threshold value of the alert policy

Type

Type of the alert

Hide ParametersShow Parameters

CustomerAlertAlertTypeLowCreditBalanceReachedconst

"low_credit_balance_reached"

CustomerAlertAlertTypeSpendThresholdReachedconst

"spend_threshold_reached"

CustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedconst

"monthly_invoice_total_spend_threshold_reached"

CustomerAlertAlertTypeLowRemainingDaysInPlanReachedconst

"low_remaining_days_in_plan_reached"

CustomerAlertAlertTypeLowRemainingCreditPercentageReachedconst

"low_remaining_credit_percentage_reached"

CustomerAlertAlertTypeUsageThresholdReachedconst

"usage_threshold_reached"

CustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedconst

"low_remaining_days_for_commit_segment_reached"

CustomerAlertAlertTypeLowRemainingCommitBalanceReachedconst

"low_remaining_commit_balance_reached"

CustomerAlertAlertTypeLowRemainingCommitPercentageReachedconst

"low_remaining_commit_percentage_reached"

CustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedconst

"low_remaining_days_for_contract_credit_segment_reached"

CustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedconst

"low_remaining_contract_credit_balance_reached"

CustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedconst

"low_remaining_contract_credit_percentage_reached"

CustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedconst

"low_remaining_contract_credit_and_commit_balance_reached"

CustomerAlertAlertTypeInvoiceTotalReachedconst

"invoice_total_reached"

UpdatedAtTime

Timestamp for when the alert was last updated

formatdate-time

CreditGrantTypeFiltersarray

optional

[]string

An array of strings, representing a way to filter the credit grant this alert applies to, by looking at the credit_grant_type field on the credit grant. This field is only defined for CreditPercentage and CreditBalance alerts

CreditType

optional

CustomFieldFiltersarray

optional

[]CustomerAlertAlertCustomFieldFilter

A list of custom field filters for alert types that support advanced filtering

Hide ParametersShow Parameters

Entity

Hide ParametersShow Parameters

CustomerAlertAlertCustomFieldFiltersEntityContractconst

"Contract"

CustomerAlertAlertCustomFieldFiltersEntityCommitconst

"Commit"

CustomerAlertAlertCustomFieldFiltersEntityContractCreditconst

"ContractCredit"

Keystring

Valuestring

GroupKeyFilter

optional

Scopes alert evaluation to a specific presentation group key on individual line items. Only present for spend alerts.

Hide ParametersShow Parameters

Keystring

Valuestring

GroupValuesarray

optional

[]CustomerAlertAlertGroupValue

Only present for spend_threshold_reached alerts. Scope alert to a specific group key on individual line items.

Hide ParametersShow Parameters

Keystring

Valuestring

InvoiceTypesFilterarray

optional

[]string

Only supported for invoice_total_reached alerts. A list of invoice types to evaluate.

UniquenessKeystring

optional

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 request will fail with a 409 error.

minLength1

maxLength128

CustomerStatus

The status of the customer alert. If the alert is archived, null will be returned.

Hide ParametersShow Parameters

CustomerAlertCustomerStatusOkconst

"ok"

CustomerAlertCustomerStatusInAlarmconst

"in_alarm"

CustomerAlertCustomerStatusEvaluatingconst

"evaluating"

TriggeredBystring

optional

If present, indicates the reason the alert was triggered.

CustomersBilling Config

Set a customer billing configuration

client.V1.Customers.BillingConfig.New(ctx, params) error

post/v1/customers/{customer_id}/billing-config/{billing_provider_type}

Delete a customer billing configuration

client.V1.Customers.BillingConfig.Delete(ctx, body) error

delete/v1/customers/{customer_id}/billing-config/{billing_provider_type}

Get a customer billing configuration

client.V1.Customers.BillingConfig.Get(ctx, query) (*, error)

get/v1/customers/{customer_id}/billing-config/{billing_provider_type}

CustomersCommits

Create a commit

client.V1.Customers.Commits.New(ctx, body) (*, error)

post/v1/contracts/customerCommits/create

List commits

client.V1.Customers.Commits.List(ctx, body) (*, error)

post/v1/contracts/customerCommits/list

Update the commit end date

client.V1.Customers.Commits.UpdateEndDate(ctx, body) (*, error)

post/v1/contracts/customerCommits/updateEndDate

CustomersCredits

Create a credit

client.V1.Customers.Credits.New(ctx, body) (*, error)

post/v1/contracts/customerCredits/create

List credits

client.V1.Customers.Credits.List(ctx, body) (*, error)

post/v1/contracts/customerCredits/list

Update the credit end date

client.V1.Customers.Credits.UpdateEndDate(ctx, body) (*, error)

post/v1/contracts/customerCredits/updateEndDate

CustomersInvoices

Add a one time charge

client.V1.Customers.Invoices.AddCharge(ctx, params) (*V1CustomerInvoiceAddChargeResponse, error)

post/v1/customers/{customer_id}/addCharge

List invoices

client.V1.Customers.Invoices.List(ctx, params) (*CursorPage[], error)

get/v1/customers/{customer_id}/invoices

List invoice breakdowns

client.V1.Customers.Invoices.ListBreakdowns(ctx, params) (*CursorPage[], error)

get/v1/customers/{customer_id}/invoices/breakdowns

Get an invoice

client.V1.Customers.Invoices.Get(ctx, params) (*, error)

get/v1/customers/{customer_id}/invoices/{invoice_id}

Invoice

Invoicestruct

ShowShow

IDstring

formatuuid

CreditType

CustomerIDstring

formatuuid

LineItemsarray

[]InvoiceLineItem

Hide ParametersShow Parameters

CreditType

Namestring

Totalfloat64

AppliedCommitOrCredit

optional

Details about the credit or commit that was applied to this line item. Only present on line items with product of USAGE, SUBSCRIPTION or COMPOSITE types.

Hide ParametersShow Parameters

IDstring

formatuuid

Type

Hide ParametersShow Parameters

InvoiceLineItemsAppliedCommitOrCreditTypePrepaidconst

"PREPAID"

InvoiceLineItemsAppliedCommitOrCreditTypePostpaidconst

"POSTPAID"

InvoiceLineItemsAppliedCommitOrCreditTypeCreditconst

"CREDIT"

CommitCustomFieldsmap

optional

map[string, string]

CommitIDstring

optional

For line items with product of USAGE, SUBSCRIPTION, or COMPOSITE types, the ID of the credit or commit that was applied to this line item. For line items with product type of FIXED, the ID of the prepaid or postpaid commit that is being paid for.

formatuuid

CommitNetsuiteItemIDstring

optional

CommitNetsuiteSalesOrderIDstring

optional

CommitSegmentIDstring

optional

formatuuid

CommitTypestring

optional

PrepaidCommit (for commit types PREPAID and CREDIT) or PostpaidCommit (for commit type POSTPAID).

CustomFieldsmap

optional

map[string, string]

DiscountCustomFieldsmap

optional

map[string, string]

DiscountIDstring

optional

ID of the discount applied to this line item.

formatuuid

EndingBeforeTime

optional

The line item's end date (exclusive).

formatdate-time

GroupKeystring

optional

GroupValuestring

optional

IsProratedbool

optional

Indicates whether the line item is prorated for SUBSCRIPTION type product.

ListPrice

optional

Only present for contract invoices and when the include_list_prices query parameter is set to true. This will include the list rate for the charge if applicable. Only present for usage and subscription line items.

Metadatastring

optional

NetsuiteInvoiceBillingEndTime

optional

The end date for the billing period on the invoice.

formatdate-time

NetsuiteInvoiceBillingStartTime

optional

The start date for the billing period on the invoice.

formatdate-time

NetsuiteItemIDstring

optional

PostpaidCommit

optional

Only present for line items paying for a postpaid commit true-up.

Hide ParametersShow Parameters

IDstring

formatuuid

PresentationGroupValuesmap

optional

map[string, string]

Includes the presentation group values associated with this line item if presentation group keys are used.

PricingGroupValuesmap

optional

map[string, string]

Includes the pricing group values associated with this line item if dimensional pricing is used.

ProductCustomFieldsmap

optional

map[string, string]

ProductIDstring

optional

ID of the product associated with the line item.

formatuuid

ProductTagsarray

optional

[]string

The current product tags associated with the line item's product_id.

ProductTypestring

optional

The type of the line item's product. Possible values are FixedProductListItem (for FIXED type products), UsageProductListItem (for USAGE type products), SubscriptionProductListItem (for SUBSCRIPTION type products) or CompositeProductListItem (for COMPOSITE type products). For scheduled charges, commit and credit payments, the value is FixedProductListItem.

ProfessionalServiceCustomFieldsmap

optional

map[string, string]

ProfessionalServiceIDstring

optional

formatuuid

Quantityfloat64

optional

The quantity associated with the line item.

ResellerType

optional

Hide ParametersShow Parameters

InvoiceLineItemsResellerTypeAwsconst

"AWS"

InvoiceLineItemsResellerTypeAwsProServiceconst

"AWS_PRO_SERVICE"

InvoiceLineItemsResellerTypeGcpconst

"GCP"

InvoiceLineItemsResellerTypeGcpProServiceconst

"GCP_PRO_SERVICE"

ScheduledChargeCustomFieldsmap

optional

map[string, string]

ScheduledChargeIDstring

optional

ID of scheduled charge.

formatuuid

StartingAtTime

optional

The line item's start date (inclusive).

formatdate-time

SubLineItemsarray

optional

[]InvoiceLineItemsSubLineItem

Hide ParametersShow Parameters

CustomFieldsmap

map[string, string]

Namestring

Quantityfloat64

Subtotalfloat64

ChargeIDstring

optional

formatuuid

CreditGrantIDstring

optional

formatuuid

EndDateTime

optional

The end date for the charge (for seats charges only).

formatdate-time

Pricefloat64

optional

the unit price for this charge, present only if the charge is not tiered and the quantity is nonzero

StartDateTime

optional

The start date for the charge (for seats charges only).

formatdate-time

TierPeriod

optional

when the current tier started and ends (for tiered charges only)

Hide ParametersShow Parameters

StartingAtTime

formatdate-time

EndingBeforeTime

optional

formatdate-time

Tiersarray

optional

[]InvoiceLineItemsSubLineItemsTier

Hide ParametersShow Parameters

Pricefloat64

Quantityfloat64

StartingAtfloat64

at what metric amount this tier begins

Subtotalfloat64

SubscriptionCustomFieldsmap

optional

map[string, string]

Tier

optional

Populated if the line item has a tiered price.

Hide ParametersShow Parameters

Levelfloat64

StartingAtstring

Sizestring

optional

UnitPricefloat64

optional

The unit price associated with the line item.

Statusstring

Totalfloat64

Typestring

AmendmentIDstring

optional

formatuuid

BillableStatus

optional

This field's availability is dependent on your client's configuration.

Hide ParametersShow Parameters

InvoiceBillableStatusBillableconst

"billable"

InvoiceBillableStatusUnbillableconst

"unbillable"

ContractCustomFieldsmap

optional

map[string, string]

ContractIDstring

optional

formatuuid

CorrectionRecord

optional

Hide ParametersShow Parameters

CorrectedInvoiceIDstring

formatuuid

Memostring

Reasonstring

CorrectedExternalInvoice

optional

Hide ParametersShow Parameters

BillingProviderType

Hide ParametersShow Parameters

InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAwsMarketplaceconst

"aws_marketplace"

InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeStripeconst

"stripe"

InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeNetsuiteconst

"netsuite"

InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeCustomconst

"custom"

InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAzureMarketplaceconst

"azure_marketplace"

InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeQuickbooksOnlineconst

"quickbooks_online"

InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeWorkdayconst

"workday"

InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeGcpMarketplaceconst

"gcp_marketplace"

ExternalStatus

optional

Hide ParametersShow Parameters

InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDraftconst

"DRAFT"

InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusFinalizedconst

"FINALIZED"

InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaidconst

"PAID"

InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusUncollectibleconst

"UNCOLLECTIBLE"

InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusVoidconst

"VOID"

InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDeletedconst

"DELETED"

InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaymentFailedconst

"PAYMENT_FAILED"

InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvalidRequestErrorconst

"INVALID_REQUEST_ERROR"

InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSkippedconst

"SKIPPED"

InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSentconst

"SENT"

InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusQueuedconst

"QUEUED"

InvoiceIDstring

optional

IssuedAtTimestampTime

optional

formatdate-time

CreatedAtTime

optional

When the invoice was created (UTC). This field is present for correction invoices only.

formatdate-time

CustomFieldsmap

optional

map[string, unknown]

CustomerCustomFieldsmap

optional

map[string, string]

EndTimestampTime

optional

End of the usage period this invoice covers (UTC)

formatdate-time

ExternalInvoice

optional

Hide ParametersShow Parameters

BillingProviderType

Hide ParametersShow Parameters

InvoiceExternalInvoiceBillingProviderTypeAwsMarketplaceconst

"aws_marketplace"

InvoiceExternalInvoiceBillingProviderTypeStripeconst

"stripe"

InvoiceExternalInvoiceBillingProviderTypeNetsuiteconst

"netsuite"

InvoiceExternalInvoiceBillingProviderTypeCustomconst

"custom"

InvoiceExternalInvoiceBillingProviderTypeAzureMarketplaceconst

"azure_marketplace"

InvoiceExternalInvoiceBillingProviderTypeQuickbooksOnlineconst

"quickbooks_online"

InvoiceExternalInvoiceBillingProviderTypeWorkdayconst

"workday"

InvoiceExternalInvoiceBillingProviderTypeGcpMarketplaceconst

"gcp_marketplace"

ExternalStatus

optional

Hide ParametersShow Parameters

InvoiceExternalInvoiceExternalStatusDraftconst

"DRAFT"

InvoiceExternalInvoiceExternalStatusFinalizedconst

"FINALIZED"

InvoiceExternalInvoiceExternalStatusPaidconst

"PAID"

InvoiceExternalInvoiceExternalStatusUncollectibleconst

"UNCOLLECTIBLE"

InvoiceExternalInvoiceExternalStatusVoidconst

"VOID"

InvoiceExternalInvoiceExternalStatusDeletedconst

"DELETED"

InvoiceExternalInvoiceExternalStatusPaymentFailedconst

"PAYMENT_FAILED"

InvoiceExternalInvoiceExternalStatusInvalidRequestErrorconst

"INVALID_REQUEST_ERROR"

InvoiceExternalInvoiceExternalStatusSkippedconst

"SKIPPED"

InvoiceExternalInvoiceExternalStatusSentconst

"SENT"

InvoiceExternalInvoiceExternalStatusQueuedconst

"QUEUED"

InvoiceIDstring

optional

IssuedAtTimestampTime

optional

formatdate-time

InvoiceAdjustmentsarray

optional

[]InvoiceInvoiceAdjustment

Hide ParametersShow Parameters

CreditType

Namestring

Totalfloat64

CreditGrantCustomFieldsmap

optional

map[string, string]

CreditGrantIDstring

optional

IssuedAtTime

optional

When the invoice was issued (UTC)

formatdate-time

NetPaymentTermsDaysfloat64

optional

NetsuiteSalesOrderIDstring

optional

This field's availability is dependent on your client's configuration.

PlanCustomFieldsmap

optional

map[string, string]

PlanIDstring

optional

formatuuid

PlanNamestring

optional

ResellerRoyalty

optional

Only present for contract invoices with reseller royalties.

Hide ParametersShow Parameters

Fractionstring

NetsuiteResellerIDstring

ResellerType

Hide ParametersShow Parameters

InvoiceResellerRoyaltyResellerTypeAwsconst

"AWS"

InvoiceResellerRoyaltyResellerTypeAwsProServiceconst

"AWS_PRO_SERVICE"

InvoiceResellerRoyaltyResellerTypeGcpconst

"GCP"

InvoiceResellerRoyaltyResellerTypeGcpProServiceconst

"GCP_PRO_SERVICE"

AwsOptions

optional

Hide ParametersShow Parameters

AwsAccountNumberstring

optional

AwsOfferIDstring

optional

AwsPayerReferenceIDstring

optional

GcpOptions

optional

Hide ParametersShow Parameters

GcpAccountIDstring

optional

GcpOfferIDstring

optional

SalesforceOpportunityIDstring

optional

This field's availability is dependent on your client's configuration.

StartTimestampTime

optional

Beginning of the usage period this invoice covers (UTC)

formatdate-time

Subtotalfloat64

optional

CustomersNamed Schedules

Get a customer's named schedule

client.V1.Customers.NamedSchedules.Get(ctx, body) (*, error)

post/v1/customers/getNamedSchedule

Update a customer's named schedule

client.V1.Customers.NamedSchedules.Update(ctx, body) error

post/v1/customers/updateNamedSchedule

Customers

Customers

Customers

Customer

Customer Detail

CustomersAlerts

Customer Alert

CustomersBilling Config

CustomersCommits

CustomersCredits

CustomersInvoices

Invoice

CustomersNamed Schedules

CustomersPlans