Skip to content
Metronome Docs
  • Auto
  • Light
  • Dark
Talk to an expert

V1

API Reference

V1

V1

V1Alerts

Archive an alert
client.V1.Alerts.Archive(ctx, body) (*DataIDV1AlertArchiveResponse, error)
post/v1/alerts/archive
Create an alert
client.V1.Alerts.New(ctx, body) (*DataIDV1AlertNewResponse, error)
post/v1/alerts/create

V1Audit Logs

Get audit logs
client.V1.AuditLogs.List(ctx, query) (*CursorPage[IDstringRequestV1AuditLogListResponseRequestTimestampTimeActionstringActorV1AuditLogListResponseActorDescriptionstringResourceIDstringResourceTypestringStatusV1AuditLogListResponseStatusV1AuditLogListResponse], error)
get/v1/auditLogs

V1Billable Metrics

Archive a billable metric
client.V1.BillableMetrics.Archive(ctx, body) (*DataIDV1BillableMetricArchiveResponse, error)
post/v1/billable-metrics/archive
Create a billable metric
client.V1.BillableMetrics.New(ctx, body) (*DataIDV1BillableMetricNewResponse, error)
post/v1/billable-metrics/create
List all billable metrics
client.V1.BillableMetrics.List(ctx, query) (*CursorPage[IDstringNamestringAggregationKeystringAggregationTypeV1BillableMetricListResponseAggregationTypeArchivedAtTimeCustomFieldsmapEventTypeFilterEventTypeFilterGroupKeysarrayPropertyFiltersarraySqlstringV1BillableMetricListResponse], error)
get/v1/billable-metrics
Get a billable metric
client.V1.BillableMetrics.Get(ctx, query) (*DataV1BillableMetricGetResponseDataV1BillableMetricGetResponse, error)
get/v1/billable-metrics/{billable_metric_id}

V1Contracts

Add a manual balance entry
client.V1.Contracts.AddManualBalanceEntry(ctx, body) error
post/v1/contracts/addManualBalanceLedgerEntry
Amend a contract
client.V1.Contracts.Amend(ctx, body) (*DataIDV1ContractAmendResponse, error)
post/v1/contracts/amend
Archive a contract
client.V1.Contracts.Archive(ctx, body) (*DataIDV1ContractArchiveResponse, error)
post/v1/contracts/archive
Create a contract
client.V1.Contracts.New(ctx, body) (*DataIDV1ContractNewResponse, error)
post/v1/contracts/create
Create historical invoices
client.V1.Contracts.NewHistoricalInvoices(ctx, body) (*DataarrayV1ContractNewHistoricalInvoicesResponse, error)
post/v1/contracts/createHistoricalInvoices
List customer contracts (v1)
client.V1.Contracts.List(ctx, body) (*DataarrayV1ContractListResponse, error)
post/v1/contracts/list
List balances
client.V1.Contracts.ListBalances(ctx, body) (*DataarrayNextPagestringV1ContractListBalancesResponse, error)
post/v1/contracts/customerBalances/list
Get a contract (v1)
client.V1.Contracts.Get(ctx, body) (*DataV1ContractGetResponseDataV1ContractGetResponse, error)
post/v1/contracts/get
Get the rate schedule for a contract
client.V1.Contracts.GetRateSchedule(ctx, params) (*DataarrayNextPagestringV1ContractGetRateScheduleResponse, error)
post/v1/contracts/getContractRateSchedule
Get subscription quantity history
client.V1.Contracts.GetSubscriptionQuantityHistory(ctx, body) (*DataV1ContractGetSubscriptionQuantityHistoryResponseDataV1ContractGetSubscriptionQuantityHistoryResponse, error)
post/v1/contracts/getSubscriptionQuantityHistory
Schedule ProService invoice
client.V1.Contracts.ScheduleProServicesInvoice(ctx, body) (*DataarrayV1ContractScheduleProServicesInvoiceResponse, error)
post/v1/contracts/scheduleProServicesInvoice
Set a contract usage filter
client.V1.Contracts.SetUsageFilter(ctx, body) error
post/v1/contracts/setUsageFilter
Update the contract end date
client.V1.Contracts.UpdateEndDate(ctx, body) (*DataIDV1ContractUpdateEndDateResponse, error)
post/v1/contracts/updateEndDate

V1ContractsNamed Schedules

Get a rate card's named schedule
client.V1.Contracts.NamedSchedules.Get(ctx, body) (*DataarrayV1ContractNamedScheduleGetResponse, error)
post/v1/contract-pricing/rate-cards/getNamedSchedule
Update a rate card's named schedule
client.V1.Contracts.NamedSchedules.Update(ctx, body) error
post/v1/contract-pricing/rate-cards/updateNamedSchedule

V1ContractsProducts

Archive a product
client.V1.Contracts.Products.Archive(ctx, body) (*DataIDV1ContractProductArchiveResponse, error)
post/v1/contract-pricing/products/archive
Create a product
client.V1.Contracts.Products.New(ctx, body) (*DataIDV1ContractProductNewResponse, error)
post/v1/contract-pricing/products/create
List products
client.V1.Contracts.Products.List(ctx, params) (*CursorPage[IDstringCurrentProductListItemStateInitialProductListItemStateTypeV1ContractProductListResponseTypeUpdatesarrayArchivedAtTimeCustomFieldsmapV1ContractProductListResponse], error)
post/v1/contract-pricing/products/list
Get a product
client.V1.Contracts.Products.Get(ctx, body) (*DataV1ContractProductGetResponseDataV1ContractProductGetResponse, error)
post/v1/contract-pricing/products/get
Update a product
client.V1.Contracts.Products.Update(ctx, body) (*DataIDV1ContractProductUpdateResponse, error)
post/v1/contract-pricing/products/update
Product List Item State
ProductListItemStatestruct
ShowShow
CreatedAtTime
formatdate-time
CreatedBystring
Namestring
BillableMetricIDstring
optional
CompositeProductIDsarray
optional
[]string
CompositeTagsarray
optional
[]string
ExcludeFreeUsagebool
optional
IsRefundablebool
optional

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

NetsuiteInternalItemIDstring
optional

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

NetsuiteOverageItemIDstring
optional

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

PresentationGroupKeyarray
optional
[]string

For USAGE products only. Groups usage line items on invoices. The superset of values in the pricing group key and presentation group key must be set as one compound group key on the billable metric.

PricingGroupKeyarray
optional
[]string

For USAGE products only. If set, pricing for this product will be determined for each pricing_group_key value, as opposed to the product as a whole. The superset of values in the pricing group key and presentation group key must be set as one compound group key on the billable metric.

QuantityConversionConversionFactorfloat64OperationQuantityConversionOperationNamestringQuantityConversion
optional

Optional. Only valid for USAGE products. If provided, the quantity will be converted using the provided conversion factor and operation. For example, if the operation is "multiply" and the conversion factor is 100, then the quantity will be multiplied by 100. This can be used in cases where data is sent in one unit and priced in another. For example, data could be sent in MB and priced in GB. In this case, the conversion factor would be 1024 and the operation would be "divide".

QuantityRoundingDecimalPlacesfloat64RoundingMethodQuantityRoundingRoundingMethodQuantityRounding
optional

Optional. Only valid for USAGE products. If provided, the quantity will be rounded using the provided rounding method and decimal places. For example, if the method is "round up" and the decimal places is 0, then the quantity will be rounded up to the nearest integer.

StartingAtTime
optional
formatdate-time
Tagsarray
optional
[]string
Quantity Conversion
QuantityConversionstruct

Optional. Only valid for USAGE products. If provided, the quantity will be converted using the provided conversion factor and operation. For example, if the operation is "multiply" and the conversion factor is 100, then the quantity will be multiplied by 100. This can be used in cases where data is sent in one unit and priced in another. For example, data could be sent in MB and priced in GB. In this case, the conversion factor would be 1024 and the operation would be "divide".

ShowShow
ConversionFactorfloat64

The factor to multiply or divide the quantity by.

OperationQuantityConversionOperationMultiplyQuantityConversionOperationQuantityConversionOperationDivideQuantityConversionOperationQuantityConversionOperation

The operation to perform on the quantity

Hide ParametersShow Parameters
QuantityConversionOperationMultiplyconst
QuantityConversionOperationMultiplyQuantityConversionOperationQuantityConversionOperationDivideQuantityConversionOperationQuantityConversionOperation
"MULTIPLY"
QuantityConversionOperationDivideconst
QuantityConversionOperationMultiplyQuantityConversionOperationQuantityConversionOperationDivideQuantityConversionOperationQuantityConversionOperation
"DIVIDE"
Namestring
optional

Optional name for this conversion.

Quantity Rounding
QuantityRoundingstruct

Optional. Only valid for USAGE products. If provided, the quantity will be rounded using the provided rounding method and decimal places. For example, if the method is "round up" and the decimal places is 0, then the quantity will be rounded up to the nearest integer.

ShowShow
DecimalPlacesfloat64
minimum0
RoundingMethodQuantityRoundingRoundingMethodRoundUpQuantityRoundingRoundingMethodQuantityRoundingRoundingMethodRoundDownQuantityRoundingRoundingMethodQuantityRoundingRoundingMethodRoundHalfUpQuantityRoundingRoundingMethodQuantityRoundingRoundingMethod
Hide ParametersShow Parameters
QuantityRoundingRoundingMethodRoundUpconst
QuantityRoundingRoundingMethodRoundUpQuantityRoundingRoundingMethodQuantityRoundingRoundingMethodRoundDownQuantityRoundingRoundingMethodQuantityRoundingRoundingMethodRoundHalfUpQuantityRoundingRoundingMethodQuantityRoundingRoundingMethod
"ROUND_UP"
QuantityRoundingRoundingMethodRoundDownconst
QuantityRoundingRoundingMethodRoundUpQuantityRoundingRoundingMethodQuantityRoundingRoundingMethodRoundDownQuantityRoundingRoundingMethodQuantityRoundingRoundingMethodRoundHalfUpQuantityRoundingRoundingMethodQuantityRoundingRoundingMethod
"ROUND_DOWN"
QuantityRoundingRoundingMethodRoundHalfUpconst
QuantityRoundingRoundingMethodRoundUpQuantityRoundingRoundingMethodQuantityRoundingRoundingMethodRoundDownQuantityRoundingRoundingMethodQuantityRoundingRoundingMethodRoundHalfUpQuantityRoundingRoundingMethodQuantityRoundingRoundingMethod
"ROUND_HALF_UP"

V1ContractsRate Cards

Archive a rate card
client.V1.Contracts.RateCards.Archive(ctx, body) (*DataIDV1ContractRateCardArchiveResponse, error)
post/v1/contract-pricing/rate-cards/archive
Create a rate card
client.V1.Contracts.RateCards.New(ctx, body) (*DataIDV1ContractRateCardNewResponse, error)
post/v1/contract-pricing/rate-cards/create
List rate cards
client.V1.Contracts.RateCards.List(ctx, params) (*CursorPage[IDstringCreatedAtTimeCreatedBystringNamestringAliasesarrayCreditTypeConversionsarrayCustomFieldsmapDescriptionstringFiatCreditTypeCreditTypeDataV1ContractRateCardListResponse], error)
post/v1/contract-pricing/rate-cards/list
Get a rate card
client.V1.Contracts.RateCards.Get(ctx, body) (*DataV1ContractRateCardGetResponseDataV1ContractRateCardGetResponse, error)
post/v1/contract-pricing/rate-cards/get
Get a rate schedule
client.V1.Contracts.RateCards.GetRateSchedule(ctx, params) (*DataarrayNextPagestringV1ContractRateCardGetRateScheduleResponse, error)
post/v1/contract-pricing/rate-cards/getRateSchedule
Update a rate card
client.V1.Contracts.RateCards.Update(ctx, body) (*DataIDV1ContractRateCardUpdateResponse, error)
post/v1/contract-pricing/rate-cards/update

V1ContractsRate CardsNamed Schedules

Get a contract's named schedule
client.V1.Contracts.RateCards.NamedSchedules.Get(ctx, body) (*DataarrayV1ContractRateCardNamedScheduleGetResponse, error)
post/v1/contracts/getNamedSchedule
Update a contract's named schedule
client.V1.Contracts.RateCards.NamedSchedules.Update(ctx, body) error
post/v1/contracts/updateNamedSchedule

V1ContractsRate CardsProduct Orders

Set the rate card products order
client.V1.Contracts.RateCards.ProductOrders.Set(ctx, body) (*DataIDV1ContractRateCardProductOrderSetResponse, error)
post/v1/contract-pricing/rate-cards/setRateCardProductsOrder
Update the rate card products order
client.V1.Contracts.RateCards.ProductOrders.Update(ctx, body) (*DataIDV1ContractRateCardProductOrderUpdateResponse, error)
post/v1/contract-pricing/rate-cards/moveRateCardProducts

V1ContractsRate CardsRates

Add a rate
client.V1.Contracts.RateCards.Rates.Add(ctx, body) (*DataV1ContractRateCardRateAddResponseDataV1ContractRateCardRateAddResponse, error)
post/v1/contract-pricing/rate-cards/addRate
Add rates
client.V1.Contracts.RateCards.Rates.AddMany(ctx, body) (*DataIDV1ContractRateCardRateAddManyResponse, error)
post/v1/contract-pricing/rate-cards/addRates
Get rates
client.V1.Contracts.RateCards.Rates.List(ctx, params) (*CursorPage[EntitledboolProductCustomFieldsmapProductIDstringProductNamestringProductTagsarrayRateRateStartingAtTimeBillingFrequencyV1ContractRateCardRateListResponseBillingFrequencyCommitRateV1ContractRateCardRateListResponseCommitRateEndingBeforeTimePricingGroupValuesmapV1ContractRateCardRateListResponse], error)
post/v1/contract-pricing/rate-cards/getRates

V1Credit Grants

Create a credit grant
client.V1.CreditGrants.New(ctx, body) (*DataIDV1CreditGrantNewResponse, error)
post/v1/credits/createGrant
Update a credit grant
client.V1.CreditGrants.Edit(ctx, body) (*DataIDV1CreditGrantEditResponse, error)
post/v1/credits/editGrant
List credit grants
client.V1.CreditGrants.List(ctx, params) (*CursorPage[IDstringBalanceV1CreditGrantListResponseBalanceCustomFieldsmapCustomerIDstringDeductionsarrayEffectiveAtTimeExpiresAtTimeGrantAmountV1CreditGrantListResponseGrantAmountNamestringPaidAmountV1CreditGrantListResponsePaidAmountPendingDeductionsarrayPriorityfloat64CreditGrantTypestringInvoiceIDstringProductsarrayReasonstringUniquenessKeystringV1CreditGrantListResponse], error)
post/v1/credits/listGrants
List credit ledger entries
client.V1.CreditGrants.ListEntries(ctx, params) (*DataarrayNextPagestringV1CreditGrantListEntriesResponse, error)
post/v1/credits/listEntries
Void a credit grant
client.V1.CreditGrants.Void(ctx, body) (*DataIDV1CreditGrantVoidResponse, error)
post/v1/credits/voidGrant
Credit Ledger Entry
CreditLedgerEntrystruct
ShowShow
Amountfloat64

an amount representing the change to the customer's credit balance

CreatedBystring
CreditGrantIDstring

the credit grant this entry is related to

formatuuid
EffectiveAtTime
formatdate-time
Reasonstring
RunningBalancefloat64

the running balance for this credit type at the time of the ledger entry, including all preceding charges

InvoiceIDstring
optional

if this entry is a deduction, the Metronome ID of the invoice where the credit deduction was consumed; if this entry is a grant, the Metronome ID of the invoice where the grant's paid_amount was charged

formatuuid
Rollover Amount Max Amount
RolloverAmountMaxAmountstruct
ShowShow
TypeRolloverAmountMaxAmountTypeMaxAmountRolloverAmountMaxAmountTypeRolloverAmountMaxAmountType

Rollover up to a fixed amount of the original credit grant amount.

Hide ParametersShow Parameters
RolloverAmountMaxAmountTypeMaxAmountconst
RolloverAmountMaxAmountTypeMaxAmountRolloverAmountMaxAmountTypeRolloverAmountMaxAmountType
"MAX_AMOUNT"
Valuefloat64

The maximum amount to rollover.

Rollover Amount Max Percentage
RolloverAmountMaxPercentagestruct
ShowShow
TypeRolloverAmountMaxPercentageTypeMaxPercentageRolloverAmountMaxPercentageTypeRolloverAmountMaxPercentageType

Rollover up to a percentage of the original credit grant amount.

Hide ParametersShow Parameters
RolloverAmountMaxPercentageTypeMaxPercentageconst
RolloverAmountMaxPercentageTypeMaxPercentageRolloverAmountMaxPercentageTypeRolloverAmountMaxPercentageType
"MAX_PERCENTAGE"
Valuefloat64

The maximum percentage (0-1) of the original credit grant to rollover.

minimum0
maximum1

V1Custom Fields

Create a custom field key
client.V1.CustomFields.AddKey(ctx, body) error
post/v1/customFields/addKey
Delete custom fields
client.V1.CustomFields.DeleteValues(ctx, body) error
post/v1/customFields/deleteValues
List custom field keys
client.V1.CustomFields.ListKeys(ctx, params) (*DataarrayNextPagestringV1CustomFieldListKeysResponse, error)
post/v1/customFields/listKeys
Delete a custom field key
client.V1.CustomFields.RemoveKey(ctx, body) error
post/v1/customFields/removeKey
Set custom field values
client.V1.CustomFields.SetValues(ctx, body) error
post/v1/customFields/setValues

V1Customers

Archive a customer
client.V1.Customers.Archive(ctx, body) (*DataIDV1CustomerArchiveResponse, error)
post/v1/customers/archive
Create a customer
client.V1.Customers.New(ctx, body) (*DataCustomerV1CustomerNewResponse, error)
post/v1/customers
List customers
client.V1.Customers.List(ctx, query) (*CursorPage[IDstringCreatedAtTimeCustomFieldsmapCustomerConfigCustomerDetailCustomerConfigExternalIDstringIngestAliasesarrayNamestringArchivedAtTimeCurrentBillableStatusCustomerDetailCurrentBillableStatusCustomerDetail], error)
get/v1/customers
Get billable metrics for a customer
client.V1.Customers.ListBillableMetrics(ctx, params) (*CursorPage[IDstringNamestringAggregatestringAggregateKeysarrayAggregationKeystringAggregationTypeV1CustomerListBillableMetricsResponseAggregationTypeArchivedAtTimeCustomFieldsmapEventTypeFilterEventTypeFilterFiltermapGroupByarrayGroupKeysarrayPropertyFiltersarraySqlstringV1CustomerListBillableMetricsResponse], error)
get/v1/customers/{customer_id}/billable-metrics
Get customer costs
client.V1.Customers.ListCosts(ctx, params) (*CursorPage[CreditTypesmapEndTimestampTimeStartTimestampTimeV1CustomerListCostsResponse], error)
get/v1/customers/{customer_id}/costs
Preview events
client.V1.Customers.PreviewEvents(ctx, params) (*DataInvoiceV1CustomerPreviewEventsResponse, error)
post/v1/customers/{customer_id}/previewEvents
Get a customer
client.V1.Customers.Get(ctx, query) (*DataCustomerDetailV1CustomerGetResponse, 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) (*DataCustomerV1CustomerSetNameResponse, 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]
CustomerConfigSalesforceAccountIDstringCustomerDetailCustomerConfig
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
CurrentBillableStatusValueCustomerDetailCurrentBillableStatusValueEffectiveAtTimeCustomerDetailCurrentBillableStatus
optional

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

Hide ParametersShow Parameters
ValueCustomerDetailCurrentBillableStatusValueBillableCustomerDetailCurrentBillableStatusValueCustomerDetailCurrentBillableStatusValueUnbillableCustomerDetailCurrentBillableStatusValueCustomerDetailCurrentBillableStatusValue
Hide ParametersShow Parameters
CustomerDetailCurrentBillableStatusValueBillableconst
CustomerDetailCurrentBillableStatusValueBillableCustomerDetailCurrentBillableStatusValueCustomerDetailCurrentBillableStatusValueUnbillableCustomerDetailCurrentBillableStatusValueCustomerDetailCurrentBillableStatusValue
"billable"
CustomerDetailCurrentBillableStatusValueUnbillableconst
CustomerDetailCurrentBillableStatusValueBillableCustomerDetailCurrentBillableStatusValueCustomerDetailCurrentBillableStatusValueUnbillableCustomerDetailCurrentBillableStatusValueCustomerDetailCurrentBillableStatusValue
"unbillable"
EffectiveAtTime
optional
formatdate-time

V1CustomersAlerts

List customer alerts
client.V1.Customers.Alerts.List(ctx, params) (*DataarrayNextPagestringV1CustomerAlertListResponse, 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) (*DataCustomerAlertV1CustomerAlertGetResponse, error)
post/v1/customer-alerts/get
Customer Alert
CustomerAlertstruct
ShowShow
AlertIDstringNamestringStatusCustomerAlertAlertStatusThresholdfloat64TypeCustomerAlertAlertTypeUpdatedAtTimeCreditGrantTypeFiltersarrayCreditTypeCreditTypeDataCustomFieldFiltersarrayGroupKeyFilterCustomerAlertAlertGroupKeyFilterGroupValuesarrayInvoiceTypesFilterarrayUniquenessKeystringCustomerAlertAlert
Hide ParametersShow Parameters
IDstring

the Metronome ID of the alert

Namestring

Name of the alert

StatusCustomerAlertAlertStatusEnabledCustomerAlertAlertStatusCustomerAlertAlertStatusArchivedCustomerAlertAlertStatusCustomerAlertAlertStatusDisabledCustomerAlertAlertStatusCustomerAlertAlertStatus

Status of the alert

Hide ParametersShow Parameters
CustomerAlertAlertStatusEnabledconst
CustomerAlertAlertStatusEnabledCustomerAlertAlertStatusCustomerAlertAlertStatusArchivedCustomerAlertAlertStatusCustomerAlertAlertStatusDisabledCustomerAlertAlertStatusCustomerAlertAlertStatus
"enabled"
CustomerAlertAlertStatusArchivedconst
CustomerAlertAlertStatusEnabledCustomerAlertAlertStatusCustomerAlertAlertStatusArchivedCustomerAlertAlertStatusCustomerAlertAlertStatusDisabledCustomerAlertAlertStatusCustomerAlertAlertStatus
"archived"
CustomerAlertAlertStatusDisabledconst
CustomerAlertAlertStatusEnabledCustomerAlertAlertStatusCustomerAlertAlertStatusArchivedCustomerAlertAlertStatusCustomerAlertAlertStatusDisabledCustomerAlertAlertStatusCustomerAlertAlertStatus
"disabled"
Thresholdfloat64

Threshold value of the alert policy

TypeCustomerAlertAlertTypeLowCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysInPlanReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeUsageThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeInvoiceTotalReachedCustomerAlertAlertTypeCustomerAlertAlertType

Type of the alert

Hide ParametersShow Parameters
CustomerAlertAlertTypeLowCreditBalanceReachedconst
CustomerAlertAlertTypeLowCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysInPlanReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeUsageThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeInvoiceTotalReachedCustomerAlertAlertTypeCustomerAlertAlertType
"low_credit_balance_reached"
CustomerAlertAlertTypeSpendThresholdReachedconst
CustomerAlertAlertTypeLowCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysInPlanReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeUsageThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeInvoiceTotalReachedCustomerAlertAlertTypeCustomerAlertAlertType
"spend_threshold_reached"
CustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedconst
CustomerAlertAlertTypeLowCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysInPlanReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeUsageThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeInvoiceTotalReachedCustomerAlertAlertTypeCustomerAlertAlertType
"monthly_invoice_total_spend_threshold_reached"
CustomerAlertAlertTypeLowRemainingDaysInPlanReachedconst
CustomerAlertAlertTypeLowCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysInPlanReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeUsageThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeInvoiceTotalReachedCustomerAlertAlertTypeCustomerAlertAlertType
"low_remaining_days_in_plan_reached"
CustomerAlertAlertTypeLowRemainingCreditPercentageReachedconst
CustomerAlertAlertTypeLowCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysInPlanReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeUsageThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeInvoiceTotalReachedCustomerAlertAlertTypeCustomerAlertAlertType
"low_remaining_credit_percentage_reached"
CustomerAlertAlertTypeUsageThresholdReachedconst
CustomerAlertAlertTypeLowCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysInPlanReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeUsageThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeInvoiceTotalReachedCustomerAlertAlertTypeCustomerAlertAlertType
"usage_threshold_reached"
CustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedconst
CustomerAlertAlertTypeLowCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysInPlanReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeUsageThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeInvoiceTotalReachedCustomerAlertAlertTypeCustomerAlertAlertType
"low_remaining_days_for_commit_segment_reached"
CustomerAlertAlertTypeLowRemainingCommitBalanceReachedconst
CustomerAlertAlertTypeLowCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysInPlanReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeUsageThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeInvoiceTotalReachedCustomerAlertAlertTypeCustomerAlertAlertType
"low_remaining_commit_balance_reached"
CustomerAlertAlertTypeLowRemainingCommitPercentageReachedconst
CustomerAlertAlertTypeLowCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysInPlanReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeUsageThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeInvoiceTotalReachedCustomerAlertAlertTypeCustomerAlertAlertType
"low_remaining_commit_percentage_reached"
CustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedconst
CustomerAlertAlertTypeLowCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysInPlanReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeUsageThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeInvoiceTotalReachedCustomerAlertAlertTypeCustomerAlertAlertType
"low_remaining_days_for_contract_credit_segment_reached"
CustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedconst
CustomerAlertAlertTypeLowCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysInPlanReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeUsageThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeInvoiceTotalReachedCustomerAlertAlertTypeCustomerAlertAlertType
"low_remaining_contract_credit_balance_reached"
CustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedconst
CustomerAlertAlertTypeLowCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysInPlanReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeUsageThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeInvoiceTotalReachedCustomerAlertAlertTypeCustomerAlertAlertType
"low_remaining_contract_credit_percentage_reached"
CustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedconst
CustomerAlertAlertTypeLowCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysInPlanReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeUsageThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeInvoiceTotalReachedCustomerAlertAlertTypeCustomerAlertAlertType
"low_remaining_contract_credit_and_commit_balance_reached"
CustomerAlertAlertTypeInvoiceTotalReachedconst
CustomerAlertAlertTypeLowCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeMonthlyInvoiceTotalSpendThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysInPlanReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeUsageThresholdReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForCommitSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingCommitPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingDaysForContractCreditSegmentReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditPercentageReachedCustomerAlertAlertTypeCustomerAlertAlertTypeLowRemainingContractCreditAndCommitBalanceReachedCustomerAlertAlertTypeCustomerAlertAlertTypeInvoiceTotalReachedCustomerAlertAlertTypeCustomerAlertAlertType
"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

CreditTypeIDstringNamestringCreditTypeData
optional
CustomFieldFiltersarray
optional
[]CustomerAlertAlertCustomFieldFilter

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

Hide ParametersShow Parameters
EntityCustomerAlertAlertCustomFieldFiltersEntityContractCustomerAlertAlertCustomFieldFiltersEntityCustomerAlertAlertCustomFieldFiltersEntityCommitCustomerAlertAlertCustomFieldFiltersEntityCustomerAlertAlertCustomFieldFiltersEntityContractCreditCustomerAlertAlertCustomFieldFiltersEntityCustomerAlertAlertCustomFieldFiltersEntity
Hide ParametersShow Parameters
CustomerAlertAlertCustomFieldFiltersEntityContractconst
CustomerAlertAlertCustomFieldFiltersEntityContractCustomerAlertAlertCustomFieldFiltersEntityCustomerAlertAlertCustomFieldFiltersEntityCommitCustomerAlertAlertCustomFieldFiltersEntityCustomerAlertAlertCustomFieldFiltersEntityContractCreditCustomerAlertAlertCustomFieldFiltersEntityCustomerAlertAlertCustomFieldFiltersEntity
"Contract"
CustomerAlertAlertCustomFieldFiltersEntityCommitconst
CustomerAlertAlertCustomFieldFiltersEntityContractCustomerAlertAlertCustomFieldFiltersEntityCustomerAlertAlertCustomFieldFiltersEntityCommitCustomerAlertAlertCustomFieldFiltersEntityCustomerAlertAlertCustomFieldFiltersEntityContractCreditCustomerAlertAlertCustomFieldFiltersEntityCustomerAlertAlertCustomFieldFiltersEntity
"Commit"
CustomerAlertAlertCustomFieldFiltersEntityContractCreditconst
CustomerAlertAlertCustomFieldFiltersEntityContractCustomerAlertAlertCustomFieldFiltersEntityCustomerAlertAlertCustomFieldFiltersEntityCommitCustomerAlertAlertCustomFieldFiltersEntityCustomerAlertAlertCustomFieldFiltersEntityContractCreditCustomerAlertAlertCustomFieldFiltersEntityCustomerAlertAlertCustomFieldFiltersEntity
"ContractCredit"
Keystring
Valuestring
GroupKeyFilterKeystringValuestringCustomerAlertAlertGroupKeyFilter
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
CustomerStatusCustomerAlertCustomerStatusOkCustomerAlertCustomerStatusCustomerAlertCustomerStatusInAlarmCustomerAlertCustomerStatusCustomerAlertCustomerStatusEvaluatingCustomerAlertCustomerStatusCustomerAlertCustomerStatus

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

Hide ParametersShow Parameters
CustomerAlertCustomerStatusOkconst
CustomerAlertCustomerStatusOkCustomerAlertCustomerStatusCustomerAlertCustomerStatusInAlarmCustomerAlertCustomerStatusCustomerAlertCustomerStatusEvaluatingCustomerAlertCustomerStatusCustomerAlertCustomerStatus
"ok"
CustomerAlertCustomerStatusInAlarmconst
CustomerAlertCustomerStatusOkCustomerAlertCustomerStatusCustomerAlertCustomerStatusInAlarmCustomerAlertCustomerStatusCustomerAlertCustomerStatusEvaluatingCustomerAlertCustomerStatusCustomerAlertCustomerStatus
"in_alarm"
CustomerAlertCustomerStatusEvaluatingconst
CustomerAlertCustomerStatusOkCustomerAlertCustomerStatusCustomerAlertCustomerStatusInAlarmCustomerAlertCustomerStatusCustomerAlertCustomerStatusEvaluatingCustomerAlertCustomerStatusCustomerAlertCustomerStatus
"evaluating"
TriggeredBystring
optional

If present, indicates the reason the alert was triggered.

V1CustomersBilling 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) (*DataV1CustomerBillingConfigGetResponseDataV1CustomerBillingConfigGetResponse, error)
get/v1/customers/{customer_id}/billing-config/{billing_provider_type}

V1CustomersCommits

Create a commit
client.V1.Customers.Commits.New(ctx, body) (*DataIDV1CustomerCommitNewResponse, error)
post/v1/contracts/customerCommits/create
List commits
client.V1.Customers.Commits.List(ctx, body) (*DataarrayNextPagestringV1CustomerCommitListResponse, error)
post/v1/contracts/customerCommits/list
Update the commit end date
client.V1.Customers.Commits.UpdateEndDate(ctx, body) (*DataIDV1CustomerCommitUpdateEndDateResponse, error)
post/v1/contracts/customerCommits/updateEndDate

V1CustomersCredits

Create a credit
client.V1.Customers.Credits.New(ctx, body) (*DataIDV1CustomerCreditNewResponse, error)
post/v1/contracts/customerCredits/create
List credits
client.V1.Customers.Credits.List(ctx, body) (*DataarrayNextPagestringV1CustomerCreditListResponse, error)
post/v1/contracts/customerCredits/list
Update the credit end date
client.V1.Customers.Credits.UpdateEndDate(ctx, body) (*DataIDV1CustomerCreditUpdateEndDateResponse, error)
post/v1/contracts/customerCredits/updateEndDate

V1CustomersInvoices

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[IDstringCreditTypeCreditTypeDataCustomerIDstringLineItemsarrayStatusstringTotalfloat64TypestringAmendmentIDstringBillableStatusInvoiceBillableStatusContractCustomFieldsmapContractIDstringCorrectionRecordInvoiceCorrectionRecordCreatedAtTimeCustomFieldsmapCustomerCustomFieldsmapEndTimestampTimeExternalInvoiceInvoiceExternalInvoiceInvoiceAdjustmentsarrayIssuedAtTimeNetPaymentTermsDaysfloat64NetsuiteSalesOrderIDstringPlanCustomFieldsmapPlanIDstringPlanNamestringResellerRoyaltyInvoiceResellerRoyaltySalesforceOpportunityIDstringStartTimestampTimeSubtotalfloat64Invoice], error)
get/v1/customers/{customer_id}/invoices
List invoice breakdowns
client.V1.Customers.Invoices.ListBreakdowns(ctx, params) (*CursorPage[BreakdownEndTimestampTimeBreakdownStartTimestampTimeV1CustomerInvoiceListBreakdownsResponse], error)
get/v1/customers/{customer_id}/invoices/breakdowns
Get an invoice
client.V1.Customers.Invoices.Get(ctx, params) (*DataInvoiceV1CustomerInvoiceGetResponse, error)
get/v1/customers/{customer_id}/invoices/{invoice_id}
Invoice
Invoicestruct
ShowShow
IDstring
formatuuid
CreditTypeIDstringNamestringCreditTypeData
CustomerIDstring
formatuuid
LineItemsarray
[]InvoiceLineItem
Hide ParametersShow Parameters
CreditTypeIDstringNamestringCreditTypeData
Namestring
Totalfloat64
AppliedCommitOrCreditIDstringTypeInvoiceLineItemsAppliedCommitOrCreditTypeInvoiceLineItemsAppliedCommitOrCredit
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
TypeInvoiceLineItemsAppliedCommitOrCreditTypePrepaidInvoiceLineItemsAppliedCommitOrCreditTypeInvoiceLineItemsAppliedCommitOrCreditTypePostpaidInvoiceLineItemsAppliedCommitOrCreditTypeInvoiceLineItemsAppliedCommitOrCreditTypeCreditInvoiceLineItemsAppliedCommitOrCreditTypeInvoiceLineItemsAppliedCommitOrCreditType
Hide ParametersShow Parameters
InvoiceLineItemsAppliedCommitOrCreditTypePrepaidconst
InvoiceLineItemsAppliedCommitOrCreditTypePrepaidInvoiceLineItemsAppliedCommitOrCreditTypeInvoiceLineItemsAppliedCommitOrCreditTypePostpaidInvoiceLineItemsAppliedCommitOrCreditTypeInvoiceLineItemsAppliedCommitOrCreditTypeCreditInvoiceLineItemsAppliedCommitOrCreditTypeInvoiceLineItemsAppliedCommitOrCreditType
"PREPAID"
InvoiceLineItemsAppliedCommitOrCreditTypePostpaidconst
InvoiceLineItemsAppliedCommitOrCreditTypePrepaidInvoiceLineItemsAppliedCommitOrCreditTypeInvoiceLineItemsAppliedCommitOrCreditTypePostpaidInvoiceLineItemsAppliedCommitOrCreditTypeInvoiceLineItemsAppliedCommitOrCreditTypeCreditInvoiceLineItemsAppliedCommitOrCreditTypeInvoiceLineItemsAppliedCommitOrCreditType
"POSTPAID"
InvoiceLineItemsAppliedCommitOrCreditTypeCreditconst
InvoiceLineItemsAppliedCommitOrCreditTypePrepaidInvoiceLineItemsAppliedCommitOrCreditTypeInvoiceLineItemsAppliedCommitOrCreditTypePostpaidInvoiceLineItemsAppliedCommitOrCreditTypeInvoiceLineItemsAppliedCommitOrCreditTypeCreditInvoiceLineItemsAppliedCommitOrCreditTypeInvoiceLineItemsAppliedCommitOrCreditType
"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.

ListPriceRateTypeRateRateTypeCreditTypeCreditTypeDataCustomRatemapIsProratedboolPricefloat64PricingGroupValuesmapQuantityfloat64TiersarrayUseListPricesboolRate
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
PostpaidCommitIDstringInvoiceLineItemsPostpaidCommit
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.

ResellerTypeInvoiceLineItemsResellerTypeAwsInvoiceLineItemsResellerTypeInvoiceLineItemsResellerTypeAwsProServiceInvoiceLineItemsResellerTypeInvoiceLineItemsResellerTypeGcpInvoiceLineItemsResellerTypeInvoiceLineItemsResellerTypeGcpProServiceInvoiceLineItemsResellerTypeInvoiceLineItemsResellerType
optional
Hide ParametersShow Parameters
InvoiceLineItemsResellerTypeAwsconst
InvoiceLineItemsResellerTypeAwsInvoiceLineItemsResellerTypeInvoiceLineItemsResellerTypeAwsProServiceInvoiceLineItemsResellerTypeInvoiceLineItemsResellerTypeGcpInvoiceLineItemsResellerTypeInvoiceLineItemsResellerTypeGcpProServiceInvoiceLineItemsResellerTypeInvoiceLineItemsResellerType
"AWS"
InvoiceLineItemsResellerTypeAwsProServiceconst
InvoiceLineItemsResellerTypeAwsInvoiceLineItemsResellerTypeInvoiceLineItemsResellerTypeAwsProServiceInvoiceLineItemsResellerTypeInvoiceLineItemsResellerTypeGcpInvoiceLineItemsResellerTypeInvoiceLineItemsResellerTypeGcpProServiceInvoiceLineItemsResellerTypeInvoiceLineItemsResellerType
"AWS_PRO_SERVICE"
InvoiceLineItemsResellerTypeGcpconst
InvoiceLineItemsResellerTypeAwsInvoiceLineItemsResellerTypeInvoiceLineItemsResellerTypeAwsProServiceInvoiceLineItemsResellerTypeInvoiceLineItemsResellerTypeGcpInvoiceLineItemsResellerTypeInvoiceLineItemsResellerTypeGcpProServiceInvoiceLineItemsResellerTypeInvoiceLineItemsResellerType
"GCP"
InvoiceLineItemsResellerTypeGcpProServiceconst
InvoiceLineItemsResellerTypeAwsInvoiceLineItemsResellerTypeInvoiceLineItemsResellerTypeAwsProServiceInvoiceLineItemsResellerTypeInvoiceLineItemsResellerTypeGcpInvoiceLineItemsResellerTypeInvoiceLineItemsResellerTypeGcpProServiceInvoiceLineItemsResellerTypeInvoiceLineItemsResellerType
"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
TierPeriodStartingAtTimeEndingBeforeTimeInvoiceLineItemsSubLineItemsTierPeriod
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]
TierLevelfloat64StartingAtstringSizestringInvoiceLineItemsTier
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
BillableStatusInvoiceBillableStatusBillableInvoiceBillableStatusInvoiceBillableStatusUnbillableInvoiceBillableStatusInvoiceBillableStatus
optional

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

Hide ParametersShow Parameters
InvoiceBillableStatusBillableconst
InvoiceBillableStatusBillableInvoiceBillableStatusInvoiceBillableStatusUnbillableInvoiceBillableStatusInvoiceBillableStatus
"billable"
InvoiceBillableStatusUnbillableconst
InvoiceBillableStatusBillableInvoiceBillableStatusInvoiceBillableStatusUnbillableInvoiceBillableStatusInvoiceBillableStatus
"unbillable"
ContractCustomFieldsmap
optional
map[string, string]
ContractIDstring
optional
formatuuid
CorrectionRecordCorrectedInvoiceIDstringMemostringReasonstringCorrectedExternalInvoiceInvoiceCorrectionRecordCorrectedExternalInvoiceInvoiceCorrectionRecord
optional
Hide ParametersShow Parameters
CorrectedInvoiceIDstring
formatuuid
Memostring
Reasonstring
CorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceIDstringIssuedAtTimestampTimeInvoiceCorrectionRecordCorrectedExternalInvoice
optional
Hide ParametersShow Parameters
BillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeStripeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeNetsuiteInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeCustomInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeWorkdayInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderType
Hide ParametersShow Parameters
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAwsMarketplaceconst
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeStripeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeNetsuiteInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeCustomInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeWorkdayInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderType
"aws_marketplace"
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeStripeconst
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeStripeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeNetsuiteInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeCustomInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeWorkdayInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderType
"stripe"
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeNetsuiteconst
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeStripeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeNetsuiteInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeCustomInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeWorkdayInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderType
"netsuite"
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeCustomconst
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeStripeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeNetsuiteInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeCustomInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeWorkdayInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderType
"custom"
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAzureMarketplaceconst
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeStripeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeNetsuiteInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeCustomInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeWorkdayInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderType
"azure_marketplace"
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeQuickbooksOnlineconst
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeStripeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeNetsuiteInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeCustomInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeWorkdayInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderType
"quickbooks_online"
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeWorkdayconst
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeStripeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeNetsuiteInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeCustomInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeWorkdayInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderType
"workday"
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeGcpMarketplaceconst
InvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeStripeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeNetsuiteInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeCustomInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeWorkdayInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderTypeInvoiceCorrectionRecordCorrectedExternalInvoiceBillingProviderType
"gcp_marketplace"
ExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDraftInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusFinalizedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusUncollectibleInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusVoidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDeletedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaymentFailedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvalidRequestErrorInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSkippedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSentInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusQueuedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatus
optional
Hide ParametersShow Parameters
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDraftconst
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDraftInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusFinalizedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusUncollectibleInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusVoidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDeletedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaymentFailedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvalidRequestErrorInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSkippedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSentInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusQueuedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatus
"DRAFT"
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusFinalizedconst
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDraftInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusFinalizedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusUncollectibleInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusVoidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDeletedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaymentFailedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvalidRequestErrorInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSkippedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSentInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusQueuedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatus
"FINALIZED"
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaidconst
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDraftInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusFinalizedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusUncollectibleInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusVoidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDeletedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaymentFailedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvalidRequestErrorInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSkippedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSentInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusQueuedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatus
"PAID"
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusUncollectibleconst
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDraftInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusFinalizedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusUncollectibleInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusVoidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDeletedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaymentFailedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvalidRequestErrorInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSkippedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSentInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusQueuedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatus
"UNCOLLECTIBLE"
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusVoidconst
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDraftInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusFinalizedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusUncollectibleInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusVoidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDeletedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaymentFailedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvalidRequestErrorInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSkippedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSentInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusQueuedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatus
"VOID"
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDeletedconst
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDraftInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusFinalizedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusUncollectibleInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusVoidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDeletedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaymentFailedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvalidRequestErrorInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSkippedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSentInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusQueuedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatus
"DELETED"
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaymentFailedconst
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDraftInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusFinalizedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusUncollectibleInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusVoidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDeletedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaymentFailedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvalidRequestErrorInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSkippedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSentInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusQueuedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatus
"PAYMENT_FAILED"
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvalidRequestErrorconst
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDraftInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusFinalizedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusUncollectibleInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusVoidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDeletedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaymentFailedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvalidRequestErrorInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSkippedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSentInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusQueuedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatus
"INVALID_REQUEST_ERROR"
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSkippedconst
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDraftInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusFinalizedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusUncollectibleInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusVoidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDeletedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaymentFailedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvalidRequestErrorInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSkippedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSentInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusQueuedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatus
"SKIPPED"
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSentconst
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDraftInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusFinalizedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusUncollectibleInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusVoidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDeletedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaymentFailedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvalidRequestErrorInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSkippedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSentInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusQueuedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatus
"SENT"
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusQueuedconst
InvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDraftInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusFinalizedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusUncollectibleInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusVoidInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusDeletedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusPaymentFailedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvalidRequestErrorInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSkippedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusSentInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusQueuedInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatusInvoiceCorrectionRecordCorrectedExternalInvoiceExternalStatus
"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
ExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeExternalStatusInvoiceExternalInvoiceExternalStatusInvoiceIDstringIssuedAtTimestampTimeInvoiceExternalInvoice
optional
Hide ParametersShow Parameters
BillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeStripeInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeNetsuiteInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeCustomInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeWorkdayInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderType
Hide ParametersShow Parameters
InvoiceExternalInvoiceBillingProviderTypeAwsMarketplaceconst
InvoiceExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeStripeInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeNetsuiteInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeCustomInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeWorkdayInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderType
"aws_marketplace"
InvoiceExternalInvoiceBillingProviderTypeStripeconst
InvoiceExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeStripeInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeNetsuiteInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeCustomInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeWorkdayInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderType
"stripe"
InvoiceExternalInvoiceBillingProviderTypeNetsuiteconst
InvoiceExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeStripeInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeNetsuiteInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeCustomInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeWorkdayInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderType
"netsuite"
InvoiceExternalInvoiceBillingProviderTypeCustomconst
InvoiceExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeStripeInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeNetsuiteInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeCustomInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeWorkdayInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderType
"custom"
InvoiceExternalInvoiceBillingProviderTypeAzureMarketplaceconst
InvoiceExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeStripeInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeNetsuiteInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeCustomInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeWorkdayInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderType
"azure_marketplace"
InvoiceExternalInvoiceBillingProviderTypeQuickbooksOnlineconst
InvoiceExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeStripeInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeNetsuiteInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeCustomInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeWorkdayInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderType
"quickbooks_online"
InvoiceExternalInvoiceBillingProviderTypeWorkdayconst
InvoiceExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeStripeInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeNetsuiteInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeCustomInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeWorkdayInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderType
"workday"
InvoiceExternalInvoiceBillingProviderTypeGcpMarketplaceconst
InvoiceExternalInvoiceBillingProviderTypeAwsMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeStripeInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeNetsuiteInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeCustomInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeAzureMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeQuickbooksOnlineInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeWorkdayInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderTypeGcpMarketplaceInvoiceExternalInvoiceBillingProviderTypeInvoiceExternalInvoiceBillingProviderType
"gcp_marketplace"
ExternalStatusInvoiceExternalInvoiceExternalStatusDraftInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusFinalizedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusUncollectibleInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusVoidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusDeletedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaymentFailedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusInvalidRequestErrorInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSkippedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSentInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusQueuedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatus
optional
Hide ParametersShow Parameters
InvoiceExternalInvoiceExternalStatusDraftconst
InvoiceExternalInvoiceExternalStatusDraftInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusFinalizedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusUncollectibleInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusVoidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusDeletedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaymentFailedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusInvalidRequestErrorInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSkippedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSentInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusQueuedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatus
"DRAFT"
InvoiceExternalInvoiceExternalStatusFinalizedconst
InvoiceExternalInvoiceExternalStatusDraftInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusFinalizedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusUncollectibleInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusVoidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusDeletedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaymentFailedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusInvalidRequestErrorInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSkippedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSentInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusQueuedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatus
"FINALIZED"
InvoiceExternalInvoiceExternalStatusPaidconst
InvoiceExternalInvoiceExternalStatusDraftInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusFinalizedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusUncollectibleInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusVoidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusDeletedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaymentFailedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusInvalidRequestErrorInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSkippedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSentInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusQueuedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatus
"PAID"
InvoiceExternalInvoiceExternalStatusUncollectibleconst
InvoiceExternalInvoiceExternalStatusDraftInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusFinalizedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusUncollectibleInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusVoidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusDeletedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaymentFailedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusInvalidRequestErrorInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSkippedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSentInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusQueuedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatus
"UNCOLLECTIBLE"
InvoiceExternalInvoiceExternalStatusVoidconst
InvoiceExternalInvoiceExternalStatusDraftInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusFinalizedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusUncollectibleInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusVoidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusDeletedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaymentFailedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusInvalidRequestErrorInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSkippedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSentInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusQueuedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatus
"VOID"
InvoiceExternalInvoiceExternalStatusDeletedconst
InvoiceExternalInvoiceExternalStatusDraftInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusFinalizedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusUncollectibleInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusVoidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusDeletedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaymentFailedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusInvalidRequestErrorInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSkippedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSentInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusQueuedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatus
"DELETED"
InvoiceExternalInvoiceExternalStatusPaymentFailedconst
InvoiceExternalInvoiceExternalStatusDraftInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusFinalizedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusUncollectibleInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusVoidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusDeletedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaymentFailedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusInvalidRequestErrorInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSkippedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSentInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusQueuedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatus
"PAYMENT_FAILED"
InvoiceExternalInvoiceExternalStatusInvalidRequestErrorconst
InvoiceExternalInvoiceExternalStatusDraftInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusFinalizedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusUncollectibleInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusVoidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusDeletedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaymentFailedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusInvalidRequestErrorInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSkippedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSentInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusQueuedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatus
"INVALID_REQUEST_ERROR"
InvoiceExternalInvoiceExternalStatusSkippedconst
InvoiceExternalInvoiceExternalStatusDraftInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusFinalizedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusUncollectibleInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusVoidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusDeletedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaymentFailedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusInvalidRequestErrorInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSkippedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSentInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusQueuedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatus
"SKIPPED"
InvoiceExternalInvoiceExternalStatusSentconst
InvoiceExternalInvoiceExternalStatusDraftInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusFinalizedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusUncollectibleInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusVoidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusDeletedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaymentFailedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusInvalidRequestErrorInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSkippedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSentInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusQueuedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatus
"SENT"
InvoiceExternalInvoiceExternalStatusQueuedconst
InvoiceExternalInvoiceExternalStatusDraftInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusFinalizedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusUncollectibleInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusVoidInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusDeletedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusPaymentFailedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusInvalidRequestErrorInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSkippedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusSentInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatusQueuedInvoiceExternalInvoiceExternalStatusInvoiceExternalInvoiceExternalStatus
"QUEUED"
InvoiceIDstring
optional
IssuedAtTimestampTime
optional
formatdate-time
InvoiceAdjustmentsarray
optional
[]InvoiceInvoiceAdjustment
Hide ParametersShow Parameters
CreditTypeIDstringNamestringCreditTypeData
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
ResellerRoyaltyFractionstringNetsuiteResellerIDstringResellerTypeInvoiceResellerRoyaltyResellerTypeAwsOptionsInvoiceResellerRoyaltyAwsOptionsGcpOptionsInvoiceResellerRoyaltyGcpOptionsInvoiceResellerRoyalty
optional

Only present for contract invoices with reseller royalties.

Hide ParametersShow Parameters
Fractionstring
NetsuiteResellerIDstring
ResellerTypeInvoiceResellerRoyaltyResellerTypeAwsInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerTypeAwsProServiceInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerTypeGcpInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerTypeGcpProServiceInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerType
Hide ParametersShow Parameters
InvoiceResellerRoyaltyResellerTypeAwsconst
InvoiceResellerRoyaltyResellerTypeAwsInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerTypeAwsProServiceInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerTypeGcpInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerTypeGcpProServiceInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerType
"AWS"
InvoiceResellerRoyaltyResellerTypeAwsProServiceconst
InvoiceResellerRoyaltyResellerTypeAwsInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerTypeAwsProServiceInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerTypeGcpInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerTypeGcpProServiceInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerType
"AWS_PRO_SERVICE"
InvoiceResellerRoyaltyResellerTypeGcpconst
InvoiceResellerRoyaltyResellerTypeAwsInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerTypeAwsProServiceInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerTypeGcpInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerTypeGcpProServiceInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerType
"GCP"
InvoiceResellerRoyaltyResellerTypeGcpProServiceconst
InvoiceResellerRoyaltyResellerTypeAwsInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerTypeAwsProServiceInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerTypeGcpInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerTypeGcpProServiceInvoiceResellerRoyaltyResellerTypeInvoiceResellerRoyaltyResellerType
"GCP_PRO_SERVICE"
AwsOptionsAwsAccountNumberstringAwsOfferIDstringAwsPayerReferenceIDstringInvoiceResellerRoyaltyAwsOptions
optional
Hide ParametersShow Parameters
AwsAccountNumberstring
optional
AwsOfferIDstring
optional
AwsPayerReferenceIDstring
optional
GcpOptionsGcpAccountIDstringGcpOfferIDstringInvoiceResellerRoyaltyGcpOptions
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

V1CustomersNamed Schedules

Get a customer's named schedule
client.V1.Customers.NamedSchedules.Get(ctx, body) (*DataarrayV1CustomerNamedScheduleGetResponse, error)
post/v1/customers/getNamedSchedule
Update a customer's named schedule
client.V1.Customers.NamedSchedules.Update(ctx, body) error
post/v1/customers/updateNamedSchedule

V1CustomersPlans

Add a plan to a customer
client.V1.Customers.Plans.Add(ctx, params) (*DataIDV1CustomerPlanAddResponse, error)
post/v1/customers/{customer_id}/plans/add
End a customer plan
client.V1.Customers.Plans.End(ctx, params) (*V1CustomerPlanEndResponse, error)
post/v1/customers/{customer_id}/plans/{customer_plan_id}/end
List customer plans
client.V1.Customers.Plans.List(ctx, params) (*CursorPage[IDstringCustomFieldsmapPlanDescriptionstringPlanIDstringPlanNamestringStartingOnTimeEndingBeforeTimeNetPaymentTermsDaysfloat64TrialInfoV1CustomerPlanListResponseTrialInfoV1CustomerPlanListResponse], error)
get/v1/customers/{customer_id}/plans
Get the plan adjustments for a customer
client.V1.Customers.Plans.ListPriceAdjustments(ctx, params) (*CursorPage[ChargeIDstringChargeTypeV1CustomerPlanListPriceAdjustmentsResponseChargeTypePricesarrayStartPeriodfloat64Quantityfloat64V1CustomerPlanListPriceAdjustmentsResponse], error)
get/v1/customers/{customer_id}/plans/{customer_plan_id}/priceAdjustments

V1Dashboards

Get an embeddable customer dashboard
client.V1.Dashboards.GetEmbeddableURL(ctx, body) (*DataV1DashboardGetEmbeddableURLResponseDataV1DashboardGetEmbeddableURLResponse, error)
post/v1/dashboards/getEmbeddableUrl

V1Invoices

Regenerate an invoice
client.V1.Invoices.Regenerate(ctx, body) (*DataV1InvoiceRegenerateResponseDataV1InvoiceRegenerateResponse, error)
post/v1/invoices/regenerate
Void an invoice
client.V1.Invoices.Void(ctx, body) (*DataV1InvoiceVoidResponseDataV1InvoiceVoidResponse, error)
post/v1/invoices/void

V1Plans

Get plan details
client.V1.Plans.GetDetails(ctx, query) (*DataPlanDetailV1PlanGetDetailsResponse, error)
get/v1/planDetails/{plan_id}
List plans
client.V1.Plans.List(ctx, query) (*CursorPage[IDstringDescriptionstringNamestringCustomFieldsmapV1PlanListResponse], error)
get/v1/plans
List plan charges
client.V1.Plans.ListCharges(ctx, params) (*CursorPage[IDstringChargeTypeV1PlanListChargesResponseChargeTypeCreditTypeCreditTypeDataCustomFieldsmapNamestringPricesarrayProductIDstringProductNamestringQuantityfloat64StartPeriodfloat64TierResetFrequencyfloat64UnitConversionV1PlanListChargesResponseUnitConversionV1PlanListChargesResponse], error)
get/v1/planDetails/{plan_id}/charges
List customers on a plan
client.V1.Plans.ListCustomers(ctx, params) (*CursorPage[CustomerDetailsCustomerDetailPlanDetailsV1PlanListCustomersResponsePlanDetailsV1PlanListCustomersResponse], error)
get/v1/planDetails/{plan_id}/customers
Plan Detail
PlanDetailstruct
ShowShow
IDstring
formatuuid
CustomFieldsmap
map[string, string]
Namestring
CreditGrantsarray
optional
[]PlanDetailCreditGrant
Hide ParametersShow Parameters
AmountGrantedfloat64
AmountGrantedCreditTypeIDstringNamestringCreditTypeData
AmountPaidfloat64
AmountPaidCreditTypeIDstringNamestringCreditTypeData
EffectiveDurationfloat64
Namestring
Prioritystring
SendInvoicebool
Reasonstring
optional
RecurrenceDurationfloat64
optional
RecurrenceIntervalfloat64
optional
Descriptionstring
optional
Minimumsarray
optional
[]PlanDetailMinimum
Hide ParametersShow Parameters
CreditTypeIDstringNamestringCreditTypeData
Namestring
StartPeriodfloat64

Used in price ramps. Indicates how many billing periods pass before the charge applies.

Valuefloat64
OverageRatesarray
optional
[]PlanDetailOverageRate
Hide ParametersShow Parameters
CreditTypeIDstringNamestringCreditTypeData
FiatCreditTypeIDstringNamestringCreditTypeData
StartPeriodfloat64

Used in price ramps. Indicates how many billing periods pass before the charge applies.

ToFiatConversionFactorfloat64

V1Pricing Units

List pricing units
client.V1.PricingUnits.List(ctx, query) (*CursorPage[IDstringIsCurrencyboolNamestringV1PricingUnitListResponse], error)
get/v1/credit-types/list

V1Services

Get services
client.V1.Services.List(ctx) (*ServicesarrayV1ServiceListResponse, error)
get/v1/services

V1Usage

Ingest events
client.V1.Usage.Ingest(ctx, body) error
post/v1/ingest
Get batched usage data
client.V1.Usage.List(ctx, params) (*DataarrayNextPagestringV1UsageListResponse, error)
post/v1/usage
Get usage data with paginated groupings
client.V1.Usage.ListWithGroups(ctx, params) (*CursorPage[EndingBeforeTimeGroupKeystringGroupValuestringStartingOnTimeValuefloat64V1UsageListWithGroupsResponse], error)
post/v1/usage/groups
Search events
client.V1.Usage.Search(ctx, body) (*[]V1UsageSearchResponse, error)
post/v1/events/search