Zuora Usage Api, Returns records of API usage that are genera

  • Zuora Usage Api, Returns records of API usage that are generated by your Zuora tenant within a specified time range. Usage is always billed in arrears - for example, you might bill customers in February for their January usage. Let’s take a look! Best Practices for Using the Zuora API The API User role is meant for systems making calls to Zuora and should never be used to log into the UI * Up to 300 order actions are allowed on a single subscription in a [Create an order asynchronously] (https://developer. The Zuora v1 API provides a broad set of operations and resources that: Enable Web Storefront integration from your website. . 0 or later available versions. Looking for enterprise billing software in 2026? Compare the top platforms for AI and SaaS, including Flexprice, Stripe Billing, Zuora, Orb, Metronome, Maxio, and Chargebee. Cancel a subscription This REST API reference describes how to cancel an active subscription. Best Practices for Using the Zuora API The subscription economy is growing. Use the last login date to manage user accounts The table Postman This REST API reference describes how to post or import usage data for one or more accounts in the CSV format. The Zuora v1 REST API provides access to all features of Zuora Billing, Payments, Platform, and Finance, enabling you to integrate, extend, and automate Zuora across your business systems. To load usage data, you send a create () call. Use this operation to optionally create a subscription, invoice for that subscription, and collect payment through the default payment method. Administrators can manage Zuora user accounts in your tenant. Zuora CPQ setup CPQ X enhances quoting efficiency and accuracy with Quote Studio, a modern Salesforce UI offering live metrics, extensibility, and API support Build, customize, extend, and integrate with Zuora Basics Fundamental Zuora information you should know Entitlements Explore entitlements for all Zuora product offerings Support and policies Learn the support and service policies at Zuora The Aggregate Query API (AQuA) is a REST API that executes multiple ZOQL queries in a sequential order within a single read-only database transaction, supporting features like incremental data export, segment-based file export, and monitoring through AQuA Job Finder. You can test the Zuora REST API from the Zuora Sandbox or Production tenants. ### How this REST API Call Works The content of the uploaded usage file must follow the format used by the UI import tool. API Versioning The API Versioning setting allows administrators to manage the version for API requests made to your tenant. You can send a maximum of 50 usage records in a single batch call. Process revenue schedules through custom revenue rule models. Create PAT for Databricks SP via API Learn how to create PAT for Databricks SP via API Ensure you have configured token permissions for Databricks SP. It streamlines the entire quote-to-cash process, including quoting, billing, collections, revenue recognition, and analytics. Zuora is a robust enterprise-grade subscription management platform that specializes in billing, revenue recognition, and monetization for recurring revenue businesses. Use the Usage object to import the quantity of units that customers use of a product, such as the number of page loads on a wiki. OAuth client setup Accessing the Zuora API requires a user account with the necessary privileges. For the specific steps to create an API role, an API user, and an OAuth Client for an API user, see Create an API user. Real-time usage analytics and rating engines let product and pricing teams visualize consumption patterns and adjust pricing logic dynamically. In this article, we list the best practices for using the API. If you want to go over this limit, contact your Zuora account manager for further consultation. The transaction is atomic; if any part fails for any reason, the entire Zuora Documentation for Developers Support Zuora Support Center You can also click the ? icon on any page in the UI to access the Zuora Support Center. This document provides a mapping of Braintree API fields to Zuora fields, detailing their usage in payment requests and responses. Enable manipulation of most objects in the Zuora object model. You can use [Zuora Object Query Language] (https://knowledgecenter. In order to make the most of your investment, you need to effectively manage the Zuora API. Once the call is made, the API executes the query against the specified object and returns a query response object to your application. Use the correct base URL for your assigned data center and environment. Describes how to retrieve usage details for an account. You can use the query parameters to filter, expand, and sort the returned results. To learn about how to make authenticated calls, see Get started tutorial in the Developer Center. Testing a request Use a third party client, such as curl, Postman, or Advanced REST Client, to test the Zuora REST API. com ) for API integrations, and never use that user ID to log in to the Zuora UI. There are no path or query parameters. In the business-to-consumer (B2C) market, consumer behavior is the primary driver. This document outlines the mapping of Global Payments API fields to Zuora fields, detailing their usage in requests and responses. 0 for all API interactions and using a dedicated user account with the API write access for all API or client libraries interactions. Zuora Documentation for Developers Support Zuora Support Center You can also click the ? icon on any page in the UI to access the Zuora Support Center. This Function supports both the Active Rating Post Usage API and the native Post Usage API to create and upload one or more usage records. Usage data is returned in reverse chronological order. It supports usage-based pricing, product catalogs, amendments, and seamless integrations with CRM, ERP, and payment systems. Creates a customer account with a payment method, a bill-to contact, and optional sold-to and ship-to contacts. com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. Zuora recommends using OAuth 2. The name for this configuration. Support self-service subscriber sign-ups and account management. Nov 27, 2025 · You can bill usage on a recurring, monthly, quarterly, semi-annual, and annual basis. This capability makes it ideal for API-centric products, infrastructure platforms, and services where customers pay based on actual usage. This connector exposes all of the operations provided by Zuora’s REST API. * Up to 300 order actions are allowed on a single subscription in a [Create an order asynchronously] (https://developer. The connection types to provide to this configuration. Zuora is a comprehensive cloud-based platform for enterprise subscription management and billing, enabling businesses to handle complex recurring revenue models including usage-based, tiered, and hybrid pricing. An inactive user cannot access your Zuora tenant. By following this tutorial, you will learn how to build integrations leveraging the Zuora REST API for various use cases. Anypoint Connector for Zuora (Zuora Connector) enables access to the Zuora platform. Otherwise, an error occurs. Administrators can create and edit user accounts, reset passwords, activate users, and deactivate users. The Aggregate Query API (AQuA) is a REST API that executes multiple ZOQL queries in a sequential order within a single read-only database transaction, supporting features like incremental data export, segment-based file export, and monitoring through AQuA Job Finder. Get started with Usage Learn how to view, retrieve, rate, and manage usage data in Zuora Billing, including handling recurring charges and customizing fields. The following API operations are supported. com/DC_Developers/K_Zuora_Object_Query_Language) (ZOQL) to construct those queries, passing them through the `queryString`. The choices for Zuora Revenue and Zephr are much simpler and do not require a guide. To make this work, usage must be tracked in the system and usage charges must be calculated and invoiced. If you use Postman, you can import the Settings API endpoints as a collection into your Postman app and try out different requests to learn how the API works. Zuora is a leading enterprise-grade platform for subscription management, billing, and revenue recognition, tailored for businesses in the subscription economy. Note: If you have the Invoice Settlement feature enabled, it is best practice to set the Zuora-Version parameter to 211. Zuora expects no more than 25 million usage records per month. It must be a comma Postman Because of this policy, Zuora recommends that you create a user ID with a recognizable name (for example, APIuser@mycompany. Zuora on the Postman API Network: This public collection features ready-to-use requests and documentation from Zuora. Build, customize, extend, and integrate with Zuora Basics Fundamental Zuora information you should know Entitlements Explore entitlements for all Zuora product offerings Support and policies Learn the support and service policies at Zuora Learn how to seamlessly integrate Zuora with NetSuite with this step-by-step guide. zuora. Discover the top 10 AI billing software solutions to streamline your invoicing. If usage data isn't in an invoice yet, then you can modify usage data with an update () or delete () call. You can use the Data Query API to submit queries, check the status of queries, and obtain the exported data. Learn how to set up and configure a Worldpay 1. Connectors reference the configuration with this name. Compare features, pros and cons, prices, and more in my complete guide. Learn how to export data from your Zuora tenant through Data Query API. Learn how to seamlessly integrate Zuora with NetSuite with this step-by-step guide. Start sending API requests with the CRUD: Create a usage record public request from Zuora Developers on the Postman API Network. This tutorial assumes you are using either the Zuora Billing v1 API or the v3 or higher SDK client libraries. Zuora is a powerful enterprise-grade subscription management and monetization platform that automates billing, revenue recognition, and customer lifecycle management for businesses with complex subscription models. This REST API reference describes how to post or import usage data for one or more accounts in the CSV format. Transform message - Outputs the results of the Get account operation in JSON format. If connecting to Production, bear in mind that you are working with your live production data, not sample data or test data. Here is our decision table to guide you to the right choice every time. It supports complex pricing models including usage-based, tiered, and hybrid billing, while automating invoicing, payments, and collections. The Zuora Post Usage Records is used to send billable usage records from Usage Engine to the Zuora Billing. For Databricks managed service principals, you can create a PAT using the on-behalf-of tokens API with an admin user PAT. It handles complex subscription models including usage-based, tiered, and hybrid pricing, with automated invoicing, payments, and compliance reporting. Workflow REST APIs are part of the Zuora REST APIs and use OAuth to authenticate to the API gateway. For how to use the Delayed Capture feature, see Payment Authorization in Zuora API Reference. Creates a new Usage object. The operations in this section allows you to create, update, get, or delete usage records. For details about these operations, see the Workflows section in the API Reference. The timeout for request to the remote service. The [Retrieve an account summary] (https://developer. Someone else created the rate plans with usage charges and customers subscribed to these rate plans some time ago. This list can be sorted by its column headers. Requirements Before you use the Zuora Revenue APIs, make sure the following requirements are met: Zuora Revenue uses role based access control to restrict system access to authorized users. Zuora's API versioning gives system administrators and developers centralized control over how API requests are processed in their tenants. com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously] (https://developer. Request and response field descriptions and sample code are provided. Zuora Basics - Postman Collection Tutorial This tutorial assumes you are using either the v1 API or the v3 or higher Zuora client libraries. Start sending API requests with the Upload a usage file public request from Zuora Developers on the Postman API Network. Lists Usage Record objects. You can filter the records by one or multiple of the following fields: - API path name - HTTP method - Response code - Request ID - Track ID Choosing the correct one for your use case can be tricky. Because of this policy, Zuora recommends that you create a user ID with a recognizable name (for example, APIuser@mycompany. As such, in contrast to the use case-oriented REST API, you will need to understand the Zuora object model to become proficient with the SOAP API. The SOAP API provides this fine-grained level of control by exposing the entire Zuora object model and allowing you to make create(), read(), update(), and delete() calls on those objects. View usage data When you click Usage from Billing Operations, Zuora Billing displays a list of all usage imported into Zuora Billing over time. The data is uploaded using the HTTP multipart/form-data POST method and applied to the user's tenant. com/v1-api-reference/api/operation/GET_AccountSummary/) operation returns the more detailed information of an account, such as bill-to and sold-to contacts, subscriptions, invoices, payments, and usages associated with this account. Optimize your billing processes and financial reporting effortlessly. In this walkthrough, we're going to follow two Zuora API users, Boris and Natasha, as they upload usage records in preparation for a bill run. Zuora is a leading enterprise-grade cloud platform specializing in subscription management and recurring billing, enabling businesses to handle complex monetization models like usage-based, hybrid, and tiered pricing. Zuora API Connector - Connects with Zuora and executes a query to retrieve the account details for the specified account ID. The samples in this guide use a Developer or Central Sandbox in one of our North American Data Centers. Explore now to find the best tools for your business needs. 4 gateway instance, including selecting the gateway type, creating the gateway, and completing the necessary configuration fields. Use this call to make the following kinds of changes to a subscription: - Add a note - Change the renewal term or auto-renewal flag - Change the term length or change between evergreen and termed - Add a new product rate plan - Remove an existing subscription rate plan - Change the quantity or price of an existing subscription rate plan - Change rate plans - to replace the existing rate plans The Setting API provides a central API for managing settings in your Zuora tenant. The following table lists the mapping of reference fields that are used in the delayed capture process. To use the Zuora Revenue APIs, make sure that your user role has the Webservices Inbound and Webservices Outbound previleges in Zuora Revenue security settings. Discover the top payment gateway APIs and find the best option for your team. yk7av, hl9t, rdqpa, ar918, 0f88i9, 6dlte, jfjac, 1nq1ix, nklrcv, 6cuvb,