Connectors
Finance, Billing & Payments
Zuora
Subscription billing: accounts, subscriptions, invoices, payments, and revenue data
- Signs in with
- API token
- Runs on
- Cloud or On-Prem Worker
- Operations
- 446
- Ready-made triggers
- 0
Connect Zuora
- In Neblex open Connect › Connections and click New Connection.
- Search for Zuora and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| Access tokenRequiredSecret |
Use it in a flow
- Open a flow, open the node library and search for Zuora.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- 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_Account | POST | Creates a customer account with a payment method, a bill-to contact, and an optional sold-to contact. |
Delete an accountDELETE_Account | DELETE | Deletes a specific account asynchronously. |
List payment methods of an accountGET_AcountPaymentMethods | GET | Retrieves the payment methods of the specified customer account. |
Retrieve an accountGET_Account | GET | Retrieves basic information about a customer account. |
Retrieve an account summaryGET_AccountSummary | GET | Retrieves detailed information about the specified customer account. |
Retrieve the default payment method of an accountGET_AcountDefaultPaymentMethod | GET | Retrieves the default payment method of the specified customer account. |
Update an accountPUT_Account | PUT | Updates a customer account by specifying the account-key. |
Accounting Code7
Activate an accounting codePUT_ActivateAccountingCode | PUT | This reference describes how to activate an accounting code through the REST API. |
Create an accounting codePOST_AccountingCode | POST | This reference describes how to create a new accounting code through the REST API. |
Deactivate an accounting codePUT_DeactivateAccountingCode | PUT | This reference describes how to deactivate an accounting code through the REST API. |
Delete an accounting codeDELETE_AccountingCode | DELETE | This reference describes how to delete an accounting code through the REST API. |
List all accounting codesGET_AllAccountingCodes | GET | This reference describes how to query all accounting codes in your chart of accounts through the REST API. |
Retrieve an accounting codeGET_AccountingCode | GET | This reference describes how to query an accounting code through the REST API. |
Update an accounting codePUT_AccountingCode | PUT | This reference describes how to update an existing accounting code through the REST API. |
Accounting Period9
Close an accounting periodPUT_CloseAccountingPeriod | PUT | Close an accounting period by accounting period ID. |
Create an accounting periodPOST_AccountingPeriod | POST | Creates an accounting period. |
Delete an accounting periodDELETE_AccountingPeriod | DELETE | Deletes an accounting period. |
List all accounting periodsGET_AllAccountingPeriods | GET | Retrieves all accounting periods on your tenant. |
Reopen an accounting periodPUT_ReopenAccountingPeriod | PUT | Re-opens an accounting period. |
Retrieve an accounting periodGET_AccountingPeriod | GET | Retrieves an accounting period. |
Run trial balancePUT_RunTrialBalance | PUT | Runs the trial balance for an accounting period. |
Set an accounting period to pending closePUT_PendingCloseAccountingPeriod | PUT | Sets an accounting period to pending close. |
Update an accounting periodPUT_UpdateAccountingPeriod | PUT | Updates an accounting period. |
Action5
CreateAction_POSTcreate | POST | Use the create call to create one or more objects of a specific type. |
DeleteAction_POSTdelete | POST | Deletes one or more objects of the same type. |
QueryAction_POSTquery | POST | The 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_POSTqueryMore | POST | Use queryMore to request additional results from a previous query call. |
UpdateAction_POSTupdate | POST | Updates the information in one or more objects of the same type. |
Aggregate Query4
Cancel a running aggregate query jobDELETE_BatchQueryJob | DELETE | Cancels the current AQuA job, only if the job is not complete. |
Retrieve an aggregate query jobGET_BatchQueryJob | GET | Retrieves an aggregate query using the Job ID. |
Retrieve the last completed aggregate query jobGET_LastBatchQueryJob | GET | Returns the details of the last completed job. |
Submit an aggregate query jobPOST_BatchQueryJob | POST | Submits an AQuA job that contains an aggregated list of ZOQL and Export ZOQL queries. |
API Health1
List API volume summary recordsGET_SystemHealthApiVolumeSummary | GET | Returns volume summary of API usage that generated by your Zuora tenant within a specified time range. |
Attachment5
Create an attachmentPOST_Attachments | POST | Use 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_Attachments | DELETE | Use the Delete Attachment REST request to delete an attachment from a Zuora object. |
List attachments by object type and keyGET_AttachmentsList | GET | Use 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_Attachments | GET | Use the View Attachment REST request to retrieve information about an attachment document. |
Update an attachmentPUT_Attachments | PUT | Use 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_CancelBillRun | PUT | Cancels a bill run in Draft status. |
Create a bill runPOST_CreateBillRun | POST | Creates an ad-hoc bill run or a scheduled bill run. |
Delete a bill runDELETE_DeleteBillRun | DELETE | Deletes a bill run. |
Email billing documents generated from a bill runPOST_EmailBillingDocumentsfromBillRun | POST | Manually emails all the billing documents that are generated from a specified bill run to your customers. |
Post a bill runPUT_PostBillRun | PUT | Posts a bill run asynchronously. |
Retrieve a bill runGET_BillRun | GET | Retrieves the information about a specific bill run. |
Bill Run Health1
List billing document volume summary recordsGET_SystemHealthBillingDocVolumeSummary | GET | Returns 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_BillingDocumentFilesDeletionJob | POST | Creates an asynchronous job to permanently delete all billing document PDF files for specific accounts. |
Generate billing documents by account IDPOST_GenerateBillingDocuments | POST | Generates draft or posted billing documents for a specified account. |
List billing documents for an accountGET_BillingDocuments | GET | Retrieves the information about all billing documents associated with a specified account. |
Retrieve a job of hard deleting billing document filesGET_BillingDocumentFilesDeletionJob | GET | Retrieves information about an asynchronous job of permanently deleting all billing document PDF files for specific accounts. |
Billing Preview Run2
Create a billing preview runPOST_BillingPreviewRun | POST | Creates a billing preview run for multiple customer accounts. |
Retrieve a billing preview runGET_BillingPreviewRun | GET | Retrieves a preview of future invoice items for multiple customer accounts through a billing preview run. |
Catalog2
List all productsGET_Catalog | GET | Retrieves the entire product catalog, including all products, features, and their corresponding product rate plans, charges. |
Retrieve a productGET_Product | GET | Retrieves detailed information about a specific product, including information about its product rate plans and charges. |
Catalog Group5
Create a catalog groupPOST_CreateCatalogGroup | POST | Note : This operation is in the Early Adopter phase. |
Delete a catalog groupDELETE_CatalogGroup | DELETE | Note : This operation is in the Early Adopter phase. |
List all catalog groupsGET_ListAllCatalogGroups | GET | Note : This operation is in the Early Adopter phase. |
Retrieve a catalog groupGET_RetrieveCatalogGroup | GET | Note : This operation is in the Early Adopter phase. |
Update a catalog groupPUT_UpdateCatalogGroup | PUT | Note : This operation is in the Early Adopter phase. |
Configuration Template8
Compare settings between a source tenant and a target tenantPOST_CompareTemplate | POST | To 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_DeploymentTemplate | POST | Creates templates based on user preference. |
Delete a templateDELETE_DeploymentTemplate | DELETE | Deletes a specific template by passing the ID. |
Download a templateGET_DownloadDeploymentTemplate | GET | Download a template for migration in the Deployment manager from the source tenant to the target tenant. |
List all details of a templateGET_DeploymentTemplateDetail | GET | Returns the detailed information of a specific template by passing its template ID. |
List all details of source componentsGET_SourceComponentDetails | GET | When the advanced option is clicked, get the details/metadata of the components, such as settings, notifications, workflow, etc. |
List all templatesGET_Templates | GET | Retrieves all the templates and their details which are created already. |
Migrate settings from source tenant to target tenantPOST_MigrateTenantSettings | POST | To migrate the selected configuration of a tenant in Deployment Manager migration while using template from the compare screen. |
Contact5
Create a contactPOST_CreateContact | POST | Creates a contact for a specified account. |
Delete a contactDELETE_Contact | DELETE | Deletes a contact. |
Retrieve a contactGET_Contact | GET | Retrieves detailed information about a specific contact. |
Scrub a contactPUT_ScrubContact | PUT | Scrubs the sensitive data of a specific contact. |
Update a contactPUT_Contact | PUT | Updates a contact for a specified account. |
Contact Snapshot1
Retrieve a contact snapshotGET_ContactSnapshot | GET | Retrieves detailed information about the snapshot of a contact, either a bill-to contact or sold-to contact. |
Credit Memo26
Apply a credit memoPUT_ApplyCreditMemo | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Cancel a credit memoPUT_CancelCreditMemo | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Create a credit memo from a chargePOST_CreditMemoFromPrpc | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Create a credit memo from an invoicePOST_CreditMemoFromInvoice | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Create credit memosPOST_CreateCreditMemos | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Create taxation items for a credit memoPOST_CM_TaxationItems | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Delete a credit memoDELETE_CreditMemo | DELETE | Note: This operation is only available if you have Invoice Settlement enabled. |
Email a credit memoPOST_EmailCreditMemo | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Generate a credit memo PDF filePOST_CreditMemoPDF | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Generate an e-invoice file for a credit memoPUT_GenerateEInvoiceFileForCreditMemo | PUT | Generates an e-invoice file for a credit memo. |
List all parts of a credit memoGET_CreditMemoParts | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
List all taxation items of a credit memo itemGET_TaxationItemsOfCreditMemoItem | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
List credit memo itemsGET_CreditMemoItems | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
List credit memosGET_CreditMemos | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
Post a credit memoPUT_PostCreditMemo | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Refund a credit memoPOST_RefundCreditMemo | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Retrieve a credit memoGET_CreditMemo | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
Retrieve a credit memo itemGET_CreditMemoItem | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
Retrieve a credit memo partGET_CreditMemoPart | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
Reverse a credit memoPUT_ReverseCreditMemo | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Unapply a credit memoPUT_UnapplyCreditMemo | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Unpost a credit memoPUT_UnpostCreditMemo | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Update a credit memoPUT_UpdateCreditMemo | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Update credit memosPUT_UpdateCreditMemos | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Upload a file for a credit memoPOST_UploadFileForCreditMemo | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Write off a credit memoPUT_WriteOffCreditMemo | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Custom Event Trigger5
Create an event triggerPOST_EventTrigger | POST | When you create an event trigger, you must specify the base object and define the trigger condition. |
Delete an event triggerDELETE_EventTrigger | DELETE | |
List event triggersGET_EventTriggers | GET | |
Retrieve an event triggerGET_EventTrigger | GET | |
Update an event triggerPUT_EventTrigger | PUT |
Custom Exchange Rate1
List custom exchange rates by currencyGET_CustomExchangeRates | GET | This feature is in Limited Availability . |
Custom Object Definition5
Create custom object definitionsPOST_CustomObjectDefinitions | POST | You can post custom object definitions with the request body schema described below. |
Delete a custom object definitionDelete_CustomObjectDefinitionByType | DELETE | Deletes the custom object definition for the provided type. |
List custom object definitionsGET_AllCustomObjectDefinitionsInNamespace | GET | Get all custom objects definitions for a given tenant. |
Retrieve a custom object definitionGET_CustomObjectDefinitionByType | GET | Retrieves the custom object definition by type for the given tenant. |
Update a custom object definitionPOST_UpdateCustomObjectDefinition | POST | Updates a custom object definition by posting migration resource to initiate the migration of definitions. |
Custom Object Job6
Cancel a custom object bulk jobPATCH_CustomObjectBulkJob | PATCH | Cancel a custom object bulk job. |
List all custom object bulk jobsGET_AllCustomObjectBulkJobs | GET | Lists all custom object bulk jobs submitted by your tenant. |
List all errors for a custom object bulk jobGET_CustomObjectBulkJobErrors | GET | Lists all errors for a custom object bulk job. |
Retrieve a custom object bulk jobGET_CustomObjectBulkJob | GET | Retrieves the custom object bulk job details by job ID. |
Submit a custom object bulk jobPOST_CustomObjectBulkJob | POST | Submits a bulk job request for a bulk operation on the specified custom object records. |
Upload a file for a custom object bulk jobPOST_UploadFileForCustomObjectBulkJob | POST | Uploads a .csv file for a custom object bulk job to create or update custom object records. |
Custom Object Record7
Create custom object recordsPOST_CustomObjectRecords | POST | Creates custom object records with the given type. |
Delete a custom object recordDelete_CustomObjectRecordByID | DELETE | Deletes a custom object record of the given type and ID. |
List records for a custom objectGET_AllRecordsForCustomObjectType | GET | Lists all object records of the given type. |
Partially update a custom object recordPatch_PartialUpdateCustomObjectRecord | PATCH | Updates one or many fields of a custom object record. |
Retrieve a custom object recordGET_CustomObjectRecordByID | GET | Retrieves a record of a given type by ID. |
Update a custom object recordPUT_CustomObjectRecord | PUT | Updates a record of the given type and ID. |
Update or delete custom object recordsPOST_CustomObjectRecordsBatchUpdateOrDelete | POST | Makes a batch update or delete of custom object records. |
Custom Payment Method Type5
Create a draft custom payment method typePOST_CreateDraftOpenPaymentMethodType | POST | Creates a draft version of a custom payment method type. |
Publish a custom payment method typePUT_PublishOpenPaymentMethodType | PUT | Publish the latest draft revision of a specific custom payment method type. |
Retrieve a published custom payment method typeGET_OpenPaymentMethodTypePublish | GET | Retrieves a published custom payment method type. |
Retrieve a specific draft revision of a custom payment methodGET_OpenPaymentMethodTypeRevision | GET | Retrieves a specific draft revision of a custom payment method type. |
Update a custom payment method typePUT_UpdateOpenPaymentMethodType | PUT | Update the latest draft version of your custom payment method type. |
Custom Scheduled Event5
Create a scheduled eventPOST_ScheduledEvent | POST | To create a custom scheduled event, you must specify the base object, the base field and the scheduled time. |
Delete a scheduled event by IDDELETE_ScheduledEventByID | DELETE | |
List all scheduled eventsGET_ScheduledEvents | GET | |
Retrieve a scheduled event by IDGET_ScheduledEventByID | GET | |
Update a scheduled event by IDUPDATE_ScheduledEventByID | PUT |
Data Labeling2
Retrieve a data labeling jobGET_DataLabelingJob | GET | Retrieves a data labeling job. |
Submit a data labeling jobPOST_DataLabelingJob | POST | Submits a data labeling job. |
Data Query4
Cancel a data query jobDELETE_DataQueryJob | DELETE | Cancels a data query job, which prevents Zuora from performing the query. |
List data query jobsGET_DataQueryJobs | GET | Returns a list of data query jobs that have been created in your Zuora tenant. |
Retrieve a data query jobGET_DataQueryJob | GET | Retrieves a data query job. |
Submit a data queryPOST_DataQueryJob | POST | Submits a data query to be performed by Zuora and creates a query job. |
Debit Memo22
Cancel a debit memoPUT_CancelDebitMemo | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Collect a posted debit memoPOST_DebitMemoCollect | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Create a debit memo from a chargePOST_DebitMemoFromPrpc | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Create a debit memo from an invoicePOST_DebitMemoFromInvoice | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Create debit memosPOST_CreateDebitMemos | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Create taxation items for a debit memoPOST_DM_TaxationItems | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Delete a debit memoDELETE_DebitMemo | DELETE | Note: This operation is only available if you have Invoice Settlement enabled. |
Email a debit memoPOST_EmailDebitMemo | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Generate a debit memo PDF filePOST_DebitMemoPDF | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Generate an e-invoice file for a debit memoPUT_GenerateEInvoiceFileForDebitMemo | PUT | Generates an e-invoice file for a debit memo. |
List all application parts of a debit memoGET_DebitMemoApplicationParts | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
List all taxation items of a debit memo itemGET_TaxationItemsOfDebitMemoItem | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
List debit memo itemsGET_DebitMemoItems | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
List debit memosGET_DebitMemos | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
Post a debit memoPUT_PostDebitMemo | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Retrieve a debit memoGET_DebitMemo | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
Retrieve a debit memo itemGET_DebitMemoItem | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
Unpost a debit memoPUT_UnpostDebitMemo | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Update a debit memoPUT_DebitMemo | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Update debit memosPUT_UpdateDebitMemos | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Update due dates for debit memosPUT_UpdateDebitMemosDueDates | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Upload a file for a debit memoPOST_UploadFileForDebitMemo | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Delivery Adjustment5
Cancel a delivery adjustmentPUT_CancelAdjustment | PUT | Describes how to cancel an unbilled delivery adjustment. |
Create a delivery adjustmentCreate_Adjustment | POST | Describes how to create one or more delivery adjustments for a subscription. |
List all delivery adjustments of a subscriptionGET_Subscription_Adjustments | GET | Describes how to retrieve detailed information about delivery adjustments of a subscription. |
Preview a delivery adjustmentPreview_Adjustment | POST | Describes how to preview delivery adjustments of a subscription. |
Retrieve a delivery adjustmentGET_Adjustment | GET | Describes how to retrieve detailed information about a delivery adjustment. |
Describe1
Describe an objectGET_Describe | GET | Provides a reference listing of each object that is available in your Zuora tenant. |
E Invoicing15
Create an e-invoice file templatePOST_CreateEInvoiceFileTemplate | POST | Creates an e-invoice file templates for your billing documents, including invoices, credit memos, and debit memos. |
Create an e-invoicing business regionPOST_CreateEInvoicingBusinessRegion | POST | Creates an e-invoicing business region. |
Create an e-invoicing service providerPOST_EInvoicingServiceProvider | POST | Creates an e-invoicing service provider. |
Delete an e-invoice file templateDELETE_EInvoiceFileTemplate | DELETE | Deletes an e-invoice file template by key. |
Delete an e-invoicing business regionDELETE_EInvoicingBusinessRegion | DELETE | Deletes an e-invoicing business region by key. |
Delete an e-invoicing service providerDELETE_EInvoicingServiceProvider | DELETE | Deletes an e-invoicing service privider. |
List e-invoice file templatesGET_EInvoiceFileTemplates | GET | Lists information about e-invoice file templates. |
List e-invoicing business regionsGET_EInvoicingBusinessRegions | GET | Lists information about e-invoicing business regions. |
List e-invoicing service providersGET_EInvoicingServiceProviders | GET | Lists information about e-invoicing service providers. |
Retrieve an e-invoice file templateGET_EInvoiceFileTemplate | GET | Retrieves information about an e-invoice file template. |
Retrieve an e-invoicing business regionGET_EInvoicingBusinessRegion | GET | Retrieves information about an e-invoicing business region. |
Retrieve an e-invoicing service providerGET_EInvoicingServiceProvider | GET | Retrieves information about an e-invoicing service privider. |
Update an e-invoice file templatePUT_EInvoiceFileTemplate | PUT | Updates information about an e-invoice file template. |
Update an e-invoicing business regionPUT_UpdateEInvoicingBusinessRegion | PUT | Updates an e-invoicing business region by key. |
Update an e-invoicing service providerPUT_UpdateEInvoicingServiceProvider | PUT | Updates information about an e-invoicing service privider. |
Electronic Payments Health1
List payment volume summary recordsGET_SystemHealthPaymentVolumeSummary | GET | Returns a summary of electronic payments handled by your Zuora tenant within a specified time range. |
File1
Retrieve a fileGET_Files | GET | Retrieve files such as export results, invoices, and accounting period reports. |
Fulfillment8
Create fulfillment itemsCreate_FulfillmentItem | POST | Creates one or multiple fulfillment items. |
Create fulfillmentsCreate_Fulfillment | POST | Creates one or multiple Fulfillment objects. |
Delete a fulfillmentDelete_Fulfillment | DELETE | Deletes a specified fulfillment. |
Delete a fulfillment itemDelete_FulfillmentItem | DELETE | Deletes a specified fulfillment item. |
Retrieve a fulfillmentGET_Fulfillment | GET | Retrieves the detailed information about a specified fulfillment. |
Retrieve a fulfillment itemGET_FulfillmentItem | GET | Retrieves the detailed information about a specified fulfillment item. |
Update a fulfillmentPUT_Fulfillment | PUT | |
Update a fulfillment itemPUT_FulfillmentItem | PUT | Updates a specified fulfillment item. |
Hosted Page1
List hosted pagesGet_HostedPages | GET | Returns the Payment Pages configuration metadata, specifically, page ID, page version, payment method type. |
Import2
CRUD: Create an importObject_POSTImport | POST | Creates a data import. |
CRUD: Retrieve an importObject_GETImport | GET |
Invoice17
Create a standalone invoicePOST_StandaloneInvoice | POST | Creates a standalone invoice for selling physical goods, services or other items on a non-recurring basis to your subscription customers. |
Create standalone invoicesPOST_StandaloneInvoices | POST | Creates 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_TaxationItems | POST | Creates taxation items for an invoice. |
Delete an invoiceDELETE_DeleteInvoice | DELETE | Deletes a specific invoice. |
Email an invoicePOST_EmailInvoice | POST | Sends a posted invoice to the specified email addresses manually. |
Generate an e-invoice file for an invoicePUT_GenerationEInvoiceGenerationForInvoices | PUT | Generates an e-invoice file for an invoice. |
List all application parts of an invoiceGET_InvoiceApplicationParts | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
List all files of an invoiceGET_InvoiceFiles | GET | Retrieves the information about all PDF files of a specified invoice. |
List all items of an invoiceGET_InvoiceItems | GET | Retrieves the information about all items of a specified invoice. |
List all taxation items of an invoice itemGET_TaxationItemsOfInvoiceItem | GET | Retrieves information about the taxation items of a specific invoice item. |
Post invoicesPOST_PostInvoices | POST | Posts multiple invoices. |
Retrieve an invoiceGet_GetInvoice | GET | Retrieves a specific invoice. |
Reverse an invoicePUT_ReverseInvoice | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Update an invoicePUT_UpdateInvoice | PUT | Updates a specific invoice. |
Update invoicesPUT_BatchUpdateInvoices | PUT | Updates multiple invoices in batches with one call. |
Upload a file for an invoicePOST_UploadFileForInvoice | POST | Uploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status. |
Write off an invoicePUT_WriteOffInvoice | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Invoice Schedule7
Create an invoice schedulePOST_CreateInvoiceSchedule | POST | Creates an invoice schedule. |
Delete an invoice scheduleDELETE_InvoiceSchedule | DELETE | Deletes an invoice schedule in Pending status. |
Execute an invoice schedulePOST_ExecuteInvoiceSchedule | POST | Executes an invoice schedule immediately. |
Pause an invoice schedulePUT_PauseInvoiceSchedule | PUT | Pauses an invoice schedule immediately. |
Resume an invoice schedulePUT_ResumeInvoiceSchedule | PUT | Resumes an invoice schedule in Paused status immediately. |
Retrieve an invoice scheduleGET_InvoiceSchedule | GET | Retrieves detailed information about an invoice schedule. |
Update an invoice schedulePUT_UpdateInvoiceSchedule | PUT | Updates a pending invoice schedule. |
Journal Run4
Cancel a journal runPUT_JournalRun | PUT | This reference describes how to cancel a journal run using the REST API. |
Create a journal runPOST_JournalRun | POST | This REST API reference describes how to create a journal run. |
Delete a journal runDELETE_JournalRun | DELETE | This reference describes how to delete a journal run using the REST API. |
Retrieve a journal runGET_JournalRun | GET | This REST API reference describes how to get information about a journal run. |
Mass Updater3
List all results of a mass actionGET_MassUpdater | GET | Describes how to get information about the result of a mass action through the REST API. |
Perform a mass actionPOST_MassUpdater | POST | Describes how to perform a mass action through the REST API. |
Stop a mass actionPUT_MassUpdater | PUT | Describes how to stop a mass action through the REST API. |
Notification17
Create a notification definitionPOST_Create_Notification_Definition | POST | Creates a notification definition. |
Create an email templatePOST_Create_Email_Template | POST | Creates an email template. |
Create or update email templatesPOST_CreateOrUpdateEmailTemplates | POST | Creates 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_Definition | DELETE | Deletes a notification definition. |
Delete an email templateDELETE_Delete_Email_Template | DELETE | Deletes an email template. |
Delete notification histories for an accountDELETE_Delete_Notification_History_For_Account | DELETE | Delete all notification histories for the given account. |
List callout notification historiesGET_CalloutHistory | GET | Describes how to get a notification history for callouts. |
List email notification historiesGET_EmailHistory | GET | Describes how to get a notification history for notification emails. |
List email templatesGET_Query_Email_Templates | GET | Queries email templates. |
List notification definitionsGET_Query_Notification_Definitions | GET | Queries notification definitions with the specified filters. |
Resend callout notificationsPOST_ResendCalloutNotifications | POST | Resends callout notifications if your customers did not receive previous callout notifications. |
Resend email notificationsPOST_ResendEmailNotifications | POST | Resends email notifications if your customers did not receive previous email notifications. |
Retrieve a notification definitionGET_Get_Notification_Definition | GET | Queries the notification definition of the given ID. |
Retrieve a notification history deletion taskGET_Get_Notification_History_Deletion_Task | GET | Get the notification history deletion task by ID. |
Retrieve an email templateGET_Get_Email_Template | GET | Queries the email template based on the specified ID. |
Update a notification definitionPUT_Update_Notification_Definition | PUT | Updates a notification definition. |
Update an email templatePUT_Update_Email_Template | PUT | Updates an email template. |
OAuth1
Create an OAuth tokencreateToken | POST | Creates a bearer token that enables an OAuth client to authenticate with the Zuora REST API. |
Offer4
Create an offerPOST_CreateOffer | POST | Creates an offer. |
Delete an offerDELETE_Offer | DELETE | Deletes an offer. |
List offersGET_ListOffers | GET | Retrieves basic information about all offers. |
Retrieve an offerGET_RetrieveOffer | GET | Retrieves basic information about an offer. |
Operation3
Generate a billing previewPOST_BillingPreview | POST | Generates a preview of future invoice items for one customer account. |
Invoice and collectPOST_TransactionInvoicePayment | POST | Generates and posts invoices and credit memos and collects payments for posted invoices. |
Retrieve an operation jobGET_OperationJob | GET | Retrieves information about a specific operation job. |
Order18
Activate an orderPUT_OrderActivate | PUT | Note: This operation is only available if you have the Orders feature enabled. |
Cancel an orderPUT_OrderCancel | PUT | Note: This operation is only available if you have the Orders feature enabled. |
Create an orderPOST_Order | POST | Note: This operation is only available if you have the Orders feature enabled. |
Create an order asynchronouslyPOST_CreateOrderAsynchronously | POST | Note: This operation is only available if you have the Orders feature enabled. |
Delete an orderDELETE_Order | DELETE | Note: This operation is only available if you have the Orders feature enabled. |
List ordersGET_AllOrders | GET | Note: This feature is only available if you have the Order Metrics feature enabled. |
List orders by subscription numberGET_OrdersBySubscriptionNumber | GET | Note: This feature is only available if you have the Order Metrics feature enabled. |
List orders of a subscription ownerGET_OrdersBySubscriptionOwner | GET | Note: This feature is only available if you have the Order Metrics feature enabled. |
List orders of an invoice ownerGET_OrdersByInvoiceOwner | GET | Note: This feature is only available if you have the Order Metrics feature enabled. |
List pending orders by subscription numberGET_PendingOrdersBySubscriptionNumber | GET | Note: This feature is only available if you have the Order Metrics feature enabled. |
Preview an orderPOST_PreviewOrder | POST | Notes : - This operation is only available if you have the Orders feature enabled. |
Preview an order asynchronouslyPOST_PreviewOrderAsynchronously | POST | Notes: - This operation is only available if you have the Orders feature enabled. |
Retrieve an orderGET_Order | GET | Note: This feature is only available if you have the Order Metrics feature enabled. |
Retrieve the status and response of a jobGET_JobStatusAndResponse | GET | Note: This operation is only available if you have the Orders feature enabled. |
Update an orderPUT_Order | PUT | Notes: - This operation is only available if you have the Orders feature enabled. |
Update order action trigger datesPUT_OrderTriggerDates | PUT | Note: This operation is only available if you have the Orders feature enabled. |
Update order custom fieldsPUT_UpdateOrderCustomFields | PUT | Note: This feature is only available if you have the Order Metrics feature enabled. |
Update subscription custom fieldsPUT_UpdateSubscriptionCustomFields | PUT | Note: This operation is only available if you have the Orders feature enabled. |
Order Action1
Update an order actionPUT_OrderActions | PUT | Updates the change reason and custom fields for an order action. |
Order Line Item3
Retrieve an order line itemGET_OrderLineItem | GET | Note: The Order Line Items feature is now generally available to all Zuora customers. |
Update an order line itemPUT_OrderLineItem | PUT | Note: The Order Line Items feature is now generally available to all Zuora customers. |
Update order line itemsPost_OrderLineItems | POST | Note: The Order Line Items feature is now generally available to all Zuora customers. |
Payment15
Apply a paymentPUT_ApplyPayment | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Cancel a paymentPUT_CancelPayment | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Create a paymentPOST_CreatePayment | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Delete a paymentDELETE_Payment | DELETE | Note: This operation is only available if you have Invoice Settlement enabled. |
List all parts of a paymentGET_PaymentParts | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
List all payment part itemsGET_PaymentItemParts | GET | Note: This operation is only available if you have the Invoice Item Settlement feature enabled. |
List paymentsGET_RetrieveAllPayments | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
Refund a paymentPOST_RefundPayment | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Refund a payment with auto-unapplyingPOST_RefundPaymentwithAutoUnapply | POST | Note: This operation is only available if you have Invoice Settlement enabled. |
Retrieve a paymentGET_Payment | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
Retrieve a payment partGET_PaymentPart | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
Retrieve a payment part itemGET_PaymentItemPart | GET | Note: This operation is only available if you have the Invoice Item Settlement feature enabled. |
Transfer a paymentPUT_TransferPayment | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Unapply a paymentPUT_UnapplyPayment | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Update a paymentPUT_UpdatePayment | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Payment Authorization2
Cancel authorizationPOST_CancelAuthorization | POST | Allows you to cancel an authorization. |
Create authorizationPOST_CreateAuthorization | POST | Enables 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_Paymentgateways | GET | Retrieves the basic information about all the payment gateways. |
Payment Gateway Reconciliation4
Reconcile a refundPOST_ReconcileRefund | POST | Reconciles a refund when receiving the gateway reconciliation request or event. |
Reject a paymentPOST_RejectPayment | POST | If 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_ReversePayment | POST | If 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_SettlePayment | POST | If 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_CancelStoredCredentialProfile | POST | Cancels a stored credential profile within a payment method. |
Create a payment methodPOST_PaymentMethods | POST | You 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_CreatePaymentSession | POST | When 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_CreateStoredCredentialProfile | POST | Creates a stored credential profile within a payment method. |
Create an Apple Pay payment methodPOST_PaymentMethodsDecryption | POST | The 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_PaymentMethods | DELETE | Deletes a credit card payment method. |
Expire a stored credential profilePOST_ExpireStoredCredentialProfile | POST | Expires a stored credential profile within a payment method. |
List registered Apple Pay domainsGET_ListApplePayDomains | GET | Use 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_StoredCredentialProfiles | GET | Retrieves the stored credential profiles within a payment method. |
Register an Apple Pay domainPOST_RegisterApplePayDomain | POST | Before 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_PaymentMethod | GET | This operation allows you to get the detailed information about a payment method. |
Scrub a payment methodPUT_ScrubPaymentMethods | PUT | This 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_UnregisterApplePayDomain | DELETE | Use this operation to unregister a domain with Apple for Apple Pay button integration implemented through Zuora's JavaScript SDK. |
Update a payment methodPUT_PaymentMethod | PUT | This operation allows you to update an existing payment method. |
Verify a payment methodPUT_VerifyPaymentMethods | PUT | Sends 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_GETPaymentMethodSnapshot | GET | This REST API reference describes how to retrieve a Payment Method Snapshot. |
Payment Method Transaction Log1
CRUD: Retrieve a payment method transaction logObject_GETPaymentMethodTransactionLog | GET |
Payment Method Updater2
Create a Payment Method Updater batch asynchronouslyPOST_PaymentMethodUpdaterBatch | POST | Creates a Payment Method Updater (PMU) batch asynchronously. |
List Payment Method Updater instancesGET_PaymentMethodUpdaterInstances | GET | Retrieves the detailed information of all Payment Method Updater (PMU) instances on your tenant, except for American Express (AMEX). |
Payment Run7
Create a payment runPOST_PaymentRun | POST | Creates a payment run. |
Delete a payment runDELETE_PaymentRun | DELETE | Deletes a payment run. |
List payment runsGET_PaymentRuns | GET | Retrieves the information about all payment runs. |
Retrieve a payment runGET_PaymentRun | GET | Retrives the information about a specific payment run. |
Retrieve a payment run summaryGET_PaymentRunSummary | GET | Retrives the summary of a payment run. |
Retrieve payment run dataGET_PaymentRunData | GET | Retrieves 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_PaymentRun | PUT | Updates the information about an unexecuted payment run. |
Payment Schedule14
Add payment schedule items to a custom payment schedulePOST_AddItemsToCustomPaymentSchedule | POST | Adds payment schedule items to a custom payment schedule. |
Cancel a payment schedulePUT_CancelPaymentSchedule | PUT | Cancels a payment schedule. |
Cancel a payment schedule itemPUT_CancelPaymentScheduleItem | PUT | Cancels a payment schedule item by ID. |
Create a payment schedulePOST_PaymentSchedule | POST | Creates a payment schedule. |
Create multiple payment schedules at oncePOST_PaymentSchedules | POST | Creates multiple payment schedules at once. |
List payment schedules by customer accountGET_PaymentSchedules | GET | Retrieves payment schedules of a customer account. |
Preview the result of payment schedule updatesPUT_PaymentScheduleUpdatePreview | PUT | Preview the result of a payment schedule update. |
Retrieve a payment scheduleGET_PaymentSchedule | GET | Retrieves a payment schedule by payment schedule key. |
Retrieve a payment schedule itemGET_PaymentScheduleItem | GET | Retrieves a payment schedule item by ID. |
Retrieve payment schedule statistic of a dateGET_PaymentScheduleStatistic | GET | Retrieves the payment schedule statistic of a specific date. |
Retry failed payment schedule itemsPOST_RetryPaymentScheduleItem | POST | Retries failed payment schedule items. |
Skip a payment schedule itemPUT_SkipPaymentScheduleItem | PUT | Skips a payment schedule item by ID. |
Update a payment schedulePUT_PaymentSchedule | PUT | Updates a payment schedule. |
Update a payment schedule itemPUT_PaymentScheduleItem | PUT | Updates a payment schedule item by ID. |
Payment Transaction Log1
CRUD: Retrieve a payment transaction logObject_GETPaymentTransactionLog | GET | Retrieves information about a specific payment transaction log. |
Prepaid With Drawdown2
Reverse fund rolloverPOST_ReverseRollover | POST | This REST API reference describes how to manually reverse fund rollover from source validity period to destination validity period. |
Trigger fund rolloverPOST_Rollover | POST | Prepaid 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_CreatePriceBookItem | POST | Creates a price book item. |
Delete a price book itemDELETE_PriceBookItem | DELETE | Deletes a price book item. |
List price book itemsGET_ListPriceBookItems | GET | Retrieves basic information about all price book items. |
Retrieve a price book itemGET_RetrievePriceBookItem | GET | Retrieves basic information about a price book item. |
Update a price book itemPUT_UpdatePriceBookItem | PUT | Update a price book item. |
Product4
CRUD: Create a productObject_POSTProduct | POST | |
CRUD: Delete a productObject_DELETEProduct | DELETE | |
CRUD: Retrieve a productObject_GETProduct | GET | |
CRUD: Update a productObject_PUTProduct | PUT |
Product Charge Definition7
Create a product charge definitionPOST_CreateProductChargeDefinition | POST | Creates a product charge definition for a charge. |
Create product charge definitionsPOST_CreateProductChargeDefinitionBulk | POST | Bulk creates product charge definitions for a charge. |
Delete a product charge definitionDELETE_ProductChargeDefnition | DELETE | Deletes a product charge definition. |
List product charge definitionsGET_RetrieveProductChargeDefinitions | GET | Retrieves basic information about the product charge definitions. |
Retrieve a product charge definitionGET_RetrieveProductChargeDefinition | GET | Retrieves basic information about a product charge definition. |
Update a product charge definitionPUT_UpdateProductChargeDefinition | PUT | Update a product charge definition. |
Update product charge definitionsPUT_UpdateProductChargeDefinitionBulk | PUT | Bulk updates multiple product charge definitions. |
Product Rate Plan7
CRUD: Create a product rate planObject_POSTProductRatePlan | POST | Retrieves a product rate plan. |
CRUD: Delete a product rate planObject_DELETEProductRatePlan | DELETE | Deletes a product rate plan. |
CRUD: Retrieve a product rate planObject_GETProductRatePlan | GET | Retrieves a product rate plan. |
CRUD: Update a product rate planObject_PUTProductRatePlan | PUT | Updates a product rate plan. |
List all product rate plans of a productGET_ProductRatePlans | GET | Retrieves information about all product rate plans of a specific product. |
List product rate plans by external IDGET_ProductRatePlansByExternalID | GET | Retrieves information about one or multiple product rate plans by external ID. |
Retrieve a product rate plan by IDGET_ProductRatePlan | GET | Retrieves a product rate plan by its ID. |
Product Rate Plan Charge5
CRUD: Create a product rate plan chargeObject_POSTProductRatePlanCharge | POST | Creates a product rate plan charge for a specified rate plan charge. |
CRUD: Delete a product rate plan chargeObject_DELETEProductRatePlanCharge | DELETE | Deletes a product rate plan charge. |
CRUD: Retrieve a product rate plan chargeObject_GETProductRatePlanCharge | GET | |
CRUD: Update a product rate plan chargeObject_PUTProductRatePlanCharge | PUT | Updates the information about a product rate plan charge. |
Retrieve a product rate plan chargeGET_RetrieveProductRatePlanCharge | GET | Retrieves basic information about a product rate plan charge. |
Product Rate Plan Charge Tier2
CRUD: Retrieve a product rate plan charge tierObject_GETProductRatePlanChargeTier | GET | |
CRUD: Update a product rate plan charge tierObject_PUTProductRatePlanChargeTier | PUT | Updates the price of a product rate plan charge tier. |
Product Rate Plan Definition4
Create a product rate plan definitionPOST_CreateProductRatePlanDefinition | POST | Creates a product rate plan definition to use a charge in a product rate plan. |
Delete a product rate plan definitionDELETE_ProductRatePlanDefnition | DELETE | Deletes a product rate plan definition. |
List product rate plan definitionsGET_RetrieveProductRatePlanDefinitions | GET | Retrieves basic information about the product rate plan definitions for a product rate plan. |
Retrieve a product rate plan definitionGET_RetrieveProductRatePlanDefinition | GET | Retrieves basic information about a product rate plan definition. |
Ramp5
List all ramp metrics of a rampGET_RampMetricsByRampNumber | GET | Note : This operation is only available if you have the Ramps feature enabled. |
List ramp metrics by order numberGET_RampMetricsByOrderNumber | GET | Note : This operation is only available if you have the Ramps feature enabled. |
List ramp metrics by subscription keyGET_RampMetricsBySubscriptionKey | GET | Note : This operation is only available if you have the Ramps feature enabled. |
Retrieve a rampGET_RampByRampNumber | GET | Note : This operation is only available if you have the Ramps feature enabled. |
Retrieve a ramp by subscription keyGET_RampsBySubscriptionKey | GET | Note : This operation is only available if you have the Ramps feature enabled. |
Rate Plan1
Retrieve a rate planGET_RatePlan | GET | Retrieves the detailed information about a specific subscription rate plan. |
Refund9
Cancel a refundPUT_CancelRefund | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Delete a refundDELETE_Refund | DELETE | Note: This operation is only available if you have Invoice Settlement enabled. |
List all parts of a refundGET_RefundParts | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
List all refund part itemsGET_RefundItemParts | GET | Note: This operation is only available if you have the Invoice Item Settlement feature enabled. |
List refundsGET_Refunds | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
Retrieve a refundGET_Refund | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
Retrieve a refund partGET_RefundPart | GET | Note: This operation is only available if you have Invoice Settlement enabled. |
Retrieve a refund part itemGET_RefundItemPart | GET | Note: This operation is only available if you have the Invoice Item Settlement feature enabled. |
Update a refundPUT_UpdateRefund | PUT | Note: This operation is only available if you have Invoice Settlement enabled. |
Regenerate4
Regenerate billing transactionsPOST_RegenerateBillingTransaction | POST | Use this operation to generate billing transactions. |
Regenerate booking transactionsPOST_RegenerateBookingTransaction | POST | Use this operation to generate booking transactions. |
Regenerate revenue recognition events transactions for DailyPOST_GenerateRevRecEventsForDailyConsumption | POST | Use 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_CreateRevRecEvents | POST | Use this operation to generate Delivery Schedule based revenue recognition events transactions. |
RSA Signature2
Decrypt an RSA signaturePOST_DecryptRSASignatures | POST | The 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_RSASignatures | POST | The 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_SequenceSets | POST | Creates sequence sets, allowing distinct numbering sequences for billing documents, payments, and refunds. |
Delete a sequence setDELETE_SequenceSet | DELETE | Deletes a specific sequence set configured for billing documents, payments, and refunds. |
List sequence setsGET_SequenceSets | GET | Retrieves information about all sequence sets configured for billing documents, payments, and refunds. |
Retrieve a sequence setGET_SequenceSet | GET | Retrieves information about a specific sequence set configured for billing documents, payments, and refunds. |
Update a sequence setPUT_SequenceSet | PUT | Updates a specific sequence set configured for billing documents, payments, and refunds. |
Setting2
List all settingsGET_ListAllSettings | GET | Get a list of all available settings in your tenant. |
Submit settings requestsPOST_ProcessSettingsBatchRequest | POST | Submit a batch of settings requests by this single API operation. |
Sign Up1
Sign upPOST_SignUp | POST | This call performs many actions. |
Subscription12
Cancel a subscriptionPUT_CancelSubscription | PUT | This REST API reference describes how to cancel an active subscription. |
Create a subscriptionPOST_Subscription | POST | This REST API reference describes how to create a new subscription for an existing customer account. |
Delete a subscription by numberPUT_DeleteSubscription | PUT | This REST API reference describes how to delete a subscription of the specified subscription number. |
List subscriptions by account keyGET_SubscriptionsByAccount | GET | Retrieves all subscriptions associated with the specified account. |
Preview a subscriptionPOST_PreviewSubscription | POST | The REST API reference describes how to create a new subscription in preview mode. |
Renew a subscriptionPUT_RenewSubscription | PUT | Renews a termed subscription using existing renewal terms. |
Resume a subscriptionPUT_ResumeSubscription | PUT | This REST API reference describes how to resume a suspended subscription. |
Retrieve a subscription by keyGET_SubscriptionsByKey | GET | This REST API reference describes how to retrieve detailed information about a specified subscription in the latest version. |
Retrieve a subscription by key and versionGET_SubscriptionsByKeyAndVersion | GET | This REST API reference describes how to retrieve detailed information about a specified subscription in a specified version. |
Suspend a subscriptionPUT_SuspendSubscription | PUT | This REST API reference describes how to suspend an active subscription. |
Update a subscriptionPUT_Subscription | PUT | 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... |
Update subscription custom fields of a subscription versionPUT_UpdateSubscriptionCustomFieldsOfASpecifiedVersion | PUT | Updates the custom fields of a specified subscription version. |
Summary Journal Entry6
Cancel a summary journal entryPUT_SummaryJournalEntry | PUT | This reference describes how to cancel a summary journal entry using the REST API. |
Create a summary journal entryPOST_SummaryJournalEntry | POST | This REST API reference describes how to manually create a summary journal entry. |
Delete a summary journal entryDELETE_SummaryJournalEntry | DELETE | This reference describes how to delete a summary journal entry using the REST API. |
List all summary journal entries in a journal runGET_AllSummaryJournalEntries | GET | This REST API reference describes how to retrieve information about all summary journal entries in a journal run. |
Retrieve a summary journal entryGET_SummaryJournalEntry | GET | This REST API reference describes how to get information about a summary journal entry by its journal entry number. |
Update a summary journal entryPUT_BasicSummaryJournalEntry | PUT | This REST API reference describes how to update the basic information of a summary journal entry. |
Taxation Item4
CRUD: Create a taxation itemObject_POSTTaxationItem | POST | |
Delete a taxation itemDELETE_TaxationItem | DELETE | Deletes a specific taxation item by ID. |
Retrieve a taxation itemGET_TaxationItem | GET | Retrieves the information about a specific taxation item by ID. |
Update a taxation itemPUT_TaxationItem | PUT | Updates a specific taxation item by ID. |
Usage7
CRUD: Create a usage recordObject_POSTUsage | POST | |
CRUD: Delete a usage recordObject_DELETEUsage | DELETE | |
CRUD: Retrieve a usage recordObject_GETUsage | GET | |
CRUD: Update a usage recordObject_PUTUsage | PUT | |
Retrieve a usage recordGET_Usage | GET | This 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_Item | GET | Use 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_Usage | POST | This REST API reference describes how to post or import usage data for one or more accounts in the CSV format. |
Workflow16
Delete a workflowDELETE_Workflow | DELETE | Deletes a specific workflow by its ID. |
Delete a workflow versionDELETE_WorkflowVersion | DELETE | Delete a workflow version based on the version id. |
Export a workflow versionGET_WorkflowExport | GET | Exports a workflow version into a JSON file. |
Import a workflowPOST_WorkflowImport | POST | Create a new workflow definition and its first version using the exported JSON document of an existing workflow version. |
Import a workflow versionPOST_WorkflowVersionsImport | POST | Create 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_WorkflowVersions | GET | Return a list of all workflow versions under a workflow definition |
List workflow tasksGET_WorkflowsTasks | GET | Retrieves a list of workflow tasks available in your Zuora tenant. |
List workflowsGET_Workflows | GET | Retrieves a list of workflow definitions available in your Zuora tenant. |
Rerun a workflow taskPOST_WorkflowsTaskRerun | POST | Reruns a specific workflow task by its ID. |
Retrieve a workflowGET_Workflow | GET | Retrieves information about a specific workflow by its ID. |
Retrieve a workflow runGET_Workflow_Run | GET | Retrieves information about a specific workflow run by its ID. |
Retrieve a workflow taskGET_WorkflowsTask | GET | Retrieves a specific workflow task by its ID. |
Retrieve workflow task usageGET_WorkflowsUsages | GET | Gets workflow task usage sorted by day within a specified time frame. |
Run a workflowPOST_Run_Workflow | POST | Run a specified workflow. |
Update a workflowPATCH_UpdateWorkflow | PATCH | Updates a specific workflow by its ID, which allows you to configure the settings of a workflow via API. |
Update workflow tasksPUT_WorkflowsTasksUpdate | PUT | Updates a group of workflow tasks. |
Zuora Revenue Integration1
Update a Zuora Revenue accounting codePUT_RevProAccountingCodes | PUT | Update the Zuora Revenue accounting code that corresponds to a specific Product Rate Plan Charge Id in Zuora Billing. |