Connectors

Finance, Billing & Payments

Zuora

Subscription billing: accounts, subscriptions, invoices, payments, and revenue data
Zuora API referenceAPI version 2023-12-15API checked August 16, 2026
Signs in with
API token
Runs on
Cloud or On-Prem Worker
Operations
446
Ready-made triggers
0

Connect Zuora

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for Zuora and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. Click Test, then Create Connection.
FieldWhat to enter
Access tokenRequiredSecret

Use it in a flow

  1. Open a flow, open the node library and search for Zuora.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. Use Test this step to see what it returns, then save.

To start a flow from Zuora without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if Zuora can send webhooks, a Webhook trigger receives them at its own URL.

Operations

446 operations in 79 groups. Each one is a step you can add to a flow.

Account7
Create an accountPOST_AccountPOSTCreates a customer account with a payment method, a bill-to contact, and an optional sold-to contact.
Delete an accountDELETE_AccountDELETEDeletes a specific account asynchronously.
List payment methods of an accountGET_AcountPaymentMethodsGETRetrieves the payment methods of the specified customer account.
Retrieve an accountGET_AccountGETRetrieves basic information about a customer account.
Retrieve an account summaryGET_AccountSummaryGETRetrieves detailed information about the specified customer account.
Retrieve the default payment method of an accountGET_AcountDefaultPaymentMethodGETRetrieves the default payment method of the specified customer account.
Update an accountPUT_AccountPUTUpdates a customer account by specifying the account-key.
Accounting Code7
Activate an accounting codePUT_ActivateAccountingCodePUTThis reference describes how to activate an accounting code through the REST API.
Create an accounting codePOST_AccountingCodePOSTThis reference describes how to create a new accounting code through the REST API.
Deactivate an accounting codePUT_DeactivateAccountingCodePUTThis reference describes how to deactivate an accounting code through the REST API.
Delete an accounting codeDELETE_AccountingCodeDELETEThis reference describes how to delete an accounting code through the REST API.
List all accounting codesGET_AllAccountingCodesGETThis reference describes how to query all accounting codes in your chart of accounts through the REST API.
Retrieve an accounting codeGET_AccountingCodeGETThis reference describes how to query an accounting code through the REST API.
Update an accounting codePUT_AccountingCodePUTThis reference describes how to update an existing accounting code through the REST API.
Accounting Period9
Close an accounting periodPUT_CloseAccountingPeriodPUTClose an accounting period by accounting period ID.
Create an accounting periodPOST_AccountingPeriodPOSTCreates an accounting period.
Delete an accounting periodDELETE_AccountingPeriodDELETEDeletes an accounting period.
List all accounting periodsGET_AllAccountingPeriodsGETRetrieves all accounting periods on your tenant.
Reopen an accounting periodPUT_ReopenAccountingPeriodPUTRe-opens an accounting period.
Retrieve an accounting periodGET_AccountingPeriodGETRetrieves an accounting period.
Run trial balancePUT_RunTrialBalancePUTRuns the trial balance for an accounting period.
Set an accounting period to pending closePUT_PendingCloseAccountingPeriodPUTSets an accounting period to pending close.
Update an accounting periodPUT_UpdateAccountingPeriodPUTUpdates an accounting period.
Action5
CreateAction_POSTcreatePOSTUse the create call to create one or more objects of a specific type.
DeleteAction_POSTdeletePOSTDeletes one or more objects of the same type.
QueryAction_POSTqueryPOSTThe query call sends a query expression by specifying the object to query, the fields to retrieve from that object, and any filters to determine whether a given object should be queried.
Query MoreAction_POSTqueryMorePOSTUse queryMore to request additional results from a previous query call.
UpdateAction_POSTupdatePOSTUpdates the information in one or more objects of the same type.
Aggregate Query4
Cancel a running aggregate query jobDELETE_BatchQueryJobDELETECancels the current AQuA job, only if the job is not complete.
Retrieve an aggregate query jobGET_BatchQueryJobGETRetrieves an aggregate query using the Job ID.
Retrieve the last completed aggregate query jobGET_LastBatchQueryJobGETReturns the details of the last completed job.
Submit an aggregate query jobPOST_BatchQueryJobPOSTSubmits an AQuA job that contains an aggregated list of ZOQL and Export ZOQL queries.
API Health1
List API volume summary recordsGET_SystemHealthApiVolumeSummaryGETReturns volume summary of API usage that generated by your Zuora tenant within a specified time range.
Attachment5
Create an attachmentPOST_AttachmentsPOSTUse the Add Attachment REST request with a multipart/form-data to attach a document file to an Account, a Subscription, an Invoice, a Credit Memo, or a Debit Memo.
Delete an attachmentDELETE_AttachmentsDELETEUse the Delete Attachment REST request to delete an attachment from a Zuora object.
List attachments by object type and keyGET_AttachmentsListGETUse the View Attachment REST request to get a list of attachments on an account, an invoice, a subscription, a credit memo, or a debit memo.
Retrieve an attachmentGET_AttachmentsGETUse the View Attachment REST request to retrieve information about an attachment document.
Update an attachmentPUT_AttachmentsPUTUse the Edit Attachment REST request to make changes to the descriptive fields of an attachment, such as the description and the file name.
Bill Run6
Cancel a bill runPUT_CancelBillRunPUTCancels a bill run in Draft status.
Create a bill runPOST_CreateBillRunPOSTCreates an ad-hoc bill run or a scheduled bill run.
Delete a bill runDELETE_DeleteBillRunDELETEDeletes a bill run.
Email billing documents generated from a bill runPOST_EmailBillingDocumentsfromBillRunPOSTManually emails all the billing documents that are generated from a specified bill run to your customers.
Post a bill runPUT_PostBillRunPUTPosts a bill run asynchronously.
Retrieve a bill runGET_BillRunGETRetrieves the information about a specific bill run.
Bill Run Health1
List billing document volume summary recordsGET_SystemHealthBillingDocVolumeSummaryGETReturns a summary of billing documents generated within a specified time range, including invoices and credit memos, and the total number of accounts that failed to process.
Billing Document4
Create a job to hard delete billing document filesPOST_BillingDocumentFilesDeletionJobPOSTCreates an asynchronous job to permanently delete all billing document PDF files for specific accounts.
Generate billing documents by account IDPOST_GenerateBillingDocumentsPOSTGenerates draft or posted billing documents for a specified account.
List billing documents for an accountGET_BillingDocumentsGETRetrieves the information about all billing documents associated with a specified account.
Retrieve a job of hard deleting billing document filesGET_BillingDocumentFilesDeletionJobGETRetrieves information about an asynchronous job of permanently deleting all billing document PDF files for specific accounts.
Billing Preview Run2
Create a billing preview runPOST_BillingPreviewRunPOSTCreates a billing preview run for multiple customer accounts.
Retrieve a billing preview runGET_BillingPreviewRunGETRetrieves a preview of future invoice items for multiple customer accounts through a billing preview run.
Catalog2
List all productsGET_CatalogGETRetrieves the entire product catalog, including all products, features, and their corresponding product rate plans, charges.
Retrieve a productGET_ProductGETRetrieves detailed information about a specific product, including information about its product rate plans and charges.
Catalog Group5
Create a catalog groupPOST_CreateCatalogGroupPOSTNote : This operation is in the Early Adopter phase.
Delete a catalog groupDELETE_CatalogGroupDELETENote : This operation is in the Early Adopter phase.
List all catalog groupsGET_ListAllCatalogGroupsGETNote : This operation is in the Early Adopter phase.
Retrieve a catalog groupGET_RetrieveCatalogGroupGETNote : This operation is in the Early Adopter phase.
Update a catalog groupPUT_UpdateCatalogGroupPUTNote : This operation is in the Early Adopter phase.
Configuration Template8
Compare settings between a source tenant and a target tenantPOST_CompareTemplatePOSTTo Compare the configurations from the template downloaded and used in deployment manager for migration which is available in source and target tenant.
Create a deployment templatePOST_DeploymentTemplatePOSTCreates templates based on user preference.
Delete a templateDELETE_DeploymentTemplateDELETEDeletes a specific template by passing the ID.
Download a templateGET_DownloadDeploymentTemplateGETDownload a template for migration in the Deployment manager from the source tenant to the target tenant.
List all details of a templateGET_DeploymentTemplateDetailGETReturns the detailed information of a specific template by passing its template ID.
List all details of source componentsGET_SourceComponentDetailsGETWhen the advanced option is clicked, get the details/metadata of the components, such as settings, notifications, workflow, etc.
List all templatesGET_TemplatesGETRetrieves all the templates and their details which are created already.
Migrate settings from source tenant to target tenantPOST_MigrateTenantSettingsPOSTTo migrate the selected configuration of a tenant in Deployment Manager migration while using template from the compare screen.
Contact5
Create a contactPOST_CreateContactPOSTCreates a contact for a specified account.
Delete a contactDELETE_ContactDELETEDeletes a contact.
Retrieve a contactGET_ContactGETRetrieves detailed information about a specific contact.
Scrub a contactPUT_ScrubContactPUTScrubs the sensitive data of a specific contact.
Update a contactPUT_ContactPUTUpdates a contact for a specified account.
Contact Snapshot1
Retrieve a contact snapshotGET_ContactSnapshotGETRetrieves detailed information about the snapshot of a contact, either a bill-to contact or sold-to contact.
Credit Memo26
Apply a credit memoPUT_ApplyCreditMemoPUTNote: This operation is only available if you have Invoice Settlement enabled.
Cancel a credit memoPUT_CancelCreditMemoPUTNote: This operation is only available if you have Invoice Settlement enabled.
Create a credit memo from a chargePOST_CreditMemoFromPrpcPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Create a credit memo from an invoicePOST_CreditMemoFromInvoicePOSTNote: This operation is only available if you have Invoice Settlement enabled.
Create credit memosPOST_CreateCreditMemosPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Create taxation items for a credit memoPOST_CM_TaxationItemsPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Delete a credit memoDELETE_CreditMemoDELETENote: This operation is only available if you have Invoice Settlement enabled.
Email a credit memoPOST_EmailCreditMemoPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Generate a credit memo PDF filePOST_CreditMemoPDFPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Generate an e-invoice file for a credit memoPUT_GenerateEInvoiceFileForCreditMemoPUTGenerates an e-invoice file for a credit memo.
List all parts of a credit memoGET_CreditMemoPartsGETNote: This operation is only available if you have Invoice Settlement enabled.
List all taxation items of a credit memo itemGET_TaxationItemsOfCreditMemoItemGETNote: This operation is only available if you have Invoice Settlement enabled.
List credit memo itemsGET_CreditMemoItemsGETNote: This operation is only available if you have Invoice Settlement enabled.
List credit memosGET_CreditMemosGETNote: This operation is only available if you have Invoice Settlement enabled.
Post a credit memoPUT_PostCreditMemoPUTNote: This operation is only available if you have Invoice Settlement enabled.
Refund a credit memoPOST_RefundCreditMemoPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Retrieve a credit memoGET_CreditMemoGETNote: This operation is only available if you have Invoice Settlement enabled.
Retrieve a credit memo itemGET_CreditMemoItemGETNote: This operation is only available if you have Invoice Settlement enabled.
Retrieve a credit memo partGET_CreditMemoPartGETNote: This operation is only available if you have Invoice Settlement enabled.
Reverse a credit memoPUT_ReverseCreditMemoPUTNote: This operation is only available if you have Invoice Settlement enabled.
Unapply a credit memoPUT_UnapplyCreditMemoPUTNote: This operation is only available if you have Invoice Settlement enabled.
Unpost a credit memoPUT_UnpostCreditMemoPUTNote: This operation is only available if you have Invoice Settlement enabled.
Update a credit memoPUT_UpdateCreditMemoPUTNote: This operation is only available if you have Invoice Settlement enabled.
Update credit memosPUT_UpdateCreditMemosPUTNote: This operation is only available if you have Invoice Settlement enabled.
Upload a file for a credit memoPOST_UploadFileForCreditMemoPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Write off a credit memoPUT_WriteOffCreditMemoPUTNote: This operation is only available if you have Invoice Settlement enabled.
Custom Event Trigger5
Create an event triggerPOST_EventTriggerPOSTWhen you create an event trigger, you must specify the base object and define the trigger condition.
Delete an event triggerDELETE_EventTriggerDELETE
List event triggersGET_EventTriggersGET
Retrieve an event triggerGET_EventTriggerGET
Update an event triggerPUT_EventTriggerPUT
Custom Exchange Rate1
List custom exchange rates by currencyGET_CustomExchangeRatesGETThis feature is in Limited Availability .
Custom Object Definition5
Create custom object definitionsPOST_CustomObjectDefinitionsPOSTYou can post custom object definitions with the request body schema described below.
Delete a custom object definitionDelete_CustomObjectDefinitionByTypeDELETEDeletes the custom object definition for the provided type.
List custom object definitionsGET_AllCustomObjectDefinitionsInNamespaceGETGet all custom objects definitions for a given tenant.
Retrieve a custom object definitionGET_CustomObjectDefinitionByTypeGETRetrieves the custom object definition by type for the given tenant.
Update a custom object definitionPOST_UpdateCustomObjectDefinitionPOSTUpdates a custom object definition by posting migration resource to initiate the migration of definitions.
Custom Object Job6
Cancel a custom object bulk jobPATCH_CustomObjectBulkJobPATCHCancel a custom object bulk job.
List all custom object bulk jobsGET_AllCustomObjectBulkJobsGETLists all custom object bulk jobs submitted by your tenant.
List all errors for a custom object bulk jobGET_CustomObjectBulkJobErrorsGETLists all errors for a custom object bulk job.
Retrieve a custom object bulk jobGET_CustomObjectBulkJobGETRetrieves the custom object bulk job details by job ID.
Submit a custom object bulk jobPOST_CustomObjectBulkJobPOSTSubmits a bulk job request for a bulk operation on the specified custom object records.
Upload a file for a custom object bulk jobPOST_UploadFileForCustomObjectBulkJobPOSTUploads a .csv file for a custom object bulk job to create or update custom object records.
Custom Object Record7
Create custom object recordsPOST_CustomObjectRecordsPOSTCreates custom object records with the given type.
Delete a custom object recordDelete_CustomObjectRecordByIDDELETEDeletes a custom object record of the given type and ID.
List records for a custom objectGET_AllRecordsForCustomObjectTypeGETLists all object records of the given type.
Partially update a custom object recordPatch_PartialUpdateCustomObjectRecordPATCHUpdates one or many fields of a custom object record.
Retrieve a custom object recordGET_CustomObjectRecordByIDGETRetrieves a record of a given type by ID.
Update a custom object recordPUT_CustomObjectRecordPUTUpdates a record of the given type and ID.
Update or delete custom object recordsPOST_CustomObjectRecordsBatchUpdateOrDeletePOSTMakes a batch update or delete of custom object records.
Custom Payment Method Type5
Create a draft custom payment method typePOST_CreateDraftOpenPaymentMethodTypePOSTCreates a draft version of a custom payment method type.
Publish a custom payment method typePUT_PublishOpenPaymentMethodTypePUTPublish the latest draft revision of a specific custom payment method type.
Retrieve a published custom payment method typeGET_OpenPaymentMethodTypePublishGETRetrieves a published custom payment method type.
Retrieve a specific draft revision of a custom payment methodGET_OpenPaymentMethodTypeRevisionGETRetrieves a specific draft revision of a custom payment method type.
Update a custom payment method typePUT_UpdateOpenPaymentMethodTypePUTUpdate the latest draft version of your custom payment method type.
Custom Scheduled Event5
Create a scheduled eventPOST_ScheduledEventPOSTTo create a custom scheduled event, you must specify the base object, the base field and the scheduled time.
Delete a scheduled event by IDDELETE_ScheduledEventByIDDELETE
List all scheduled eventsGET_ScheduledEventsGET
Retrieve a scheduled event by IDGET_ScheduledEventByIDGET
Update a scheduled event by IDUPDATE_ScheduledEventByIDPUT
Data Labeling2
Retrieve a data labeling jobGET_DataLabelingJobGETRetrieves a data labeling job.
Submit a data labeling jobPOST_DataLabelingJobPOSTSubmits a data labeling job.
Data Query4
Cancel a data query jobDELETE_DataQueryJobDELETECancels a data query job, which prevents Zuora from performing the query.
List data query jobsGET_DataQueryJobsGETReturns a list of data query jobs that have been created in your Zuora tenant.
Retrieve a data query jobGET_DataQueryJobGETRetrieves a data query job.
Submit a data queryPOST_DataQueryJobPOSTSubmits a data query to be performed by Zuora and creates a query job.
Debit Memo22
Cancel a debit memoPUT_CancelDebitMemoPUTNote: This operation is only available if you have Invoice Settlement enabled.
Collect a posted debit memoPOST_DebitMemoCollectPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Create a debit memo from a chargePOST_DebitMemoFromPrpcPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Create a debit memo from an invoicePOST_DebitMemoFromInvoicePOSTNote: This operation is only available if you have Invoice Settlement enabled.
Create debit memosPOST_CreateDebitMemosPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Create taxation items for a debit memoPOST_DM_TaxationItemsPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Delete a debit memoDELETE_DebitMemoDELETENote: This operation is only available if you have Invoice Settlement enabled.
Email a debit memoPOST_EmailDebitMemoPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Generate a debit memo PDF filePOST_DebitMemoPDFPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Generate an e-invoice file for a debit memoPUT_GenerateEInvoiceFileForDebitMemoPUTGenerates an e-invoice file for a debit memo.
List all application parts of a debit memoGET_DebitMemoApplicationPartsGETNote: This operation is only available if you have Invoice Settlement enabled.
List all taxation items of a debit memo itemGET_TaxationItemsOfDebitMemoItemGETNote: This operation is only available if you have Invoice Settlement enabled.
List debit memo itemsGET_DebitMemoItemsGETNote: This operation is only available if you have Invoice Settlement enabled.
List debit memosGET_DebitMemosGETNote: This operation is only available if you have Invoice Settlement enabled.
Post a debit memoPUT_PostDebitMemoPUTNote: This operation is only available if you have Invoice Settlement enabled.
Retrieve a debit memoGET_DebitMemoGETNote: This operation is only available if you have Invoice Settlement enabled.
Retrieve a debit memo itemGET_DebitMemoItemGETNote: This operation is only available if you have Invoice Settlement enabled.
Unpost a debit memoPUT_UnpostDebitMemoPUTNote: This operation is only available if you have Invoice Settlement enabled.
Update a debit memoPUT_DebitMemoPUTNote: This operation is only available if you have Invoice Settlement enabled.
Update debit memosPUT_UpdateDebitMemosPUTNote: This operation is only available if you have Invoice Settlement enabled.
Update due dates for debit memosPUT_UpdateDebitMemosDueDatesPUTNote: This operation is only available if you have Invoice Settlement enabled.
Upload a file for a debit memoPOST_UploadFileForDebitMemoPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Delivery Adjustment5
Cancel a delivery adjustmentPUT_CancelAdjustmentPUTDescribes how to cancel an unbilled delivery adjustment.
Create a delivery adjustmentCreate_AdjustmentPOSTDescribes how to create one or more delivery adjustments for a subscription.
List all delivery adjustments of a subscriptionGET_Subscription_AdjustmentsGETDescribes how to retrieve detailed information about delivery adjustments of a subscription.
Preview a delivery adjustmentPreview_AdjustmentPOSTDescribes how to preview delivery adjustments of a subscription.
Retrieve a delivery adjustmentGET_AdjustmentGETDescribes how to retrieve detailed information about a delivery adjustment.
Describe1
Describe an objectGET_DescribeGETProvides a reference listing of each object that is available in your Zuora tenant.
E Invoicing15
Create an e-invoice file templatePOST_CreateEInvoiceFileTemplatePOSTCreates an e-invoice file templates for your billing documents, including invoices, credit memos, and debit memos.
Create an e-invoicing business regionPOST_CreateEInvoicingBusinessRegionPOSTCreates an e-invoicing business region.
Create an e-invoicing service providerPOST_EInvoicingServiceProviderPOSTCreates an e-invoicing service provider.
Delete an e-invoice file templateDELETE_EInvoiceFileTemplateDELETEDeletes an e-invoice file template by key.
Delete an e-invoicing business regionDELETE_EInvoicingBusinessRegionDELETEDeletes an e-invoicing business region by key.
Delete an e-invoicing service providerDELETE_EInvoicingServiceProviderDELETEDeletes an e-invoicing service privider.
List e-invoice file templatesGET_EInvoiceFileTemplatesGETLists information about e-invoice file templates.
List e-invoicing business regionsGET_EInvoicingBusinessRegionsGETLists information about e-invoicing business regions.
List e-invoicing service providersGET_EInvoicingServiceProvidersGETLists information about e-invoicing service providers.
Retrieve an e-invoice file templateGET_EInvoiceFileTemplateGETRetrieves information about an e-invoice file template.
Retrieve an e-invoicing business regionGET_EInvoicingBusinessRegionGETRetrieves information about an e-invoicing business region.
Retrieve an e-invoicing service providerGET_EInvoicingServiceProviderGETRetrieves information about an e-invoicing service privider.
Update an e-invoice file templatePUT_EInvoiceFileTemplatePUTUpdates information about an e-invoice file template.
Update an e-invoicing business regionPUT_UpdateEInvoicingBusinessRegionPUTUpdates an e-invoicing business region by key.
Update an e-invoicing service providerPUT_UpdateEInvoicingServiceProviderPUTUpdates information about an e-invoicing service privider.
Electronic Payments Health1
List payment volume summary recordsGET_SystemHealthPaymentVolumeSummaryGETReturns a summary of electronic payments handled by your Zuora tenant within a specified time range.
File1
Retrieve a fileGET_FilesGETRetrieve files such as export results, invoices, and accounting period reports.
Fulfillment8
Create fulfillment itemsCreate_FulfillmentItemPOSTCreates one or multiple fulfillment items.
Create fulfillmentsCreate_FulfillmentPOSTCreates one or multiple Fulfillment objects.
Delete a fulfillmentDelete_FulfillmentDELETEDeletes a specified fulfillment.
Delete a fulfillment itemDelete_FulfillmentItemDELETEDeletes a specified fulfillment item.
Retrieve a fulfillmentGET_FulfillmentGETRetrieves the detailed information about a specified fulfillment.
Retrieve a fulfillment itemGET_FulfillmentItemGETRetrieves the detailed information about a specified fulfillment item.
Update a fulfillmentPUT_FulfillmentPUT
Update a fulfillment itemPUT_FulfillmentItemPUTUpdates a specified fulfillment item.
Hosted Page1
List hosted pagesGet_HostedPagesGETReturns the Payment Pages configuration metadata, specifically, page ID, page version, payment method type.
Import2
CRUD: Create an importObject_POSTImportPOSTCreates a data import.
CRUD: Retrieve an importObject_GETImportGET
Invoice17
Create a standalone invoicePOST_StandaloneInvoicePOSTCreates a standalone invoice for selling physical goods, services or other items on a non-recurring basis to your subscription customers.
Create standalone invoicesPOST_StandaloneInvoicesPOSTCreates multiple standalone invoices for selling physical goods, services or other items on a non-recurring basis to your subscription customers.
Create taxation items for an invoicePOST_INV_TaxationItemsPOSTCreates taxation items for an invoice.
Delete an invoiceDELETE_DeleteInvoiceDELETEDeletes a specific invoice.
Email an invoicePOST_EmailInvoicePOSTSends a posted invoice to the specified email addresses manually.
Generate an e-invoice file for an invoicePUT_GenerationEInvoiceGenerationForInvoicesPUTGenerates an e-invoice file for an invoice.
List all application parts of an invoiceGET_InvoiceApplicationPartsGETNote: This operation is only available if you have Invoice Settlement enabled.
List all files of an invoiceGET_InvoiceFilesGETRetrieves the information about all PDF files of a specified invoice.
List all items of an invoiceGET_InvoiceItemsGETRetrieves the information about all items of a specified invoice.
List all taxation items of an invoice itemGET_TaxationItemsOfInvoiceItemGETRetrieves information about the taxation items of a specific invoice item.
Post invoicesPOST_PostInvoicesPOSTPosts multiple invoices.
Retrieve an invoiceGet_GetInvoiceGETRetrieves a specific invoice.
Reverse an invoicePUT_ReverseInvoicePUTNote: This operation is only available if you have Invoice Settlement enabled.
Update an invoicePUT_UpdateInvoicePUTUpdates a specific invoice.
Update invoicesPUT_BatchUpdateInvoicesPUTUpdates multiple invoices in batches with one call.
Upload a file for an invoicePOST_UploadFileForInvoicePOSTUploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status.
Write off an invoicePUT_WriteOffInvoicePUTNote: This operation is only available if you have Invoice Settlement enabled.
Invoice Schedule7
Create an invoice schedulePOST_CreateInvoiceSchedulePOSTCreates an invoice schedule.
Delete an invoice scheduleDELETE_InvoiceScheduleDELETEDeletes an invoice schedule in Pending status.
Execute an invoice schedulePOST_ExecuteInvoiceSchedulePOSTExecutes an invoice schedule immediately.
Pause an invoice schedulePUT_PauseInvoiceSchedulePUTPauses an invoice schedule immediately.
Resume an invoice schedulePUT_ResumeInvoiceSchedulePUTResumes an invoice schedule in Paused status immediately.
Retrieve an invoice scheduleGET_InvoiceScheduleGETRetrieves detailed information about an invoice schedule.
Update an invoice schedulePUT_UpdateInvoiceSchedulePUTUpdates a pending invoice schedule.
Journal Run4
Cancel a journal runPUT_JournalRunPUTThis reference describes how to cancel a journal run using the REST API.
Create a journal runPOST_JournalRunPOSTThis REST API reference describes how to create a journal run.
Delete a journal runDELETE_JournalRunDELETEThis reference describes how to delete a journal run using the REST API.
Retrieve a journal runGET_JournalRunGETThis REST API reference describes how to get information about a journal run.
Mass Updater3
List all results of a mass actionGET_MassUpdaterGETDescribes how to get information about the result of a mass action through the REST API.
Perform a mass actionPOST_MassUpdaterPOSTDescribes how to perform a mass action through the REST API.
Stop a mass actionPUT_MassUpdaterPUTDescribes how to stop a mass action through the REST API.
Notification17
Create a notification definitionPOST_Create_Notification_DefinitionPOSTCreates a notification definition.
Create an email templatePOST_Create_Email_TemplatePOSTCreates an email template.
Create or update email templatesPOST_CreateOrUpdateEmailTemplatesPOSTCreates email templates for standard or custom events if you do not specify email template IDs, or updates existing email templates if you specify valid email template IDs.
Delete a notification definitionDELETE_Delete_Notification_DefinitionDELETEDeletes a notification definition.
Delete an email templateDELETE_Delete_Email_TemplateDELETEDeletes an email template.
Delete notification histories for an accountDELETE_Delete_Notification_History_For_AccountDELETEDelete all notification histories for the given account.
List callout notification historiesGET_CalloutHistoryGETDescribes how to get a notification history for callouts.
List email notification historiesGET_EmailHistoryGETDescribes how to get a notification history for notification emails.
List email templatesGET_Query_Email_TemplatesGETQueries email templates.
List notification definitionsGET_Query_Notification_DefinitionsGETQueries notification definitions with the specified filters.
Resend callout notificationsPOST_ResendCalloutNotificationsPOSTResends callout notifications if your customers did not receive previous callout notifications.
Resend email notificationsPOST_ResendEmailNotificationsPOSTResends email notifications if your customers did not receive previous email notifications.
Retrieve a notification definitionGET_Get_Notification_DefinitionGETQueries the notification definition of the given ID.
Retrieve a notification history deletion taskGET_Get_Notification_History_Deletion_TaskGETGet the notification history deletion task by ID.
Retrieve an email templateGET_Get_Email_TemplateGETQueries the email template based on the specified ID.
Update a notification definitionPUT_Update_Notification_DefinitionPUTUpdates a notification definition.
Update an email templatePUT_Update_Email_TemplatePUTUpdates an email template.
OAuth1
Create an OAuth tokencreateTokenPOSTCreates a bearer token that enables an OAuth client to authenticate with the Zuora REST API.
Offer4
Create an offerPOST_CreateOfferPOSTCreates an offer.
Delete an offerDELETE_OfferDELETEDeletes an offer.
List offersGET_ListOffersGETRetrieves basic information about all offers.
Retrieve an offerGET_RetrieveOfferGETRetrieves basic information about an offer.
Operation3
Generate a billing previewPOST_BillingPreviewPOSTGenerates a preview of future invoice items for one customer account.
Invoice and collectPOST_TransactionInvoicePaymentPOSTGenerates and posts invoices and credit memos and collects payments for posted invoices.
Retrieve an operation jobGET_OperationJobGETRetrieves information about a specific operation job.
Order18
Activate an orderPUT_OrderActivatePUTNote: This operation is only available if you have the Orders feature enabled.
Cancel an orderPUT_OrderCancelPUTNote: This operation is only available if you have the Orders feature enabled.
Create an orderPOST_OrderPOSTNote: This operation is only available if you have the Orders feature enabled.
Create an order asynchronouslyPOST_CreateOrderAsynchronouslyPOSTNote: This operation is only available if you have the Orders feature enabled.
Delete an orderDELETE_OrderDELETENote: This operation is only available if you have the Orders feature enabled.
List ordersGET_AllOrdersGETNote: This feature is only available if you have the Order Metrics feature enabled.
List orders by subscription numberGET_OrdersBySubscriptionNumberGETNote: This feature is only available if you have the Order Metrics feature enabled.
List orders of a subscription ownerGET_OrdersBySubscriptionOwnerGETNote: This feature is only available if you have the Order Metrics feature enabled.
List orders of an invoice ownerGET_OrdersByInvoiceOwnerGETNote: This feature is only available if you have the Order Metrics feature enabled.
List pending orders by subscription numberGET_PendingOrdersBySubscriptionNumberGETNote: This feature is only available if you have the Order Metrics feature enabled.
Preview an orderPOST_PreviewOrderPOSTNotes : - This operation is only available if you have the Orders feature enabled.
Preview an order asynchronouslyPOST_PreviewOrderAsynchronouslyPOSTNotes: - This operation is only available if you have the Orders feature enabled.
Retrieve an orderGET_OrderGETNote: This feature is only available if you have the Order Metrics feature enabled.
Retrieve the status and response of a jobGET_JobStatusAndResponseGETNote: This operation is only available if you have the Orders feature enabled.
Update an orderPUT_OrderPUTNotes: - This operation is only available if you have the Orders feature enabled.
Update order action trigger datesPUT_OrderTriggerDatesPUTNote: This operation is only available if you have the Orders feature enabled.
Update order custom fieldsPUT_UpdateOrderCustomFieldsPUTNote: This feature is only available if you have the Order Metrics feature enabled.
Update subscription custom fieldsPUT_UpdateSubscriptionCustomFieldsPUTNote: This operation is only available if you have the Orders feature enabled.
Order Action1
Update an order actionPUT_OrderActionsPUTUpdates the change reason and custom fields for an order action.
Order Line Item3
Retrieve an order line itemGET_OrderLineItemGETNote: The Order Line Items feature is now generally available to all Zuora customers.
Update an order line itemPUT_OrderLineItemPUTNote: The Order Line Items feature is now generally available to all Zuora customers.
Update order line itemsPost_OrderLineItemsPOSTNote: The Order Line Items feature is now generally available to all Zuora customers.
Payment15
Apply a paymentPUT_ApplyPaymentPUTNote: This operation is only available if you have Invoice Settlement enabled.
Cancel a paymentPUT_CancelPaymentPUTNote: This operation is only available if you have Invoice Settlement enabled.
Create a paymentPOST_CreatePaymentPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Delete a paymentDELETE_PaymentDELETENote: This operation is only available if you have Invoice Settlement enabled.
List all parts of a paymentGET_PaymentPartsGETNote: This operation is only available if you have Invoice Settlement enabled.
List all payment part itemsGET_PaymentItemPartsGETNote: This operation is only available if you have the Invoice Item Settlement feature enabled.
List paymentsGET_RetrieveAllPaymentsGETNote: This operation is only available if you have Invoice Settlement enabled.
Refund a paymentPOST_RefundPaymentPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Refund a payment with auto-unapplyingPOST_RefundPaymentwithAutoUnapplyPOSTNote: This operation is only available if you have Invoice Settlement enabled.
Retrieve a paymentGET_PaymentGETNote: This operation is only available if you have Invoice Settlement enabled.
Retrieve a payment partGET_PaymentPartGETNote: This operation is only available if you have Invoice Settlement enabled.
Retrieve a payment part itemGET_PaymentItemPartGETNote: This operation is only available if you have the Invoice Item Settlement feature enabled.
Transfer a paymentPUT_TransferPaymentPUTNote: This operation is only available if you have Invoice Settlement enabled.
Unapply a paymentPUT_UnapplyPaymentPUTNote: This operation is only available if you have Invoice Settlement enabled.
Update a paymentPUT_UpdatePaymentPUTNote: This operation is only available if you have Invoice Settlement enabled.
Payment Authorization2
Cancel authorizationPOST_CancelAuthorizationPOSTAllows you to cancel an authorization.
Create authorizationPOST_CreateAuthorizationPOSTEnables you to authorize the availability of funds for a transaction but delay the capture of funds until a later time.
Payment Gateway1
List all payment gatewaysGET_PaymentgatewaysGETRetrieves the basic information about all the payment gateways.
Payment Gateway Reconciliation4
Reconcile a refundPOST_ReconcileRefundPOSTReconciles a refund when receiving the gateway reconciliation request or event.
Reject a paymentPOST_RejectPaymentPOSTIf the Asynchronous Payment Statuses feature is not enabled, this API operation sets the Gateway State field of the payment to FailedToSettle, creates a refund for the payment amount, and...
Reverse a paymentPOST_ReversePaymentPOSTIf the Asynchronous Payment Statuses feature is not enabled, this API operation sets the Gateway State field of the payment to Settled, creates a refund for the amount specified in the...
Settle a paymentPOST_SettlePaymentPOSTIf the Asynchronous Payment Statuses feature is not enabled, this API operation sets the Gateway State field of the payment to Settled and returns the Payment object as response.
Payment Method15
Cancel a stored credential profilePOST_CancelStoredCredentialProfilePOSTCancels a stored credential profile within a payment method.
Create a payment methodPOST_PaymentMethodsPOSTYou can use this operation to create either a payment method associated with a specific customer account, or an orphan payment method that is not associated with any customer account.
Create a payment sessionPOST_CreatePaymentSessionPOSTWhen implementing Apple Pay integration by using Zuora's JavaScript SDK, use this operation to create a payment session on your server side.
Create a stored credential profilePOST_CreateStoredCredentialProfilePOSTCreates a stored credential profile within a payment method.
Create an Apple Pay payment methodPOST_PaymentMethodsDecryptionPOSTThe decryption API endpoint can conditionally perform 4 tasks in one atomic call: Decrypt Apple Pay Payment token Create Credit Card Payment Method in Zuora with decrypted Apple Pay...
Delete a payment methodDELETE_PaymentMethodsDELETEDeletes a credit card payment method.
Expire a stored credential profilePOST_ExpireStoredCredentialProfilePOSTExpires a stored credential profile within a payment method.
List registered Apple Pay domainsGET_ListApplePayDomainsGETUse this operation to retrieve details of your domains that are already registered with Apple for Apple Pay button integration implemented through Zuora's JavaScript SDK.
List stored credential profiles of a payment methodGET_StoredCredentialProfilesGETRetrieves the stored credential profiles within a payment method.
Register an Apple Pay domainPOST_RegisterApplePayDomainPOSTBefore adding Apple Pay to your checkout flow by integrating with the JavaScript SDK provided by Zuora, your domains that will show the Apple Pay button must be registered with Apple.
Retrieve a payment methodGET_PaymentMethodGETThis operation allows you to get the detailed information about a payment method.
Scrub a payment methodPUT_ScrubPaymentMethodsPUTThis operation enables you to replace all sensitive data in a payment method, related payment method snapshot table, and four related log tables with dummy values that will be stored in...
Unregister an Apple Pay domainDELETE_UnregisterApplePayDomainDELETEUse this operation to unregister a domain with Apple for Apple Pay button integration implemented through Zuora's JavaScript SDK.
Update a payment methodPUT_PaymentMethodPUTThis operation allows you to update an existing payment method.
Verify a payment methodPUT_VerifyPaymentMethodsPUTSends an authorization request to the corresponding payment gateway to verify the payment method, even though no changes are made for the payment method.
Payment Method Snapshot1
CRUD: Retrieve a payment method snapshotObject_GETPaymentMethodSnapshotGETThis REST API reference describes how to retrieve a Payment Method Snapshot.
Payment Method Transaction Log1
CRUD: Retrieve a payment method transaction logObject_GETPaymentMethodTransactionLogGET
Payment Method Updater2
Create a Payment Method Updater batch asynchronouslyPOST_PaymentMethodUpdaterBatchPOSTCreates a Payment Method Updater (PMU) batch asynchronously.
List Payment Method Updater instancesGET_PaymentMethodUpdaterInstancesGETRetrieves the detailed information of all Payment Method Updater (PMU) instances on your tenant, except for American Express (AMEX).
Payment Run7
Create a payment runPOST_PaymentRunPOSTCreates a payment run.
Delete a payment runDELETE_PaymentRunDELETEDeletes a payment run.
List payment runsGET_PaymentRunsGETRetrieves the information about all payment runs.
Retrieve a payment runGET_PaymentRunGETRetrives the information about a specific payment run.
Retrieve a payment run summaryGET_PaymentRunSummaryGETRetrives the summary of a payment run.
Retrieve payment run dataGET_PaymentRunDataGETRetrieves payment run data and the processing result with details, if the data field was specified in the Create payment run operation.
Update a payment runPUT_PaymentRunPUTUpdates the information about an unexecuted payment run.
Payment Schedule14
Add payment schedule items to a custom payment schedulePOST_AddItemsToCustomPaymentSchedulePOSTAdds payment schedule items to a custom payment schedule.
Cancel a payment schedulePUT_CancelPaymentSchedulePUTCancels a payment schedule.
Cancel a payment schedule itemPUT_CancelPaymentScheduleItemPUTCancels a payment schedule item by ID.
Create a payment schedulePOST_PaymentSchedulePOSTCreates a payment schedule.
Create multiple payment schedules at oncePOST_PaymentSchedulesPOSTCreates multiple payment schedules at once.
List payment schedules by customer accountGET_PaymentSchedulesGETRetrieves payment schedules of a customer account.
Preview the result of payment schedule updatesPUT_PaymentScheduleUpdatePreviewPUTPreview the result of a payment schedule update.
Retrieve a payment scheduleGET_PaymentScheduleGETRetrieves a payment schedule by payment schedule key.
Retrieve a payment schedule itemGET_PaymentScheduleItemGETRetrieves a payment schedule item by ID.
Retrieve payment schedule statistic of a dateGET_PaymentScheduleStatisticGETRetrieves the payment schedule statistic of a specific date.
Retry failed payment schedule itemsPOST_RetryPaymentScheduleItemPOSTRetries failed payment schedule items.
Skip a payment schedule itemPUT_SkipPaymentScheduleItemPUTSkips a payment schedule item by ID.
Update a payment schedulePUT_PaymentSchedulePUTUpdates a payment schedule.
Update a payment schedule itemPUT_PaymentScheduleItemPUTUpdates a payment schedule item by ID.
Payment Transaction Log1
CRUD: Retrieve a payment transaction logObject_GETPaymentTransactionLogGETRetrieves information about a specific payment transaction log.
Prepaid With Drawdown2
Reverse fund rolloverPOST_ReverseRolloverPOSTThis REST API reference describes how to manually reverse fund rollover from source validity period to destination validity period.
Trigger fund rolloverPOST_RolloverPOSTPrepaid with Drawdown Rollover enables you to transfer the accumulative carryover of your customers’ prepaid balance funds to the following validity period when using Prepaid with Drawdown.
Price Book Item5
Create a price book itemPOST_CreatePriceBookItemPOSTCreates a price book item.
Delete a price book itemDELETE_PriceBookItemDELETEDeletes a price book item.
List price book itemsGET_ListPriceBookItemsGETRetrieves basic information about all price book items.
Retrieve a price book itemGET_RetrievePriceBookItemGETRetrieves basic information about a price book item.
Update a price book itemPUT_UpdatePriceBookItemPUTUpdate a price book item.
Product4
CRUD: Create a productObject_POSTProductPOST
CRUD: Delete a productObject_DELETEProductDELETE
CRUD: Retrieve a productObject_GETProductGET
CRUD: Update a productObject_PUTProductPUT
Product Charge Definition7
Create a product charge definitionPOST_CreateProductChargeDefinitionPOSTCreates a product charge definition for a charge.
Create product charge definitionsPOST_CreateProductChargeDefinitionBulkPOSTBulk creates product charge definitions for a charge.
Delete a product charge definitionDELETE_ProductChargeDefnitionDELETEDeletes a product charge definition.
List product charge definitionsGET_RetrieveProductChargeDefinitionsGETRetrieves basic information about the product charge definitions.
Retrieve a product charge definitionGET_RetrieveProductChargeDefinitionGETRetrieves basic information about a product charge definition.
Update a product charge definitionPUT_UpdateProductChargeDefinitionPUTUpdate a product charge definition.
Update product charge definitionsPUT_UpdateProductChargeDefinitionBulkPUTBulk updates multiple product charge definitions.
Product Rate Plan7
CRUD: Create a product rate planObject_POSTProductRatePlanPOSTRetrieves a product rate plan.
CRUD: Delete a product rate planObject_DELETEProductRatePlanDELETEDeletes a product rate plan.
CRUD: Retrieve a product rate planObject_GETProductRatePlanGETRetrieves a product rate plan.
CRUD: Update a product rate planObject_PUTProductRatePlanPUTUpdates a product rate plan.
List all product rate plans of a productGET_ProductRatePlansGETRetrieves information about all product rate plans of a specific product.
List product rate plans by external IDGET_ProductRatePlansByExternalIDGETRetrieves information about one or multiple product rate plans by external ID.
Retrieve a product rate plan by IDGET_ProductRatePlanGETRetrieves a product rate plan by its ID.
Product Rate Plan Charge5
CRUD: Create a product rate plan chargeObject_POSTProductRatePlanChargePOSTCreates a product rate plan charge for a specified rate plan charge.
CRUD: Delete a product rate plan chargeObject_DELETEProductRatePlanChargeDELETEDeletes a product rate plan charge.
CRUD: Retrieve a product rate plan chargeObject_GETProductRatePlanChargeGET
CRUD: Update a product rate plan chargeObject_PUTProductRatePlanChargePUTUpdates the information about a product rate plan charge.
Retrieve a product rate plan chargeGET_RetrieveProductRatePlanChargeGETRetrieves basic information about a product rate plan charge.
Product Rate Plan Charge Tier2
CRUD: Retrieve a product rate plan charge tierObject_GETProductRatePlanChargeTierGET
CRUD: Update a product rate plan charge tierObject_PUTProductRatePlanChargeTierPUTUpdates the price of a product rate plan charge tier.
Product Rate Plan Definition4
Create a product rate plan definitionPOST_CreateProductRatePlanDefinitionPOSTCreates a product rate plan definition to use a charge in a product rate plan.
Delete a product rate plan definitionDELETE_ProductRatePlanDefnitionDELETEDeletes a product rate plan definition.
List product rate plan definitionsGET_RetrieveProductRatePlanDefinitionsGETRetrieves basic information about the product rate plan definitions for a product rate plan.
Retrieve a product rate plan definitionGET_RetrieveProductRatePlanDefinitionGETRetrieves basic information about a product rate plan definition.
Ramp5
List all ramp metrics of a rampGET_RampMetricsByRampNumberGETNote : This operation is only available if you have the Ramps feature enabled.
List ramp metrics by order numberGET_RampMetricsByOrderNumberGETNote : This operation is only available if you have the Ramps feature enabled.
List ramp metrics by subscription keyGET_RampMetricsBySubscriptionKeyGETNote : This operation is only available if you have the Ramps feature enabled.
Retrieve a rampGET_RampByRampNumberGETNote : This operation is only available if you have the Ramps feature enabled.
Retrieve a ramp by subscription keyGET_RampsBySubscriptionKeyGETNote : This operation is only available if you have the Ramps feature enabled.
Rate Plan1
Retrieve a rate planGET_RatePlanGETRetrieves the detailed information about a specific subscription rate plan.
Refund9
Cancel a refundPUT_CancelRefundPUTNote: This operation is only available if you have Invoice Settlement enabled.
Delete a refundDELETE_RefundDELETENote: This operation is only available if you have Invoice Settlement enabled.
List all parts of a refundGET_RefundPartsGETNote: This operation is only available if you have Invoice Settlement enabled.
List all refund part itemsGET_RefundItemPartsGETNote: This operation is only available if you have the Invoice Item Settlement feature enabled.
List refundsGET_RefundsGETNote: This operation is only available if you have Invoice Settlement enabled.
Retrieve a refundGET_RefundGETNote: This operation is only available if you have Invoice Settlement enabled.
Retrieve a refund partGET_RefundPartGETNote: This operation is only available if you have Invoice Settlement enabled.
Retrieve a refund part itemGET_RefundItemPartGETNote: This operation is only available if you have the Invoice Item Settlement feature enabled.
Update a refundPUT_UpdateRefundPUTNote: This operation is only available if you have Invoice Settlement enabled.
Regenerate4
Regenerate billing transactionsPOST_RegenerateBillingTransactionPOSTUse this operation to generate billing transactions.
Regenerate booking transactionsPOST_RegenerateBookingTransactionPOSTUse this operation to generate booking transactions.
Regenerate revenue recognition events transactions for DailyPOST_GenerateRevRecEventsForDailyConsumptionPOSTUse this operation to generate Daily Consumption based revenue recognition events transactions when the Prepaid with Drawdown feature is enabled.
Regenerate revenue recognition events transactions for DeliveryPOST_CreateRevRecEventsPOSTUse this operation to generate Delivery Schedule based revenue recognition events transactions.
RSA Signature2
Decrypt an RSA signaturePOST_DecryptRSASignaturesPOSTThe REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature.
Generate an RSA signaturePOST_RSASignaturesPOSTThe REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature.
Sequence Set5
Create sequence setsPOST_SequenceSetsPOSTCreates sequence sets, allowing distinct numbering sequences for billing documents, payments, and refunds.
Delete a sequence setDELETE_SequenceSetDELETEDeletes a specific sequence set configured for billing documents, payments, and refunds.
List sequence setsGET_SequenceSetsGETRetrieves information about all sequence sets configured for billing documents, payments, and refunds.
Retrieve a sequence setGET_SequenceSetGETRetrieves information about a specific sequence set configured for billing documents, payments, and refunds.
Update a sequence setPUT_SequenceSetPUTUpdates a specific sequence set configured for billing documents, payments, and refunds.
Setting2
List all settingsGET_ListAllSettingsGETGet a list of all available settings in your tenant.
Submit settings requestsPOST_ProcessSettingsBatchRequestPOSTSubmit a batch of settings requests by this single API operation.
Sign Up1
Sign upPOST_SignUpPOSTThis call performs many actions.
Subscription12
Cancel a subscriptionPUT_CancelSubscriptionPUTThis REST API reference describes how to cancel an active subscription.
Create a subscriptionPOST_SubscriptionPOSTThis REST API reference describes how to create a new subscription for an existing customer account.
Delete a subscription by numberPUT_DeleteSubscriptionPUTThis REST API reference describes how to delete a subscription of the specified subscription number.
List subscriptions by account keyGET_SubscriptionsByAccountGETRetrieves all subscriptions associated with the specified account.
Preview a subscriptionPOST_PreviewSubscriptionPOSTThe REST API reference describes how to create a new subscription in preview mode.
Renew a subscriptionPUT_RenewSubscriptionPUTRenews a termed subscription using existing renewal terms.
Resume a subscriptionPUT_ResumeSubscriptionPUTThis REST API reference describes how to resume a suspended subscription.
Retrieve a subscription by keyGET_SubscriptionsByKeyGETThis REST API reference describes how to retrieve detailed information about a specified subscription in the latest version.
Retrieve a subscription by key and versionGET_SubscriptionsByKeyAndVersionGETThis REST API reference describes how to retrieve detailed information about a specified subscription in a specified version.
Suspend a subscriptionPUT_SuspendSubscriptionPUTThis REST API reference describes how to suspend an active subscription.
Update a subscriptionPUT_SubscriptionPUTUse 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...
Update subscription custom fields of a subscription versionPUT_UpdateSubscriptionCustomFieldsOfASpecifiedVersionPUTUpdates the custom fields of a specified subscription version.
Summary Journal Entry6
Cancel a summary journal entryPUT_SummaryJournalEntryPUTThis reference describes how to cancel a summary journal entry using the REST API.
Create a summary journal entryPOST_SummaryJournalEntryPOSTThis REST API reference describes how to manually create a summary journal entry.
Delete a summary journal entryDELETE_SummaryJournalEntryDELETEThis reference describes how to delete a summary journal entry using the REST API.
List all summary journal entries in a journal runGET_AllSummaryJournalEntriesGETThis REST API reference describes how to retrieve information about all summary journal entries in a journal run.
Retrieve a summary journal entryGET_SummaryJournalEntryGETThis REST API reference describes how to get information about a summary journal entry by its journal entry number.
Update a summary journal entryPUT_BasicSummaryJournalEntryPUTThis REST API reference describes how to update the basic information of a summary journal entry.
Taxation Item4
CRUD: Create a taxation itemObject_POSTTaxationItemPOST
Delete a taxation itemDELETE_TaxationItemDELETEDeletes a specific taxation item by ID.
Retrieve a taxation itemGET_TaxationItemGETRetrieves the information about a specific taxation item by ID.
Update a taxation itemPUT_TaxationItemPUTUpdates a specific taxation item by ID.
Usage7
CRUD: Create a usage recordObject_POSTUsagePOST
CRUD: Delete a usage recordObject_DELETEUsageDELETE
CRUD: Retrieve a usage recordObject_GETUsageGET
CRUD: Update a usage recordObject_PUTUsagePUT
Retrieve a usage recordGET_UsageGETThis REST API reference describes how to retrieve usage details for an account.
Retrieve usage rate detail for an invoice itemGET_Usage_Rate_Detail_By_Invoice_ItemGETUse this REST API operation to retrieve the usage rate detail for an invoice item to understand how the total amount is calculated.
Upload a usage filePOST_UsagePOSTThis REST API reference describes how to post or import usage data for one or more accounts in the CSV format.
Workflow16
Delete a workflowDELETE_WorkflowDELETEDeletes a specific workflow by its ID.
Delete a workflow versionDELETE_WorkflowVersionDELETEDelete a workflow version based on the version id.
Export a workflow versionGET_WorkflowExportGETExports a workflow version into a JSON file.
Import a workflowPOST_WorkflowImportPOSTCreate a new workflow definition and its first version using the exported JSON document of an existing workflow version.
Import a workflow versionPOST_WorkflowVersionsImportPOSTCreate a new workflow version under a workflow definition using the exported JSON document of an existing workflow version.
List all versions of a workflow definitionGET_WorkflowVersionsGETReturn a list of all workflow versions under a workflow definition
List workflow tasksGET_WorkflowsTasksGETRetrieves a list of workflow tasks available in your Zuora tenant.
List workflowsGET_WorkflowsGETRetrieves a list of workflow definitions available in your Zuora tenant.
Rerun a workflow taskPOST_WorkflowsTaskRerunPOSTReruns a specific workflow task by its ID.
Retrieve a workflowGET_WorkflowGETRetrieves information about a specific workflow by its ID.
Retrieve a workflow runGET_Workflow_RunGETRetrieves information about a specific workflow run by its ID.
Retrieve a workflow taskGET_WorkflowsTaskGETRetrieves a specific workflow task by its ID.
Retrieve workflow task usageGET_WorkflowsUsagesGETGets workflow task usage sorted by day within a specified time frame.
Run a workflowPOST_Run_WorkflowPOSTRun a specified workflow.
Update a workflowPATCH_UpdateWorkflowPATCHUpdates a specific workflow by its ID, which allows you to configure the settings of a workflow via API.
Update workflow tasksPUT_WorkflowsTasksUpdatePUTUpdates a group of workflow tasks.
Zuora Revenue Integration1
Update a Zuora Revenue accounting codePUT_RevProAccountingCodesPUTUpdate the Zuora Revenue accounting code that corresponds to a specific Product Rate Plan Charge Id in Zuora Billing.