JUMP TOIntroductionGetting StartedLanguage Specific SDKsAuthorizationHow to get your API keyMetering CloudMeter DefinitionCreate a meterpostUpdate a meterputGet a list of metersgetGet a meter by idgetDelete a meterdeleteIngest MetersIngest meter recordspostFiltering Out Reported MetersCreate or update a filtering rulepostList existing filtering rules for a metergetQuerying Reported UsageQuery the usage datapostQuery the usage data in batchpostQuery the usage data (sparse)postQuery the usage data in batch (sparse)postFetch the current customer usage-rategetQuerying Raw EventsQuery raw ingested recordsgetPeriodic Usage ReportsCreate a usage report jobpostList all usage report jobsgetUpdate a usage report jobputGet a usage report jobgetDelete a usage report jobdeleteValidate job and querypostBilling CloudAccountGet detailed information about your billing cloudgetGet settings about your billing cloudgetUpdate settings about your billing cloudpostProduct ItemsCreate or update a product itempostGet all product itemsgetCreate or update a product item pricepostGet product item price by IDgetList all product item pricesgetCreate or update a product plan.postGet product plan by IDgetList all product plansgetAdd a product item price to an existing plan.postCreate or update an existing currency exchange rate table.postGet an existing currency exchange rate table by id.getDelete an existing, unlocked, currency exchange rate table by id.deleteGet the entire history of currency exchange rate tables.getProduct Item Price TemplatesCreate a product item price using a product item price templatepostCreate or update a flat-rate-based pricepostCreate or update a flat-rate with overages based pricepostCreate or update a seat-based pricepostCreate or update a usage-based price with dimensionspostCreate or update a max reducer, usage-based price with dimensions.postCreate or update a usage-based price with no dimensions.postCreate or update a max-reducer, usage-based price with no dimensions.postCreate or update a volume-based pricepostQueriesCustomer planspostPricing PlansAssign a product plan to a customerpostFetch the latest product plan of a customergetDeletes the last customer plan the user registered to (must be a future plan).deleteList entire history of product plans of a customergetInvoicesGet an invoicegetList all invoicesgetCreditsOrder a one time or a recurrence prepaid card.postGet a prepaid order.getDeletes a prepaid order.deleteGet the entire list of open credits (orders that aren't expire yet).getUpdate an external prepaid card status.postCredits WalletGet the customer credits wallet.getCustomer PromotionsApply a new promotion for the customer.postRemoves an active promotion from the customer's applied promotions.deleteGet the entire list of active promotions applied of the customer.getDefining PromotionsGet a promotiongetCreate or update a promotionpostDelete a promotiondeleteList all promotionsgetCreate or update an Absolute Product Automatic PromotionpostCreate or update an Absolute Product Item Automatic PromotionpostCreate or update a Generic Item PromotionpostCreate or update a Generic Product PromotionpostCreate or update a Relative Product Automatic PromotionpostCreate or update a Relative Product Item Automatic PromotionpostCreate or update a Relative Product Item Sales Event PromotionpostCreate or update a Tiered Absolute Product Automatic PromotionpostCreate or update a Tiered Absolute Product Item Automatic PromotionpostCreate or update a Tiered Relative Product Automatic PromotionpostCreate or update an Absolute Product Sales Event PromotionpostCreate or update a Product Absolute Partner Discount PromotionpostCreate or update a Product Item Absolute Partner Discount PromotionpostCreate or update a Product Item Relative Partner Discount Promotion.postCreate or update an Absolute Product Item Sales Event PromotionpostCreate or update a relative Product Partner Automatic PromotionpostCreate or update a Relative Product Sales Event PromotionpostCreate or update a Sample Currency PromotionpostCreate or update a Tiered Relative Product Item Automatic PromotionpostCreate or update a Time Limited Absolute Item DiscountpostCreate or update a Time Limited Absolute Product DiscountpostCreate or update a Time Limited Relative Item DiscountpostCreate or update a Time Limited Relative Product DiscountpostCreate or update a Time Limited Relative Product Full DiscountpostCreate or update a Time Limited Tiered Absolute Item DiscountpostCreate or update a Time Limited Tiered Absolute Product DiscountpostCreate or update a Time Limited Tiered Relative Item DiscountpostCreate or update a Time Limited Tiered Relative Product DiscountpostCreate or update an Unconditioned Absolute Plan PromotionpostCustomer CommitmentList all commitmentsgetCreate or update a commitmentpostCreate or update an Arrears Commitment with True-uppostCreate or update a Custom CommitmentpostCreate or update an Installments CommitmentpostCreate or update a Subscription CommitmentpostCreate or update an Upfront Commitment with True UppostBilling Analysisby rule revenue calculatorpostraw revenue calculatorpostusage costpostusage cost - batchpostTax CalculationCalculate taxes for a customerpostValidate addresspostList product codesgetCustomersCustomersCreate a customerpostUpdate a customerputList all customersgetGet a customer by idgetDelete a customerdeletePage through and search customersgetUpdate lifecycle stage of customerputReinstate a customerputGet customer lifecycle stage history by idgetAlerts and WebhooksNotifications (Alerts)Create a notificationpostGet a list of notificationsgetUpdate a notificationputGet a notification by idgetDelete a notificationdeleteWebhooksSet up a webhook subscriptionpostList current webhook subscriptionsgetUpdate a webhook subscriptionputGet a webhook subscriptiongetRemove a webhook subscriptiondeleteList available topicsgetSend a test webhookpostRetry a webhook requestpostEvent LogsList account event logsgetGet account event by idgetList available filter combinationsgetAccount SettingsCompany LogoDownloadgetUploadpostRemovedeleteCustomer PortalSessionCreate a sessionpostUsageQuery the usage data scoped to the customerpostQuery the usage data (batch)postCostQuery the cost data scoped to the customerpostBillingGet all invoices for the customergetGet a specific invoice for the customergetPrepaidGet the customer prepaid walletgetOrder a one time or a recurrence prepaid cardpostNotificationsCreate a notification alert for the customerpostUpdate a notificationputGet a list of notifications for the customergetGet a notification by idgetDelete a notification by iddeleteMetersGet a list of metersgetUsage EventsReturn a list of usage events scoped to the customergetPricing PlanGet pricing plan detailsgetAssign a product plan to the customerpostList product itemsgetSetup IntentCreate a setup intentpostPayment MethodGet default payment methodgetSet default payment methodpostSettingsGet account settingsgetCompany LogoDownloadgetCustomer DetailsGet customer detailsgetCredits LedgerGet credits ledgergetRewards HistoryGet rewards historygetHow to get your API keyThe easiest way to get your api key is through our console. You can go to the settings tab and copy the api key
