Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Usage API

Consumption of a billable service or resource (such as database storage space or bundles of emails sent) provides the basis for some charge models - simple usage, tiered pricing, or volume pricing. To make this work, usage must be tracked in the system and usage charges must be calculated and invoiced. Usage is always billed in arrears - for example, you might bill customers in February for their January usage. Usage can be billed on a recurring monthly, quarterly, semi-annual, or annual basis.For more information about working with usage data, see Usage.

Zuora Usage API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Usage. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 5 paths, and defines 13 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

7 operations 5 paths 13 schemas 1 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Usage 7

Consumption of a billable service or resource (such as database storage space or bundles of emails sent) provides the basis for some charge models - simple usage, tiered pricing,…

POST
/v1/usage
Upload a usage file
POST_Usage 8 params → 200
GET
/v1/usage/accounts/{account-key}
Retrieve a usage record
GET_Usage 9 params → 200
GET
/v1/invoices/invoice-item/{invoice-item-id}/usage-rate-detail
Retrieve usage rate detail for an invoice item
GET_Usage_Rate_Detail_By_Invoice_Item 7 params → 200
POST
/v1/object/usage
CRUD: Create a usage record
Object_POSTUsage 10 params → 200400401
GET
/v1/object/usage/{id}
CRUD: Retrieve a usage record
Object_GETUsage 8 params → 200401404
PUT
/v1/object/usage/{id}
CRUD: Update a usage record
Object_PUTUsage 9 params → 200401
DELETE
/v1/object/usage/{id}
CRUD: Delete a usage record
Object_DELETEUsage 7 params → 200401

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are GETUsageWrapper (3 properties), ProxyNoDataResponse (3 properties), POSTUsageResponseType (3 properties), ProxyBadRequestResponse (2 properties). Each schema is shown below with its type and property counts.

ProxyDeleteResponse
object
2 properties
UsageObjectCustomFields
object
Container for custom fields of a Usage object.
ProxyGetUsage
ProxyUnauthorizedResponse
object
1 property
GETUsageRateDetailWrapper
object
2 properties
GETUsageWrapper
object
3 properties
ProxyNoDataResponse
object
3 properties
GETUsageType
ProxyModifyUsage
ProxyCreateUsage
ProxyCreateOrModifyResponse
object
2 properties
POSTUsageResponseType
object
3 properties
ProxyBadRequestResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-usage-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API