api.md

Shared

Types:

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

Alerts

Types:

• AlertCreateResponse
• AlertArchiveResponse

Methods:

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

Plans

Types:

• PlanDetail
• PlanListResponse
• PlanGetDetailsResponse
• PlanListChargesResponse
• PlanListCustomersResponse

Methods:

• client.plans.list({ ...params }) -> PlanListResponsesCursorPage
• client.plans.getDetails({ ...params }) -> PlanGetDetailsResponse
• client.plans.listCharges({ ...params }) -> PlanListChargesResponsesCursorPage
• client.plans.listCustomers({ ...params }) -> PlanListCustomersResponsesCursorPage

CreditGrants

Types:

• CreditLedgerEntry
• RolloverAmountMaxAmount
• RolloverAmountMaxPercentage
• CreditGrantCreateResponse
• CreditGrantListResponse
• CreditGrantEditResponse
• CreditGrantListEntriesResponse
• CreditGrantVoidResponse

Methods:

• client.creditGrants.create({ ...params }) -> CreditGrantCreateResponse
• client.creditGrants.list({ ...params }) -> CreditGrantListResponsesCursorPage
• client.creditGrants.edit({ ...params }) -> CreditGrantEditResponse
• client.creditGrants.listEntries({ ...params }) -> CreditGrantListEntriesResponse
• client.creditGrants.void({ ...params }) -> CreditGrantVoidResponse

PricingUnits

Types:

• PricingUnitListResponse

Methods:

• client.pricingUnits.list({ ...params }) -> PricingUnitListResponsesCursorPage

Customers

Types:

• Customer
• CustomerDetail
• CustomerCreateResponse
• CustomerRetrieveResponse
• CustomerArchiveResponse
• CustomerListBillableMetricsResponse
• CustomerListCostsResponse
• CustomerSetNameResponse

Methods:

• client.customers.create({ ...params }) -> CustomerCreateResponse
• client.customers.retrieve({ ...params }) -> CustomerRetrieveResponse
• client.customers.list({ ...params }) -> CustomerDetailsCursorPage
• client.customers.archive({ ...params }) -> CustomerArchiveResponse
• client.customers.listBillableMetrics({ ...params }) -> CustomerListBillableMetricsResponsesCursorPage
• client.customers.listCosts({ ...params }) -> CustomerListCostsResponsesCursorPage
• client.customers.setIngestAliases({ ...params }) -> void
• client.customers.setName({ ...params }) -> CustomerSetNameResponse
• client.customers.updateConfig({ ...params }) -> void

Alerts

Types:

• CustomerAlert
• AlertRetrieveResponse
• AlertListResponse

Methods:

• client.customers.alerts.retrieve({ ...params }) -> AlertRetrieveResponse
• client.customers.alerts.list({ ...params }) -> AlertListResponse
• client.customers.alerts.reset({ ...params }) -> void

Plans

Types:

• PlanListResponse
• PlanAddResponse
• PlanEndResponse
• PlanListPriceAdjustmentsResponse

Methods:

• client.customers.plans.list({ ...params }) -> PlanListResponsesCursorPage
• client.customers.plans.add({ ...params }) -> PlanAddResponse
• client.customers.plans.end({ ...params }) -> PlanEndResponse
• client.customers.plans.listPriceAdjustments({ ...params }) -> PlanListPriceAdjustmentsResponsesCursorPage

Invoices

Types:

• Invoice
• InvoiceRetrieveResponse
• InvoiceAddChargeResponse
• InvoiceListBreakdownsResponse

Methods:

• client.customers.invoices.retrieve({ ...params }) -> InvoiceRetrieveResponse
• client.customers.invoices.list({ ...params }) -> InvoicesCursorPage
• client.customers.invoices.addCharge({ ...params }) -> InvoiceAddChargeResponse
• client.customers.invoices.listBreakdowns({ ...params }) -> InvoiceListBreakdownsResponsesCursorPage

BillingConfig

Types:

• BillingConfigRetrieveResponse

Methods:

• client.customers.billingConfig.create({ ...params }) -> void
• client.customers.billingConfig.retrieve({ ...params }) -> BillingConfigRetrieveResponse
• client.customers.billingConfig.delete({ ...params }) -> void

Commits

Types:

• CommitCreateResponse
• CommitListResponse
• CommitUpdateEndDateResponse

Methods:

• client.customers.commits.create({ ...params }) -> CommitCreateResponse
• client.customers.commits.list({ ...params }) -> CommitListResponse
• client.customers.commits.updateEndDate({ ...params }) -> CommitUpdateEndDateResponse

Credits

Types:

• CreditCreateResponse
• CreditListResponse
• CreditUpdateEndDateResponse

Methods:

• client.customers.credits.create({ ...params }) -> CreditCreateResponse
• client.customers.credits.list({ ...params }) -> CreditListResponse
• client.customers.credits.updateEndDate({ ...params }) -> CreditUpdateEndDateResponse

NamedSchedules

Types:

• NamedScheduleRetrieveResponse

Methods:

• client.customers.namedSchedules.retrieve({ ...params }) -> NamedScheduleRetrieveResponse
• client.customers.namedSchedules.update({ ...params }) -> void

Dashboards

Types:

• DashboardGetEmbeddableURLResponse

Methods:

• client.dashboards.getEmbeddableURL({ ...params }) -> DashboardGetEmbeddableURLResponse

Webhooks

Methods:

• client.webhooks.unwrap(payload, headers, secret) -> Object
• client.webhooks.verifySignature(body, headers, secret) -> void

Usage

Types:

• UsageListResponse
• UsageListWithGroupsResponse

Methods:

• client.usage.list({ ...params }) -> UsageListResponse
• client.usage.ingest([ ...usage ]) -> void
• client.usage.listWithGroups({ ...params }) -> UsageListWithGroupsResponsesCursorPage

AuditLogs

Types:

• AuditLogListResponse

Methods:

• client.auditLogs.list({ ...params }) -> AuditLogListResponsesCursorPage

CustomFields

Types:

• CustomFieldListKeysResponse

Methods:

• client.customFields.addKey({ ...params }) -> void
• client.customFields.deleteValues({ ...params }) -> void
• client.customFields.listKeys({ ...params }) -> CustomFieldListKeysResponse
• client.customFields.removeKey({ ...params }) -> void
• client.customFields.setValues({ ...params }) -> void

BillableMetrics

Types:

• BillableMetricCreateResponse
• BillableMetricRetrieveResponse
• BillableMetricListResponse
• BillableMetricArchiveResponse

Methods:

• client.billableMetrics.create({ ...params }) -> BillableMetricCreateResponse
• client.billableMetrics.retrieve({ ...params }) -> BillableMetricRetrieveResponse
• client.billableMetrics.list({ ...params }) -> BillableMetricListResponsesCursorPage
• client.billableMetrics.archive({ ...params }) -> BillableMetricArchiveResponse

Services

Types:

• ServiceListResponse

Methods:

• client.services.list() -> ServiceListResponse

Invoices

Types:

• InvoiceRegenerateResponse
• InvoiceVoidResponse

Methods:

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

Contracts

Types:

• ContractCreateResponse
• ContractRetrieveResponse
• ContractListResponse
• ContractAmendResponse
• ContractArchiveResponse
• ContractCreateHistoricalInvoicesResponse
• ContractListBalancesResponse
• ContractRetrieveRateScheduleResponse
• ContractScheduleProServicesInvoiceResponse
• ContractUpdateEndDateResponse

Methods:

• client.contracts.create({ ...params }) -> ContractCreateResponse
• client.contracts.retrieve({ ...params }) -> ContractRetrieveResponse
• client.contracts.list({ ...params }) -> ContractListResponse
• client.contracts.addManualBalanceEntry({ ...params }) -> void
• client.contracts.amend({ ...params }) -> ContractAmendResponse
• client.contracts.archive({ ...params }) -> ContractArchiveResponse
• client.contracts.createHistoricalInvoices({ ...params }) -> ContractCreateHistoricalInvoicesResponse
• client.contracts.listBalances({ ...params }) -> ContractListBalancesResponse
• client.contracts.retrieveRateSchedule({ ...params }) -> ContractRetrieveRateScheduleResponse
• client.contracts.scheduleProServicesInvoice({ ...params }) -> ContractScheduleProServicesInvoiceResponse
• client.contracts.setUsageFilter({ ...params }) -> void
• client.contracts.updateEndDate({ ...params }) -> ContractUpdateEndDateResponse

Products

Types:

• ProductListItemState
• QuantityConversion
• QuantityRounding
• ProductCreateResponse
• ProductRetrieveResponse
• ProductUpdateResponse
• ProductListResponse
• ProductArchiveResponse

Methods:

• client.contracts.products.create({ ...params }) -> ProductCreateResponse
• client.contracts.products.retrieve({ ...params }) -> ProductRetrieveResponse
• client.contracts.products.update({ ...params }) -> ProductUpdateResponse
• client.contracts.products.list({ ...params }) -> ProductListResponsesCursorPage
• client.contracts.products.archive({ ...params }) -> ProductArchiveResponse

RateCards

Types:

• RateCardCreateResponse
• RateCardRetrieveResponse
• RateCardUpdateResponse
• RateCardListResponse
• RateCardRetrieveRateScheduleResponse

Methods:

• client.contracts.rateCards.create({ ...params }) -> RateCardCreateResponse
• client.contracts.rateCards.retrieve({ ...params }) -> RateCardRetrieveResponse
• client.contracts.rateCards.update({ ...params }) -> RateCardUpdateResponse
• client.contracts.rateCards.list({ ...params }) -> RateCardListResponsesCursorPage
• client.contracts.rateCards.retrieveRateSchedule({ ...params }) -> RateCardRetrieveRateScheduleResponse

ProductOrders

Types:

• ProductOrderUpdateResponse
• ProductOrderSetResponse

Methods:

• client.contracts.rateCards.productOrders.update({ ...params }) -> ProductOrderUpdateResponse
• client.contracts.rateCards.productOrders.set({ ...params }) -> ProductOrderSetResponse

Rates

Types:

• RateListResponse
• RateAddResponse
• RateAddManyResponse

Methods:

• client.contracts.rateCards.rates.list({ ...params }) -> RateListResponsesCursorPage
• client.contracts.rateCards.rates.add({ ...params }) -> RateAddResponse
• client.contracts.rateCards.rates.addMany({ ...params }) -> RateAddManyResponse

NamedSchedules

Types:

• NamedScheduleRetrieveResponse

Methods:

• client.contracts.rateCards.namedSchedules.retrieve({ ...params }) -> NamedScheduleRetrieveResponse
• client.contracts.rateCards.namedSchedules.update({ ...params }) -> void

NamedSchedules

Types:

• NamedScheduleRetrieveResponse

Methods:

• client.contracts.namedSchedules.retrieve({ ...params }) -> NamedScheduleRetrieveResponse
• client.contracts.namedSchedules.update({ ...params }) -> void