API Reference
Libraries
API Overview
V1
V1Alerts
Archive an alert
post/v1/alerts/archive
Create an alert
post/v1/alerts/create
V1Audit Logs
Get audit logs
get/v1/auditLogs
V1Billable Metrics
Archive a billable metric
post/v1/billable-metrics/archive
Create a billable metric
post/v1/billable-metrics/create
List all billable metrics
get/v1/billable-metrics
Get a billable metric
get/v1/billable-metrics/{billable_metric_id}
V1Contracts
Add a manual balance entry
post/v1/contracts/addManualBalanceLedgerEntry
Amend a contract
post/v1/contracts/amend
Archive a contract
post/v1/contracts/archive
Create a contract
post/v1/contracts/create
Create historical invoices
post/v1/contracts/createHistoricalInvoices
List customer contracts (v1)
post/v1/contracts/list
List balances
post/v1/contracts/customerBalances/list
Get a contract (v1)
post/v1/contracts/get
Get the rate schedule for a contract
post/v1/contracts/getContractRateSchedule
Get subscription quantity history
post/v1/contracts/getSubscriptionQuantityHistory
Schedule ProService invoice
post/v1/contracts/scheduleProServicesInvoice
Set a contract usage filter
post/v1/contracts/setUsageFilter
Update the contract end date
post/v1/contracts/updateEndDate
V1ContractsNamed Schedules
Get a rate card's named schedule
post/v1/contract-pricing/rate-cards/getNamedSchedule
Update a rate card's named schedule
post/v1/contract-pricing/rate-cards/updateNamedSchedule
V1ContractsProducts
Archive a product
post/v1/contract-pricing/products/archive
Create a product
post/v1/contract-pricing/products/create
List products
post/v1/contract-pricing/products/list
Get a product
post/v1/contract-pricing/products/get
Update a product
post/v1/contract-pricing/products/update
V1ContractsRate Cards
Archive a rate card
post/v1/contract-pricing/rate-cards/archive
Create a rate card
post/v1/contract-pricing/rate-cards/create
List rate cards
post/v1/contract-pricing/rate-cards/list
Get a rate card
post/v1/contract-pricing/rate-cards/get
Get a rate schedule
post/v1/contract-pricing/rate-cards/getRateSchedule
Update a rate card
post/v1/contract-pricing/rate-cards/update
V1ContractsRate CardsNamed Schedules
Get a contract's named schedule
post/v1/contracts/getNamedSchedule
Update a contract's named schedule
post/v1/contracts/updateNamedSchedule
V1ContractsRate CardsProduct Orders
Set the rate card products order
post/v1/contract-pricing/rate-cards/setRateCardProductsOrder
Update the rate card products order
post/v1/contract-pricing/rate-cards/moveRateCardProducts
V1ContractsRate CardsRates
Add a rate
post/v1/contract-pricing/rate-cards/addRate
Add rates
post/v1/contract-pricing/rate-cards/addRates
Get rates
post/v1/contract-pricing/rate-cards/getRates
V1Credit Grants
Create a credit grant
post/v1/credits/createGrant
Update a credit grant
post/v1/credits/editGrant
List credit grants
post/v1/credits/listGrants
List credit ledger entries
post/v1/credits/listEntries
Void a credit grant
post/v1/credits/voidGrant
V1Custom Fields
Create a custom field key
post/v1/customFields/addKey
Delete custom fields
post/v1/customFields/deleteValues
List custom field keys
post/v1/customFields/listKeys
Delete a custom field key
post/v1/customFields/removeKey
Set custom field values
post/v1/customFields/setValues
V1Customers
Archive a customer
post/v1/customers/archive
Create a customer
post/v1/customers
List customers
get/v1/customers
Get billable metrics for a customer
get/v1/customers/{customer_id}/billable-metrics
Get customer costs
get/v1/customers/{customer_id}/costs
Preview events
post/v1/customers/{customer_id}/previewEvents
Get a customer
get/v1/customers/{customer_id}
Create or update customer ingest aliases
post/v1/customers/{customer_id}/setIngestAliases
Update a customer name
post/v1/customers/{customer_id}/setName
Update a customer configuration
post/v1/customers/{customer_id}/updateConfig
V1CustomersAlerts
List customer alerts
post/v1/customer-alerts/list
Reset an alert for a customer
post/v1/customer-alerts/reset
Get an alert
post/v1/customer-alerts/get
V1CustomersBilling Config
Set a customer billing configuration
post/v1/customers/{customer_id}/billing-config/{billing_provider_type}
Delete a customer billing configuration
delete/v1/customers/{customer_id}/billing-config/{billing_provider_type}
Get a customer billing configuration
get/v1/customers/{customer_id}/billing-config/{billing_provider_type}
V1CustomersCommits
Create a commit
post/v1/contracts/customerCommits/create
List commits
post/v1/contracts/customerCommits/list
Update the commit end date
post/v1/contracts/customerCommits/updateEndDate
V1CustomersCredits
Create a credit
post/v1/contracts/customerCredits/create
List credits
post/v1/contracts/customerCredits/list
Update the credit end date
post/v1/contracts/customerCredits/updateEndDate
V1CustomersInvoices
Add a one time charge
post/v1/customers/{customer_id}/addCharge
List invoices
get/v1/customers/{customer_id}/invoices
List invoice breakdowns
get/v1/customers/{customer_id}/invoices/breakdowns
Get an invoice
get/v1/customers/{customer_id}/invoices/{invoice_id}
V1CustomersNamed Schedules
Get a customer's named schedule
post/v1/customers/getNamedSchedule
Update a customer's named schedule
post/v1/customers/updateNamedSchedule
V1CustomersPlans
Add a plan to a customer
post/v1/customers/{customer_id}/plans/add
End a customer plan
post/v1/customers/{customer_id}/plans/{customer_plan_id}/end
List customer plans
get/v1/customers/{customer_id}/plans
Get the plan adjustments for a customer
get/v1/customers/{customer_id}/plans/{customer_plan_id}/priceAdjustments
V1Dashboards
Get an embeddable customer dashboard
post/v1/dashboards/getEmbeddableUrl
V1Invoices
Regenerate an invoice
post/v1/invoices/regenerate
Void an invoice
post/v1/invoices/void
V1Plans
Get plan details
get/v1/planDetails/{plan_id}
List plans
get/v1/plans
List plan charges
get/v1/planDetails/{plan_id}/charges
List customers on a plan
get/v1/planDetails/{plan_id}/customers
V1Pricing Units
List pricing units
get/v1/credit-types/list
V1Services
Get services
get/v1/services
V1Usage
Ingest events
post/v1/ingest
Get batched usage data
post/v1/usage
Get usage data with paginated groupings
post/v1/usage/groups
Search events
post/v1/events/search
V2
V2Contracts
Edit a contract
post/v2/contracts/edit
Edit a commit
post/v2/contracts/commits/edit
Edit a credit
post/v2/contracts/credits/edit
Get contract edit history
post/v2/contracts/getEditHistory
List customer contracts (v2)
post/v2/contracts/list
Get a contract (v2)
post/v2/contracts/get