API Reference: Billing
Introduction Welcome to the reference for the Zuora Billing REST API! To learn about the common use cases of Zuora Billing REST APIs, check out the [API…
Finance & banking#openapi#financial
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Introduction
Welcome to the reference for the Zuora Billing REST API!
To learn about the common use cases of Zuora Billing REST APIs, check out the API Guides.
In addition to Zuora API Reference; Billing, we also provide API references for other Zuora products:
The Zuora REST API provides a broad set of operations and resources that:
- Enable Web Storefront integration from your website.
- Support self-service subscriber sign-ups and account management.
- Process revenue schedules through custom revenue rule models.
- Enable manipulation of most objects in the Zuora Billing Object Model.
Want to share your opinion on how our API works for you? Tell us how you feel about using our API and what we can do to make it better.
Access to the API
If you have a Zuora tenant, you can access the Zuora REST API via one of the following endpoints:
| Tenant | Base URL for REST Endpoints |
|---|---|
| US Production | https://rest.zuora.com |
| US API Sandbox | https://rest.apisandbox.zuora.com |
| US Performance Test | https://rest.pt1.zuora.com |
| US Production Copy | Submit a request at Zuora Global Support to enable the Zuora REST API in your tenant and obtain the base URL for REST endpoints. See REST endpoint base URL of Production Copy (Service) Environment for existing and new customers for more information. |
| US Cloud Production | https://rest.na.zuora.com |
| US Cloud API Sandbox | https://rest.sandbox.na.zuora.com |
| US Central Sandbox | https://rest.test.zuora.com |
| EU Production | https://rest.eu.zuora.com |
| EU API Sandbox | https://rest.sandbox.eu.zuora.com |
| EU Central Sandbox | https://rest.test.eu.zuora.com |
The Production endpoint provides access to your live user data. Sandbox tenants are a good place to test code without affecting real-world data. If you would like Zuora to provision a Sandbox tenant for you, contact your Zuora representative for assistance.
If you do not have a Zuora tenant, go to https://www.zuora.com/resource/zuora-test-drive and sign up for a Production Test Drive tenant. The tenant comes with seed data, including a sample product catalog.
API Changelog
You can find the Changelog of the API Reference: Billing in the Zuora Community.
Authentication
OAuth v2.0
Zuora recommends that you use OAuth v2.0 to authenticate to the Zuora REST API. Currently, OAuth is not available in every environment. See Zuora Testing Environments for more information.
Zuora recommends you to create a dedicated API user with API write access on a tenant when authenticating via OAuth, and then create an OAuth client for this user. See Create an API User for how to do this. By creating a dedicated API user, you can control permissions of the API user without affecting other non-API users.
If a user is deactivated, all of the user's OAuth clients will be automatically deactivated.
Authenticating via OAuth requires the following steps:
- Create a Client
- Generate a Token
- Make Authenticated Requests
Create a Client
You must first create an OAuth client in the Zuora UI. To do this, you must be an administrator of your Zuora tenant. This is a one-time operation. You will be provided with a Client ID and a Client Secret. Please note this information down, as it will be required for the next step.
Note: The OAuth client will be owned by a Zuora user account. If you want to perform PUT, POST, or DELETE operations using the OAuth client, the owner of the OAuth client must have a Platform role that includes the "API Write Access" permission.
Generate a Token
After creating a client, you must make a call to obtain a bearer token using the Generate an OAuth token operation. This operation requires the following parameters:
client_id- the Client ID displayed when you created the OAuth client in the previous stepclient_secret- the Client Secret displayed when you created the OAuth client in the previous stepgrant_type- must be set toclient_credentials
Note: The Client ID and Client Secret mentioned above were displayed when you created the OAuth Client in the prior step. The Generate an OAuth token response specifies how long the bearer token is valid for. You should reuse the bearer token until it is…
Endpoints 400
Actions
- POSTAmend
/v1/action/amend?rejectUnknownFields=falseModifies a subscription by creating Amendment objects. However, to modify a subscription, Zuora recommends that you use Update subscription instead of this… - POSTCreate
/v1/action/create?rejectUnknownFields=falseUse the create call to create one or more objects of a specific type. You can specify different types in different create calls, but each create call must… - POSTDelete
/v1/action/delete?rejectUnknownFields=falseDeletes one or more objects of the same type. You can specify different types in different delete calls, but each delete call must apply only to one type of… - POSTExecute
/v1/action/execute?rejectUnknownFields=falseUse the execute call to execute a process to split an invoice into multiple invoices. The original invoice must be in draft status. The resulting invoices are… - POSTGenerate
/v1/action/generate?rejectUnknownFields=falseGenerates an on-demand invoice for a specific customer. This is similar to creating an ad-hoc bill run for a specific customer account in the Zuora UI. *… - POSTQuery
/v1/action/query?rejectUnknownFields=falseThe 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… - POSTQueryMore
/v1/action/queryMore?rejectUnknownFields=falseUse queryMore to request additional results from a previous query call. If your initial query call returns more than 2000 results, you can use queryMore to… - POSTSubscribe
/v1/action/subscribe?rejectUnknownFields=falseThis call performs many actions. Use the subscribe call to bundle information required to create at least one new subscription. The call takes in an array of… - POSTUpdate
/v1/action/update?rejectUnknownFields=falseUpdates the information in one or more objects of the same type. You can specify different types of objects in different update calls, but each specific…
Accounting Codes
- GETList all accounting codes
/v1/accounting-codes?pageSize=300This reference describes how to query all accounting codes in your chart of accounts through the REST API. - POSTCreate an accounting code
/v1/accounting-codesThis reference describes how to create a new accounting code through the REST API. The accounting code will be active as soon as it has been created.… - GETRetrieve an accounting code
/v1/accounting-codes/:ac-idThis reference describes how to query an accounting code through the REST API. - PUTUpdate an accounting code
/v1/accounting-codes/:ac-idThis reference describes how to update an existing accounting code through the REST API. Prerequisites If you have Zuora Finance enabled on your tenant, you… - DELETEDelete an accounting code
/v1/accounting-codes/:ac-idThis reference describes how to delete an accounting code through the REST API. Prerequisites If you have Zuora Finance enabled on your tenant, then you must… - PUTActivate an accounting code
/v1/accounting-codes/:ac-id/activateThis reference describes how to activate an accounting code through the REST API. Prerequisites If you have Zuora Finance enabled on your tenant, you must… - PUTDeactivate an accounting code
/v1/accounting-codes/:ac-id/deactivateThis reference describes how to deactivate an accounting code through the REST API. Prerequisites If you have Zuora Finance enabled on your tenant, you must…
Accounting Periods
- GETList all accounting periods
/v1/accounting-periods?pageSize=300Retrieves all accounting periods on your tenant. - POSTCreate an accounting period
/v1/accounting-periodsCreates an accounting period. Prerequisites * You must have Zuora Finance enabled on your tenant. * You must have the Create Accounting Period user… - GETRetrieve an accounting period
/v1/accounting-periods/:ap-idRetrieves an accounting period. Prerequisites You must have Zuora Finance enabled on your tenant. - PUTUpdate an accounting period
/v1/accounting-periods/:ap-idUpdates an accounting period. Prerequisites * You must have Zuora Finance enabled on your tenant. * You must have the Create Accounting Period user… - DELETEDelete an accounting period
/v1/accounting-periods/:ap-idDeletes an accounting period. Prerequisites * You must have Zuora Finance enabled on your tenant. * You must have the Delete Accounting Period user… - PUTClose an accounting period
/v1/accounting-periods/:ap-id/closeClose an accounting period by accounting period ID. Prerequisites You must have Zuora Finance enabled on your tenant. You must have the Manage Close Process… - PUTSet an accounting period to pending close
/v1/accounting-periods/:ap-id/pending-closeSets an accounting period to pending close. Prerequisites * You must have Zuora Finance enabled on your tenant. * You must have the Manage Close Process and… - PUTReopen an accounting period
/v1/accounting-periods/:ap-id/reopenRe-opens an accounting period. Prerequisites * You must have Zuora Finance enabled on your tenant. * You must have the Manage Close Process and Run Trial… - PUTRun trial balance
/v1/accounting-periods/:ap-id/run-trial-balanceRuns the trial balance for an accounting period. Prerequisites * You must have Zuora Finance enabled on your tenant. * You must have the Manage Close Process…
Accounts
- POSTCreate an account
/v1/accountsCreates a customer account with a payment method, a bill-to contact, and an optional sold-to contact. Request and response field descriptions and sample code… - GETRetrieve an account
/v1/accounts/:account-keyRetrieves basic information about a customer account. This operation is a quick retrieval that doesn't include the account's subscriptions, invoices,… - PUTUpdate an account
/v1/accounts/:account-keyUpdates a customer account by specifying the account-key. Notes 1. Only the fields to be changed should be specified. Any field that is not included in the… - GETRetrieve an account summary
/v1/accounts/:account-key/summaryRetrieves detailed information about the specified customer account. The response includes the account information and a summary of the account’s… - POSTCRUD: Create an account
/v1/object/account?rejectUnknownFields=falseCreates an account without creating any associated objects such as subscriptions. - GETCRUD: Retrieve an account
/v1/object/account/:id?fields=stringRetrieves the information about one specific account. - PUTCRUD: Update an account
/v1/object/account/:id?rejectUnknownFields=falseUpdates an account. - DELETECRUD: Delete an account
/v1/object/account/:idDeletes a specific account asynchronously. Note: When Orders is enabled, before deleting a customer account, you must delete all related orders and…
Amendments
- GETList all amendments of a subscription
/v1/amendments/subscriptions/:subscription-idRetrieves detailed information about the amendment with the specified subscription. - GETRetrieve an amendment
/v1/amendments/:amendment-keyRetrieves detailed information about the specified subscription amendment. - GETCRUD: Retrieve an amendment
/v1/object/amendment/:id?fields=string - PUTCRUD: Update an amendment
/v1/object/amendment/:id?rejectUnknownFields=false - DELETECRUD: Delete an amendment
/v1/object/amendment/:idInvoiced amendments cannot usually be deleted. One exception to this rule is auto-renew amendments. You can delete the last auto-renew amendment even if an…
Attachments
- POSTCreate an attachment
/v1/attachments?description=string&associatedObjectType=Account&associatedObjectKey=stringUse 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… - GETRetrieve an attachment
/v1/attachments/:attachment-idUse the View Attachment REST request to retrieve information about an attachment document. - PUTUpdate an attachment
/v1/attachments/:attachment-idUse the Edit Attachment REST request to make changes to the descriptive fields of an attachment, such as the description and the file name. You cannot change… - DELETEDelete an attachment
/v1/attachments/:attachment-idUse the Delete Attachment REST request to delete an attachment from a Zuora object. - GETList attachments by object type and key
/v1/attachments/:object-type/:object-key?pageSize=20Use 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. Note: The Credit…
Bill Run
- POSTEmail billing documents generated from a bill run
/v1/bill-runs/:billRunId/emailsManually emails all the billing documents that are generated from a specified bill run to your customers. Bill runs can generate invoices and credit memos… - POSTCRUD: Create a bill run
/v1/object/bill-run?rejectUnknownFields=falseCreates an ad hoc bill run or a single account or multiple customer accounts. When creating a single account ad hoc bill run, your request must include… - GETCRUD: Retrieve a bill run
/v1/object/bill-run/:id?fields=stringRetrieves information about a bill run. Business operations depending on the completion of the bill run will not be available while the bill run query returns… - PUTCRUD: Post or cancel a bill run
/v1/object/bill-run/:id?rejectUnknownFields=falsePosts or cancels a bill run. Post a Bill Run Posting a bill run is an asynchronous operation. To post a bill run, the current bill run must have a status of… - DELETECRUD: Delete a bill run
/v1/object/bill-run/:idDeletes a bill run. When deleting a bill run, the logic is the same as when using the UI to delete a bill run. The only required parameter is BillRunId. The…
Billing Documents
- POSTCreate a job to hard delete billing document files
/v1/accounts/billing-documents/files/deletion-jobsCreates an asynchronous job to permanently delete all billing document PDF files for specific accounts. After the deletion job is completed, all billing… - GETRetrieve a job of hard deleting billing document files
/v1/accounts/billing-documents/files/deletion-jobs/:jobIdRetrieves information about an asynchronous job of permanently deleting all billing document PDF files for specific accounts. Note: This operation can be used… - POSTGenerate billing documents by account ID
/v1/accounts/:id/billing-documents/generateGenerates draft or posted billing documents for a specified account. You can also generate billing documents for specified subscriptions of a specified… - GETList billing documents for an account
/v1/billing-documents?pageSize=20&accountId=3fa85f64-5717-4562-b3fc-2c963f66afa6&documentDate=2024-01-01&status=Draft&sort=stringRetrieves the information about all billing documents associated with a specified account. The billing documents contain invoices, credit memos, and debit…
Billing Preview Run
- POSTCreate a billing preview run
/v1/billing-preview-runsCreates a billing preview run for multiple customer accounts. You can run up to 20 billing preview runs in batches concurrently. A single batch of customer… - GETRetrieve a billing preview run
/v1/billing-preview-runs/:billingPreviewRunIdRetrieves a preview of future invoice items for multiple customer accounts through a billing preview run. If you have the Invoice Settlement feature enabled,…
Catalog
- GETRetrieve a product
/v1/catalog/product/:product-idRetrieves detailed information about a specific product, including information about its product rate plans and charges. - GETList all products
/v1/catalog/products?page=1&pageSize=10Retrieves the entire product catalog, including all products, features, and their corresponding product rate plans, charges. Products are returned in reverse… - POSTMulti-entity: Share a product with an entity
/v1/catalog/products/:product-id/shareNote: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Shares a…
Charge Metrics
- GETList charge metrics by time range
/charge-metrics/data/charge-metrics?fromTimestamp=2024-01-01T00:00:00Z&toTimestamp=2024-01-01T00:00:00ZRetrieves key charge metrics about rate plan charges that have changes in a specified time range. The purpose of fromTimestamp and toTimestamp is to… - GETList discount allocation details by time range
/charge-metrics/data/charge-metrics-discount-allocation-detail?fromTimestamp=2024-01-01T00:00:00Z&toTimestamp=2024-01-01T00:00:00ZRetrieves discount allocation details about rate plan charges that have changes in a specified time range. The purpose of fromTimestamp and toTimestamp is to…
Charge Revenue Summaries
- GETRetrieve a charge revenue summary by charge ID
/v1/charge-revenue-summaries/subscription-charges/:charge-keyRetrieves the details of a charge revenue summary by specifying the subscription charge ID. This response retrieves all revenue items associated with a charge… - GETList all details of a charge revenue summary
/v1/charge-revenue-summaries/:crs-numberRetrieves the details of a charge revenue summary by specifying the charge revenue summary number. The response includes all revenue items associated with the…
Communication Profiles
- GETCRUD: Retrieve a communication profile
/v1/object/communication-profile/:id?fields=string
Connections
- POSTEstablish a connection to Zuora REST API
/v1/connectionsEstablishes a connection to the Zuora REST API service based on a valid user credentials. Note:This is a legacy REST API. Zuora recommends you to use OAuth…
Contacts
- PUTScrub a contact
/v1/contacts/:contactId/scrubScrubs the sensitive data of a specific contact. You can use this operation to replace all sensitive data in a contact and its related contact snapshot with… - POSTCRUD: Create a contact
/v1/object/contact?rejectUnknownFields=falseCreates a contact for a specified account. - GETCRUD: Retrieve a contact
/v1/object/contact/:id?fields=stringRetrieves detailed information about a specific contact. - PUTCRUD: Update a contact
/v1/object/contact/:id?rejectUnknownFields=falseUpdates a contact for a specified account. You can update contacts for cancelled accounts. For a use case of this operation, see Edit the contact information… - DELETECRUD: Delete a contact
/v1/object/contact/:idDeletes a contact.
Credit Balance Adjustments
- POSTCRUD: Create a credit balance adjustment
/v1/object/credit-balance-adjustment?rejectUnknownFields=false - GETCRUD: Retrieve a credit balance adjustment
/v1/object/credit-balance-adjustment/:id?fields=string - PUTCRUD: Update a credit balance adjustment
/v1/object/credit-balance-adjustment/:id?rejectUnknownFields=false
Credit Memos
- GETList credit memos
/v1/creditmemos?pageSize=20&accountId=string&amount=0.0&appliedAmount=0.0&autoApplyUponPosting=true&createdById=string&createdDate=2024-01-01T00:00:00Z&creditMemoDate=2024-01-01¤cy=string&excludeFromAutoApplyRules=true&number=string&referredInvoiceId=string&refundAmount=0.0&status=Draft&targetDate=2024-01-01&taxAmount=0.0&totalTaxExemptAmount=0.0&transferredToAccounting=Processing&unappliedAmount=0.0&updatedById=string&updatedDate=2024-01-01T00:00:00Z&sort=stringNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTCreate a credit memo from a charge
/v1/creditmemosNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETRetrieve a credit memo
/v1/creditmemos/:creditMemoIdNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTUpdate a credit memo
/v1/creditmemos/:creditMemoIdNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - DELETEDelete a credit memo
/v1/creditmemos/:creditMemoIdNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTApply a credit memo
/v1/creditmemos/:creditMemoId/applyNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTCancel a credit memo
/v1/creditmemos/:creditMemoId/cancelNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTEmail a credit memo
/v1/creditmemos/:creditMemoId/emailsNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTUpload a file for a credit memo
/v1/creditmemos/:creditMemoId/filesNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETList credit memo items
/v1/creditmemos/:creditMemoId/items?pageSize=20&amount=0.0&appliedAmount=0.0&createdById=string&createdDate=2024-01-01T00:00:00Z&id=string&refundAmount=0.0&serviceEndDate=2024-01-01&serviceStartDate=2024-01-01&sku=string&skuName=string&sourceItemId=string&subscriptionId=string&updatedById=string&updatedDate=2024-01-01T00:00:00Z&sort=stringNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETRetrieve a credit memo item
/v1/creditmemos/:creditMemoId/items/:cmitemidNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETList all taxation items of a credit memo item
/v1/creditmemos/:creditMemoId/items/:cmitemid/taxation-items?pageSize=20&page=1Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETList all parts of a credit memo
/v1/creditmemos/:creditMemoId/parts?pageSize=20Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETRetrieve a credit memo part
/v1/creditmemos/:creditMemoId/parts/:partidNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETList all credit memo part items
/v1/creditmemos/:creditMemoId/parts/:partid/itemparts?pageSize=20Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETRetrieve a credit memo part item
/v1/creditmemos/:creditMemoId/parts/:partid/itemparts/:itempartidNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTGenerate a credit memo PDF file
/v1/creditmemos/:creditMemoId/pdfsNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTPost a credit memo
/v1/creditmemos/:creditMemoId/postNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTCreate taxation items for a credit memo
/v1/creditmemos/:creditMemoId/taxationitemsNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTUnapply a credit memo
/v1/creditmemos/:creditMemoId/unapplyNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTUnpost a credit memo
/v1/creditmemos/:creditMemoId/unpostNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTRefund a credit memo
/v1/creditmemos/:creditmemoId/refundsNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing…
Custom Exchange Rates
- GETList custom exchange rates by currency
/v1/custom-exchange-rates/:currency?startDate=string&endDate=stringThis feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. This reference describes how to…
Custom Object Definitions
- GETList custom object definitions
/objects/definitions/default?select=typeGet all custom objects definitions for a given tenant. If you want to copy all the existing custom objects from an old tenant to a new tenant, you can call… - POSTCreate custom object definitions
/objects/definitions/defaultYou can post custom object definitions with the request body schema described below. This operation also allows you to use the List custom object definitions… - GETRetrieve a custom object definition
/objects/definitions/default/:objectRetrieves the custom object definition by type for the given tenant. - DELETEDelete a custom object definition
/objects/definitions/default/:objectDeletes the custom object definition for the provided type. Note: A custom object definition can only be deleted if no record of this custom object type exists. - POSTUpdate a custom object definition
/objects/migrationsUpdates a custom object definition by posting migration resource to initiate the migration of definitions. Limitations Updating custom field definition has…
Custom Object Records
- POSTUpdate or delete custom object records
/objects/batch/default/:objectMakes a batch update or delete of custom object records. Limitations This call has the following limitations: * The maximum number of records that you can… - GETList records for a custom object
/objects/records/default/:object?q=string&ids=string&pageSize=0&cursor=stringLists all object records of the given type. You can also use the q query parameter to filter the output records. Limitations This call has the following… - POSTCreate custom object records
/objects/records/default/:objectCreates custom object records with the given type. Upon creating records of a custom object type, the 200 response contains a list of records that have been… - GETRetrieve a custom object record
/objects/records/default/:object/:idRetrieves a record of a given type by ID. - PUTUpdate a custom object record
/objects/records/default/:object/:idUpdates a record of the given type and ID. Limitations * The storage of empty strings in records is not supported. * Null values must be formatted as the… - DELETEDelete a custom object record
/objects/records/default/:object/:idDeletes a custom object record of the given type and ID. Note that 200 response will be returned under either of the following conditions: * The record is… - PATCHPartially update a custom object record
/objects/records/default/:object/:idUpdates one or many fields of a custom object record. Patch update uses JSON Merge Patch as specified in RFC 7386. Limitations * The storage of empty strings…
Custom Object Jobs
- GETList all custom object bulk jobs
/objects/jobs?pageSize=0&cursor=stringLists all custom object bulk jobs submitted by your tenant. - POSTSubmit a custom object bulk job
/objects/jobsSubmits a bulk job request for a bulk operation on the specified custom object records. A succcessful call returns a newly created bulk job. The job ID can be… - GETRetrieve a custom object bulk job
/objects/jobs/:idRetrieves the custom object bulk job details by job ID. Only the users that have the "View Custom Objects" permission can retrieve custom object bulk jobs.… - GETList all errors for a custom object bulk job
/objects/jobs/:id/errorsLists all errors for a custom object bulk job. - POSTUpload a file for a custom object bulk job
/objects/jobs/:id/filesUploads a file to a create custom object bulk job. Only one file is allowed per job. The job must be in pending status when you upload the file to it. The job…
Data Queries
- GETList data query jobs
/query/jobs?queryStatus=accepted&pageSize=20Returns a list of data query jobs that have been created in your Zuora tenant. You can filter the list by status. If you are an administrator, you can… - POSTSubmit a data query
/query/jobsSubmits a data query to be performed by Zuora and creates a query job. You can use Retrieve a data query job to track the status of the query job and obtain… - GETRetrieve a data query job
/query/jobs/:job-idRetrieves a data query job. You can use this operation to track the status of the query job and obtain the URL of the query results. If you are an… - DELETECancel a data query job
/query/jobs/:job-idCancels a data query job, which prevents Zuora from performing the query. This operation is only applicable if the status of the query job is accepted or…
Debit Memos
- GETList debit memos
/v1/debitmemos?pageSize=20&accountId=string&amount=0.0&balance=0.0&beAppliedAmount=0.0&createdById=string&createdDate=2024-01-01T00:00:00Z¤cy=string&debitMemoDate=2024-01-01&dueDate=2024-01-01&number=string&referredInvoiceId=string&status=Draft&targetDate=2024-01-01&taxAmount=0.0&totalTaxExemptAmount=0.0&updatedById=string&updatedDate=2024-01-01T00:00:00Z&sort=stringNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTUpdate debit memos
/v1/debitmemosNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTCreate a debit memo from a charge
/v1/debitmemosNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETRetrieve a debit memo
/v1/debitmemos/:debitMemoIdNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTUpdate a debit memo
/v1/debitmemos/:debitMemoIdNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - DELETEDelete a debit memo
/v1/debitmemos/:debitMemoIdNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETList all application parts of a debit memo
/v1/debitmemos/:debitMemoId/application-partsNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTCancel a debit memo
/v1/debitmemos/:debitMemoId/cancelNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTCollect a posted debit memo
/v1/debitmemos/:debitMemoId/collectNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTEmail a debit memo
/v1/debitmemos/:debitMemoId/emailsNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTUpload a file for a debit memo
/v1/debitmemos/:debitMemoId/filesNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETList debit memo items
/v1/debitmemos/:debitMemoId/items?pageSize=20&amount=0.0&beAppliedAmount=0.0&createdById=string&createdDate=2024-01-01T00:00:00Z&id=string&serviceEndDate=2024-01-01&serviceStartDate=2024-01-01&sku=string&skuName=string&sourceItemId=string&subscriptionId=string&updatedById=string&updatedDate=2024-01-01T00:00:00Z&sort=stringNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETRetrieve a debit memo item
/v1/debitmemos/:debitMemoId/items/:dmitemidNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETList all taxation items of a debit memo item
/v1/debitmemos/:debitMemoId/items/:dmitemid/taxation-items?pageSize=20&page=1Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTGenerate a debit memo PDF file
/v1/debitmemos/:debitMemoId/pdfsNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTPost a debit memo
/v1/debitmemos/:debitMemoId/postNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTCreate taxation items for a debit memo
/v1/debitmemos/:debitMemoId/taxationitemsNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTUnpost a debit memo
/v1/debitmemos/:debitMemoId/unpostNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing…
Describe
- GETDescribe an object
/v1/describe/:objectProvides a reference listing of each object that is available in your Zuora tenant. The information returned by this call is useful if you are using CRUD:…
Document Properties
- POSTCreate document properties
/v1/document-propertiesNote: This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in… - PUTUpdate document properties
/v1/document-properties/:documentPropertiesIdNote: This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in… - DELETEDelete document properties
/v1/document-properties/:documentPropertiesIdNote: This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in… - GETList all properties of a billing document
/v1/document-properties/:documentType/:documentIdNote: This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in…
Entities
- GETMulti-entity: List entities
/v1/entities?provisioned=stringNote: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves… - POSTMulti-entity: Create an entity
/v1/entitiesNote: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Creates an… - GETMulti-entity: Retrieve an entity
/v1/entities/:idNote: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves… - PUTMulti-entity: Update an entity
/v1/entities/:idNote: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Edits the… - DELETEMulti-entity: Delete an entity
/v1/entities/:idNote: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Removes an… - PUTMulti-entity: Provision an entity
/v1/entities/:id/provisionNote: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Provisions an…
Entity Connections
- GETMulti-entity: List connections
/v1/entity-connections?pageSize=30&type=inboundNote: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves… - POSTMulti-entity: Initiate a connection request
/v1/entity-connectionsNote: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Initiates a… - PUTMulti-entity: Accept a connection request
/v1/entity-connections/:connection-id/acceptNote: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Accepts a… - PUTMulti-entity: Deny a connection request
/v1/entity-connections/:connection-id/denyNote: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Denies a… - PUTMulti-entity: Disconnect a connection
/v1/entity-connections/:connection-id/disconnectNote: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Disconnects an…
Event Triggers
- GETList event triggers
/events/event-triggers?baseObject=string&eventTypeName=string&active=string&start=0&limit=10 - POSTCreate an event trigger
/events/event-triggersWhen you create an event trigger, you must specify the base object and define the trigger condition. Specify the base object Use baseObject field to specify… - GETRetrieve an event trigger
/events/event-triggers/:id - PUTUpdate an event trigger
/events/event-triggers/:id - DELETEDelete an event trigger
/events/event-triggers/:id
Exports
- POSTCRUD: Create an export
/v1/object/export?rejectUnknownFields=falseUse this operation to create a data source export. After you have created a data source export, use CRUD: Retrieve an export to check the status of the data… - GETCRUD: Retrieve an export
/v1/object/export/:id?fields=stringUse this operation to check the status of a data source export and access the exported data. When you export data from Zuora, each exported file is available…
Features
- POSTCRUD: Create a feature
/v1/object/feature?rejectUnknownFields=false - GETCRUD: Retrieve a feature
/v1/object/feature/:id?fields=string - PUTCRUD: Update a feature
/v1/object/feature/:id?rejectUnknownFields=false - DELETECRUD: Delete a feature
/v1/object/feature/:id
Files
- GETRetrieve a file
/v1/files/:file-idRetrieve files such as export results, invoices, and accounting period reports. The response content type depends on the type of file that you retrieve. For…
HMAC Signatures
- POSTGenerate an HMAC signature
/v1/hmac-signaturesThis REST API reference describes how to return unique signature and token values that used to process a CORS enabled API call.
Hosted Pages
- GETList hosted pages
/v1/hostedpages?versionNumber=stringReturns the Payment Pages configuration metadata, specifically, page ID, page version, payment method type. The following are the version-specific and general…
Imports
- POSTCRUD: Create an import
/v1/object/import?rejectUnknownFields=falseCreates a data import. - GETCRUD: Retrieve an import
/v1/object/import/:id?fields=string
Invoice Adjustments
- POSTCRUD: Create an invoice adjustment
/v1/object/invoice-adjustment?rejectUnknownFields=false - GETCRUD: Retrieve an invoice adjustment
/v1/object/invoice-adjustment/:id?fields=string - PUTCRUD: Update an invoice adjustment
/v1/object/invoice-adjustment/:id?rejectUnknownFields=false - DELETECRUD: Delete an invoice adjustment
/v1/object/invoice-adjustment/:id
Invoice Item Adjustments
- GETCRUD: Retrieve an invoice item adjustment
/v1/object/invoice-item-adjustment/:id?fields=string - DELETECRUD: Delete an invoice item adjustment
/v1/object/invoice-item-adjustment/:id
Invoice Items
- GETCRUD: Retrieve an invoice item
/v1/object/invoice-item/:id?fields=string
Invoice Payments
- POSTCRUD: Create an invoice payment
/v1/object/invoice-payment?rejectUnknownFields=false - GETCRUD: Retrieve an invoice payment
/v1/object/invoice-payment/:id?fields=string - PUTCRUD: Update an invoice payment
/v1/object/invoice-payment/:id?rejectUnknownFields=false
Invoice Split Items
- GETCRUD: Retrieve an invoice split item
/v1/object/invoice-split-item/:id?fields=string
Invoice Splits
- GETCRUD: Retrieve an invoice split
/v1/object/invoice-split/:id?fields=string
Invoices
- PUTUpdate invoices
/v1/invoicesUpdates multiple invoices in batches with one call. Limitations This operation has the following limitations: * You can update a maximum of 50 invoices by one… - POSTCreate a standalone invoice
/v1/invoicesNote: This operation is only available if you have Unified Invoicing enabled. The Unified Invoicing feature is in the Early Adopter phase. We are actively… - PUTUpdate an invoice
/v1/invoices/:invoiceIdUpdates a specific invoice. - GETList all application parts of an invoice
/v1/invoices/:invoiceId/application-partsNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTCreate a credit memo from an invoice
/v1/invoices/:invoiceId/creditmemosNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTCreate a debit memo from an invoice
/v1/invoices/:invoiceId/debitmemosNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTEmail an invoice
/v1/invoices/:invoiceId/emailsSends a posted invoice to the specified email addresses manually. Notes You must activate the Manual Email For Invoice | Manual Email For Invoice notification… - GETList all files of an invoice
/v1/invoices/:invoiceId/files?pageSize=20Retrieves the information about all PDF files of a specified invoice. Invoice PDF files are returned in reverse chronological order by the value of the… - POSTUpload a file for an invoice
/v1/invoices/:invoiceId/filesUploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status. To use this operation, you must enable the Modify Invoice… - GETList all items of an invoice
/v1/invoices/:invoiceId/items?pageSize=20Retrieves the information about all items of a specified invoice. - GETList all taxation items of an invoice item
/v1/invoices/:invoiceId/items/:itemId/taxation-items?pageSize=20&page=1Retrieves information about the taxation items of a specific invoice item. - PUTReverse an invoice
/v1/invoices/:invoiceId/reverseNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTWrite off an invoice
/v1/invoices/:invoiceId/write-offNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETCRUD: Retrieve an invoice
/v1/object/invoice/:id?fields=string - PUTCRUD: Update an invoice
/v1/object/invoice/:id?rejectUnknownFields=false - DELETECRUD: Delete an invoice
/v1/object/invoice/:id
Journal Runs
- POSTCreate a journal run
/v1/journal-runsThis REST API reference describes how to create a journal run. Request and response field descriptions and sample code are provided. - GETRetrieve a journal run
/v1/journal-runs/:jr-numberThis REST API reference describes how to get information about a journal run. Request and response field descriptions and sample code are provided. - DELETEDelete a journal run
/v1/journal-runs/:jr-numberThis reference describes how to delete a journal run using the REST API. You can only delete journal runs that have already been canceled. You must have the… - PUTCancel a journal run
/v1/journal-runs/:jr-number/cancelThis reference describes how to cancel a journal run using the REST API. The summary journal entries in the journal run are canceled asynchronously. See the…
Mass Updater
- POSTPerform a mass action
/v1/bulkDescribes how to perform a mass action through the REST API. Using this API method, you send a multipart/form-data request containing a .csv file with data… - GETList all results of a mass action
/v1/bulk/:bulk-keyDescribes how to get information about the result of a mass action through the REST API. - PUTStop a mass action
/v1/bulk/:bulk-key/stopDescribes how to stop a mass action through the REST API. You can stop a mass action when its status is Pending or Processing. After you have stopped a mass…
Notifications
- GETList email templates
/notifications/email-templates?start=1&limit=20&eventTypeName=string&name=stringQueries email templates. Note: This operation is only applicable to email templates for custom events. - POSTCreate an email template
/notifications/email-templatesCreates an email template. Note: This operation is only applicable to email templates for custom events. - GETRetrieve an email template
/notifications/email-templates/:idQueries the email template of the specified ID. Note: This operation is only applicable to email templates for custom events. - PUTUpdate an email template
/notifications/email-templates/:idUpdates an email template. Note: This operation is only applicable to email templates for custom events. - DELETEDelete an email template
/notifications/email-templates/:idDeletes an email template. Note: This operation is only applicable to notifications for custom events. - DELETEDelete notification histories for an account
/notifications/history?accountId=3fa85f64-5717-4562-b3fc-2c963f66afa6Delete all notification histories for the given account. All email and callout notifications for this account will be deleted upon successful operation. Note:… - GETRetrieve a notification history deletion task
/notifications/history/tasks/:idGet the notification history deletion task by ID. Note: This operation is only available if you have the Notification and the Configurable Event features… - GETList notification definitions
/notifications/notification-definitions?start=1&limit=20&profileId=3fa85f64-5717-4562-b3fc-2c963f66afa6&eventTypeName=string&emailTemplateId=3fa85f64-5717-4562-b3fc-2c963f66afa6Queries notification definitions with the specified filters. Note: This operation is only applicable to notifications for custom events. - POSTCreate a notification definition
/notifications/notification-definitionsCreates a notification definition. If a filter rule is specified, it will be evaluated to see if the notification definition is qualified to handle the… - GETRetrieve a notification definition
/notifications/notification-definitions/:idQueries the notification definition of the given ID. Note: This operation is only applicable to notifications for custom events. - PUTUpdate a notification definition
/notifications/notification-definitions/:idUpdates a notification definition. Note: This operation is only applicable to notifications for custom events. - DELETEDelete a notification definition
/notifications/notification-definitions/:idDeletes a notification definition. Note: This operation is only applicable to notifications for custom events. - GETList callout notification histories
/v1/notification-history/callout?pageSize=20&endTime=2024-01-01T00:00:00Z&startTime=2024-01-01T00:00:00Z&objectId=string&failedOnly=true&eventCategory=string&includeResponseContent=trueDescribes how to get a notification history for callouts. - GETList email notification histories
/v1/notification-history/email?pageSize=20&endTime=2024-01-01T00:00:00Z&startTime=2024-01-01T00:00:00Z&objectId=string&failedOnly=true&eventCategory=stringDescribes how to get a notification history for notification emails. Notes Request parameters and their values may be appended with a "?" following the HTTPS…
OAuth
- POSTCreate an OAuth token
/oauth/tokenCreates a bearer token that enables an OAuth client to authenticate with the Zuora REST API. The OAuth client must have been created using the Zuora UI. See…
Operations
- POSTGenerate a billing preview
/v1/operations/billing-previewNote: The Billing Preview feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Generates a… - POSTInvoice and collect
/v1/operations/invoice-collectGenerates and posts invoices and credit memos and collects payments for posted invoices. Credit memos are only available if you have the Invoice Settlement…
Orders
- GETRetrieve the status and response of a job
/v1/async-jobs/:jobIdNote: This operation is only available if you have the Orders feature enabled. Orders is now generally available as of Zuora Billing Release 284 (August… - POSTCreate an order asynchronously
/v1/async/orders?returnIds=falseNote: This operation is only available if you have the Orders feature enabled. Orders is now generally available as of Zuora Billing Release 284 (August… - POSTPreview an order asynchronously
/v1/async/orders/previewNote: This operation is only available if you have the Orders feature enabled. Orders is now generally available as of Zuora Billing Release 284 (August… - GETList orders
/v1/orders?page=1&pageSize=20&dateFilterOption=string&startDate=2024-01-01&endDate=2024-01-01Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the… - POSTCreate an order
/v1/orders?returnIds=falseNote: This operation is only available if you have the Orders feature enabled. Orders is now generally available as of Zuora Billing Release 284 (August… - GETList orders of an invoice owner
/v1/orders/invoiceOwner/:accountNumber?page=0&pageSize=20&dateFilterOption=string&startDate=2024-01-01&endDate=2024-01-01Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the… - POSTPreview an order
/v1/orders/previewNote: This operation is only available if you have the Orders feature enabled. Orders is now generally available as of Zuora Billing Release 284 (August… - GETList orders by subscription number
/v1/orders/subscription/:subscriptionNumber?page=0&pageSize=20&dateFilterOption=string&startDate=2024-01-01&endDate=2024-01-01Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the… - GETList orders of a subscription owner
/v1/orders/subscriptionOwner/:accountNumber?page=0&pageSize=20&dateFilterOption=string&startDate=2024-01-01&endDate=2024-01-01Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the… - GETList subscription terms
/v1/orders/term/:subscriptionNumber?version=0&page=1&pageSize=20Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the… - GETRetrieve an order
/v1/orders/:orderNumberNote: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the… - DELETEDelete an order
/v1/orders/:orderNumberNote: This operation is only available if you have the Orders feature enabled. Orders is now generally available as of Zuora Billing Release 284 (August… - PUTUpdate order custom fields
/v1/orders/:orderNumber/customFieldsNote: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the… - GETList order metrics for an evergreen subscription
/v1/orders/:orderNumber/evergreenMetrics/:subscriptionNumber?startDate=2024-01-01&endDate=2024-01-01Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the… - PUTUpdate order action trigger dates
/v1/orders/:orderNumber/triggerDatesNote: This operation is only available if you have the Orders feature enabled. Orders is now generally available as of Zuora Billing Release 284 (August… - PUTUpdate subscription custom fields
/v1/subscriptions/:subscriptionNumber/customFieldsNote: This operation is only available if you have the Orders feature enabled. Orders is now generally available as of Zuora Billing Release 284 (August…
Order Line Items
- POSTUpdate order line items
/v1/order-line-items/bulkNote: The Order Line Items feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it… - GETRetrieve an order line item
/v1/order-line-items/:itemIdNote: The Order Line Items feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it… - PUTUpdate an order line item
/v1/order-line-items/:itemIdNote: The Order Line Items feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it…
Payment Gateways
- GETList all payment gateways
/v1/paymentgatewaysRetrieves the basic information about all the payment gateways.
Payment Gateway Reconciliation
- POSTReverse a payment
/v1/gateway-settlement/payments/:payment-id/chargebackSets the Payment status to "Reversed", creates a refund for the amount specified in the request, and returns the Refund object as response. - POSTReject a payment
/v1/gateway-settlement/payments/:payment-id/rejectSets the Payment status to "Rejected", creates a refund for the payment amount, and returns the Refund object as response. - POSTSettle a payment
/v1/gateway-settlement/payments/:payment-id/settleSets the Payment status to "Settled" and returns the Payment object as response. - POSTReconcile a refund
/v1/refunds/:refund-id/reconcileReconciles a refund when receiving the gateway reconciliation request or event.
Payment Method Snapshots
- GETCRUD: Retrieve a payment method snapshot
/v1/object/payment-method-snapshot/:id?fields=stringThis REST API reference describes how to retrieve a Payment Method Snapshot. A Payment Method Snapshot is a copy of the particular Payment Method used in a…
Payment Method Transaction Logs
- GETCRUD: Retrieve a payment method transaction log
/v1/object/payment-method-transaction-log/:id?fields=string
Payment Methods
- POSTCRUD: Create a payment method
/v1/object/payment-method?rejectUnknownFields=false - GETCRUD: Retrieve a payment method
/v1/object/payment-method/:id?fields=string - PUTCRUD: Update a payment method
/v1/object/payment-method/:id?rejectUnknownFields=falseFor a use case of this operation, see Configure Payment Methods. - DELETECRUD: Delete a payment method
/v1/object/payment-method/:id - POSTCreate a payment method
/v1/payment-methodsYou 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… - POSTCreate a credit card payment method
/v1/payment-methods/credit-cardsYou can create a credit card payment method for a customer account or an orphan credit card payment method that is not associated with any customer account.… - GETList all credit card payment methods of an account
/v1/payment-methods/credit-cards/accounts/:account-key?pageSize=20This REST API reference describes how to retrieve all credit card information for the specified customer account. Notes The response includes details of… - PUTUpdate a credit card payment method
/v1/payment-methods/credit-cards/:payment-method-idUpdates an existing credit card payment method. - POSTCreate an Apple Pay payment method
/v1/payment-methods/decryptionThe decryption API endpoint can conditionally perform 3 tasks in one atomic call: * Decrypt Apple Pay Payment token * Create Credit Card Payment Method in… - GETRetrieve a payment method
/v1/payment-methods/:payment-method-idThis operation allows you to get the detailed information about a payment method. - PUTUpdate a payment method
/v1/payment-methods/:payment-method-idThis operation allows you to update an existing payment method. The following request body fields can be updated regardless of payment method types: *… - DELETEDelete a payment method
/v1/payment-methods/:payment-method-idDeletes a credit card payment method. If the specified payment method is the account's default payment method, the request will fail. In that case, you must… - POSTCreate authorization
/v1/payment-methods/:payment-method-id/authorizeNote: If you want to enable this feature, submit a request at Zuora Global Support. Enables you to authorize the availability of funds for a transaction but… - GETList stored credential profiles of a payment method
/v1/payment-methods/:payment-method-id/profiles?includeAll=falseRetrieves the stored credential profiles within a payment method. Note: This feature is in the Early Adopters phase. We are actively soliciting feedback from… - POSTCreate a stored credential profile
/v1/payment-methods/:payment-method-id/profilesCreates a stored credential profile within a payment method. The stored credential profile represents a consent agreement that you have established with a… - POSTCancel a stored credential profile
/v1/payment-methods/:payment-method-id/profiles/:profile-number/cancelCancels a stored credential profile within a payment method. Cancelling the stored credential profile indicates that the stored credentials are no longer… - POSTExpire a stored credential profile
/v1/payment-methods/:payment-method-id/profiles/:profile-number/expireExpires a stored credential profile within a payment method. Expiring the stored credential profile indicates that the stored credentials are no longer valid,… - PUTScrub a payment method
/v1/payment-methods/:payment-method-id/scrubThis operation enables you to replace all sensitive data in a payment method, related payment method snapshot table, and four related log tables with dummy… - PUTVerify a payment method
/v1/payment-methods/:payment-method-id/verifySends an authorization request to the corresponding payment gateway to verify the payment method, even though no changes are made for the payment method.… - POSTCancel authorization
/v1/payment-methods/:payment-method-id/voidAuthorizeNote: If you wish to enable this feature, submit a request at Zuora Global Support. Allows you to cancel an authorization. The payment gateways that support…
Payment Runs
- GETList payment runs
/v1/payment-runs?pageSize=20&createdById=string&createdDate=2024-01-01T00:00:00Z&status=Pending&targetDate=2024-01-01&updatedById=string&updatedDate=2024-01-01T00:00:00Z&sort=stringRetrieves the information about all payment runs. You can define filterable fields to restrict the data returned in the response. Filtering You can use query… - POSTCreate a payment run
/v1/payment-runsCreates a payment run. You can create a payment run to be executed immediately after it is created, or a scheduled payment run to be executed in future. To… - GETRetrieve a payment run
/v1/payment-runs/:paymentRunIdRetrives the information about a specific payment run. - PUTUpdate a payment run
/v1/payment-runs/:paymentRunIdUpdates the information about an unexecuted payment run. Only pending payment runs can be updated. If none of the accountId, batch, billCycleDay, currency,… - DELETEDelete a payment run
/v1/payment-runs/:paymentRunIdDeletes a payment run. Only payment runs with the Canceled or Error status can be deleted. - GETRetrieve payment run data
/v1/payment-runs/:paymentRunId/dataRetrieves payment run data and the processing result with details, if the data field was specified in the Create payment run operation. - GETRetrieve a payment run summary
/v1/payment-runs/:paymentRunId/summaryRetrives the summary of a payment run.
Payment Transaction Logs
- GETCRUD: Retrieve a payment transaction log
/v1/object/payment-transaction-log/:idRetrieves information about a specific payment transaction log.
Payments
- POSTCRUD: Create a payment
/v1/object/payment?rejectUnknownFields=falseCreates a payment for one or multiple invoices. - GETCRUD: Retrieve a payment
/v1/object/payment/:idRetrieves the information about one specific payment. - PUTCRUD: Update a payment
/v1/object/payment/:id?rejectUnknownFields=falseUpdates a payment. - DELETECRUD: Delete a payment
/v1/object/payment/:idDeletes a payment. Only payments with the Cancelled status can be deleted. - GETList payments
/v1/payments?pageSize=20&accountId=string&amount=0.0&appliedAmount=0.0&createdById=string&createdDate=2024-01-01T00:00:00Z&creditBalanceAmount=0.0¤cy=string&effectiveDate=2024-01-01T00:00:00Z&number=string&refundAmount=0.0&status=Draft&type=External&unappliedAmount=0.0&updatedById=string&updatedDate=2024-01-01T00:00:00Z&sort=stringNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - POSTCreate a payment
/v1/paymentsNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETRetrieve a payment
/v1/payments/:paymentIdNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTUpdate a payment
/v1/payments/:paymentIdNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - DELETEDelete a payment
/v1/payments/:paymentIdNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTApply a payment
/v1/payments/:paymentId/applyNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTCancel a payment
/v1/payments/:paymentId/cancelNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETList all parts of a payment
/v1/payments/:paymentId/parts?pageSize=20Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETRetrieve a payment part
/v1/payments/:paymentId/parts/:partidNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - GETList all payment part items
/v1/payments/:paymentId/parts/:partid/itemparts?pageSize=20Note: This operation is only available if you have the Invoice Item Settlement feature enabled. Invoice Item Settlement must be used together with other… - GETRetrieve a payment part item
/v1/payments/:paymentId/parts/:partid/itemparts/:itempartidNote: This operation is only available if you have the Invoice Item Settlement feature enabled. Invoice Item Settlement must be used together with other… - POSTRefund a payment
/v1/payments/:paymentId/refundsNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTTransfer a payment
/v1/payments/:paymentId/transferNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing… - PUTUnapply a payment
/v1/payments/:paymentId/unapplyNote: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing…
Product Features
- GETCRUD: Retrieve a product feature
/v1/object/product-feature/:id?fields=string - DELETECRUD: Delete a product feature
/v1/object/product-feature/:id
Product Rate Plan Charge Tiers
- GETCRUD: Retrieve a product rate plan charge tier
/v1/object/product-rate-plan-charge-tier/:id?fields=string - PUTCRUD: Update a product rate plan charge tier
/v1/object/product-rate-plan-charge-tier/:id?rejectUnknownFields=falseUpdates the price of a product rate plan charge tier. To make other updates to product rate plan charge tiers, use CRUD: Update a product rate plan charge and…
Product Rate Plan Charges
- POSTCRUD: Create a product rate plan charge
/v1/object/product-rate-plan-charge?rejectUnknownFields=falseCreates a product rate plan charge for a specified rate plan charge. Product rate plan charges can be of three types, one-time fees, recurring fees, and usage… - GETCRUD: Retrieve a product rate plan charge
/v1/object/product-rate-plan-charge/:id?fields=string - PUTCRUD: Update a product rate plan charge
/v1/object/product-rate-plan-charge/:id?rejectUnknownFields=falseUpdates the information about a product rate plan charge. - DELETECRUD: Delete a product rate plan charge
/v1/object/product-rate-plan-charge/:idDeletes a product rate plan charge.
Product Rate Plans
- POSTCRUD: Create a product rate plan
/v1/object/product-rate-plan?rejectUnknownFields=false - GETCRUD: Retrieve a product rate plan
/v1/object/product-rate-plan/:id?fields=string - PUTCRUD: Update a product rate plan
/v1/object/product-rate-plan/:id?rejectUnknownFields=false
Showing 300 of 400 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://rest.zuora.com- Authentication
- None declared in the description
- Operations
- 428 operations on 315 pathsGET 172POST 114PUT 96DELETE 44PATCH 2
- Main resources
- Credit Memos 22Revenue Schedules 21Payment Methods 20Debit Memos 18Payments 18Invoices 16Orders 16Notifications 14Subscriptions 14Refunds 13
- Response formats
application/json; charset=utf-8application/jsontext/xml; charset=utf-8application/csv- Description format
- OpenAPI 3.0.0, API version
2021-08-20 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the API Reference: Billing in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the API Reference: Billing collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Amend” (POST /v1/action/amend?rejectUnknownFields=false), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the API Reference: Billing?
Introduction Welcome to the reference for the Zuora Billing REST API! To learn about the common use cases of Zuora Billing REST APIs, check out the [API… It is listed under Finance & banking and has 428 endpoints.
Who publishes the API Reference: Billing?
It is listed from Zuora's public API description (an OpenAPI document), not published by Zuora on Swastik Codes. Anyone who controls zuora.com can claim the profile by adding a DNS TXT record.
What is the base URL of the API Reference: Billing?
Requests go to https://rest.zuora.com. Endpoint paths are added to this base URL.
How do I authenticate with the API Reference: Billing?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the API Reference: Billing have?
428 operations on 315 paths (172 GET, 114 POST, 96 PUT, 44 DELETE, 2 PATCH). The largest groups are Credit Memos, Revenue Schedules, Payment Methods, Debit Memos. This listing's collection holds the first 400.
Is forking the API Reference: Billing free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.