# Introduction Welcome to the reference for the Zuora Billing REST API! To learn about the common use cases of Zuora Billing REST APIs, check out the [API Guides](https://www.zuora.com/developer/api-guides/). In addition to Zuora API Reference; Billing, we also provide API references for other Zu
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://rest.zuora.com
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
# Introduction Welcome to the reference for the Zuora Billing REST API! To learn about the common use cases of Zuora Billing REST APIs, check out the [API Guides](https://www.zuora.com/developer/api-guides/). In addition to Zuora API Reference; Billing, we also provide API references for other Zuora products: * [API Reference: Collect](https://www.zuora.com/developer/collect-api/) * [API R
| method | path | what the vendor says it does |
|---|---|---|
GET | /charge-metrics/data/charge-metrics | List charge metrics by time range Retrieves key charge metrics about rate plan charges that have changes in a |
GET | /charge-metrics/data/charge-metrics-discount-allocation-detail | List discount allocation details by time range Retrieves discount allocation details about rate plan charges t |
GET | /events/event-triggers | List event triggers Event Triggers |
POST | /events/event-triggers | Create an event trigger When you create an event trigger, you must specify the base object and define the trig |
GET | /events/event-triggers/{id} | Retrieve an event trigger Event Triggers |
PUT | /events/event-triggers/{id} | Update an event trigger Event Triggers |
DELETE | /events/event-triggers/{id} | Delete an event trigger Event Triggers |
GET | /notifications/email-templates | List email templates Queries email templates. **Note**: This operation is only applicable to email templates |
POST | /notifications/email-templates | Create an email template Creates an email template. **Note**: This operation is only applicable to email temp |
GET | /notifications/email-templates/{id} | Retrieve an email template Queries the email template of the specified ID. **Note**: This operation is only a |
PUT | /notifications/email-templates/{id} | Update an email template Updates an email template. **Note**: This operation is only applicable to email temp |
DELETE | /notifications/email-templates/{id} | Delete an email template Deletes an email template. **Note**: This operation is only applicable to notificati |
DELETE | /notifications/history | Delete notification histories for an account Delete all notification histories for the given account. All emai |
GET | /notifications/history/tasks/{id} | Retrieve a notification history deletion task Get the notification history deletion task by ID. **Note**: Thi |
GET | /notifications/notification-definitions | List notification definitions Queries notification definitions with the specified filters. **Note**: This ope |
POST | /notifications/notification-definitions | Create a notification definition Creates a notification definition. If a filter rule is specified, it will be |
GET | /notifications/notification-definitions/{id} | Retrieve a notification definition Queries the notification definition of the given ID. **Note**: This operat |
PUT | /notifications/notification-definitions/{id} | Update a notification definition Updates a notification definition. **Note**: This operation is only applicab |
DELETE | /notifications/notification-definitions/{id} | Delete a notification definition Deletes a notification definition. **Note**: This operation is only applicab |
POST | /oauth/token | Create an OAuth token Creates a bearer token that enables an OAuth client to authenticate with the Zuora REST |
POST | /objects/batch/default/{object} | Update or delete custom object records Makes a batch update or delete of custom object records. ## Limitations |
GET | /objects/definitions/default | List custom object definitions Get all custom objects definitions for a given tenant. If you want to copy all |
POST | /objects/definitions/default | Create custom object definitions You can post custom object definitions with the request body schema described |
GET | /objects/definitions/default/{object} | Retrieve a custom object definition Retrieves the custom object definition by type for the given tenant. Custo |
DELETE | /objects/definitions/default/{object} | Delete a custom object definition Deletes the custom object definition for the provided type. **Note:** A cus |
GET | /objects/jobs | List all custom object bulk jobs Lists all custom object bulk jobs submitted by your tenant. Custom Object Job |
POST | /objects/jobs | Submit a custom object bulk job Submits a bulk job request for a bulk operation on the specified custom object |
GET | /objects/jobs/{id} | Retrieve a custom object bulk job Retrieves the custom object bulk job details by job ID. Only the users that |
GET | /objects/jobs/{id}/errors | List all errors for a custom object bulk job Lists all errors for a custom object bulk job. Custom Object Jobs |
POST | /objects/jobs/{id}/files | Upload a file for a custom object bulk job Uploads a file to a create custom object bulk job. Only one file is |
POST | /objects/migrations | Update a custom object definition Updates a custom object definition by posting migration resource to initiate |
GET | /objects/records/default/{object} | List records for a custom object Lists all object records of the given type. You can also use the `q` query pa |
POST | /objects/records/default/{object} | Create custom object records Creates custom object records with the given type. Upon creating records of a c |
GET | /objects/records/default/{object}/{id} | Retrieve a custom object record Retrieves a record of a given type by ID. Custom Object Records |
PUT | /objects/records/default/{object}/{id} | Update a custom object record Updates a record of the given type and ID. ## Limitations * The storage of em |
PATCH | /objects/records/default/{object}/{id} | Partially update a custom object record Updates one or many fields of a custom object record. Patch update use |
DELETE | /objects/records/default/{object}/{id} | Delete a custom object record Deletes a custom object record of the given type and ID. Note that 200 response |
GET | /query/jobs | List data query jobs Returns a list of [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Qu |
POST | /query/jobs | Submit a data query Submits a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) to b |
GET | /query/jobs/{job-id} | Retrieve a data query job Retrieves a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Que |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://www.zuora.com/wp-content/themes/zuora/yaml/swagger.yaml?v-7.0
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.