# API Reference Welcome to the v1 API reference for the Zuora Billing, Payments, and Platform! If you are new to the Zuora API, start with our [Get started](https://developer.zuora.com/docs/get-started/introduction) guide to make your first call. To learn about the common use cases of the Zuora v1 API, check out the [API Tutorials](https://developer.zuora.com/docs/get-started/tutorials/). **Important**: This API Reference only showcases the parameters, fields, and behaviors available for the latest API minor version (`2025-08-12`). For more information about Zuora API versions, see [API versions](https://developer.zuora.com/v1-api-reference/api-versions/) and [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). We recommend that you upgrade to the latest API version to take advantage of the latest Zuora capabilities. For instructions about upgrading the API version, see [API upgrade guide](https://developer.zuora.com/v1-api-reference/api-upgrade-guide/). Try the v1 API in our Postman collection: Some of our older APIs are no longer recommended but still available, not affecting any existing integration. To find related API documentation, see [Older API Reference](https://developer.zuora.com/v1-api-reference/older-api/overview/). The 4-byte UTF-8 characters are not supported for text fields, such as the account names or bill-to contacts' first and last names. ### More OpenAPI specification options To support your integration with our OpenAPI specifications, whether using in-house solutions or third-party tools, we provide the following resources: - **Order-to-Cash operations (detailed)**: Download Order-to-Cash OpenAPI spec, which includes full descriptions and examples - **Order-to-Cash operations (compact)**: Download Order-to-Cash Compact OpenAPI spec, which excludes descriptions and code examples. - **Full OpenAPI spec (compact)**: Download Compact OpenAPI Spec, which covers the entire API set without descriptions or samples. If you need a different API specification beyond the options above, contact Zuora Global Support, and we will provide a custom spec tailored to your needs. Version: 2026-11-06 ## Servers US Developer & Central Sandbox (incl. Test Drive) ``` https://rest.test.zuora.com ``` US API Sandbox Cloud 1 ``` https://rest.sandbox.na.zuora.com ``` US API Sandbox Cloud 2 ``` https://rest.apisandbox.zuora.com ``` US Production Cloud 1 ``` https://rest.na.zuora.com ``` US Production Cloud 2 ``` https://rest.zuora.com ``` EU Developer & Central Sandbox ``` https://rest.test.eu.zuora.com ``` EU API Sandbox ``` https://rest.sandbox.eu.zuora.com ``` EU Production ``` https://rest.eu.zuora.com ``` APAC Developer & Central Sandbox ``` https://rest.test.ap.zuora.com ``` APAC Production ``` https://rest.ap.zuora.com ``` ## Security ### bearerAuth Use `Bearer {{token}}` in the `Authorization` header for authentication. Type: http Scheme: bearer ### basicAuth The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry. Type: http Scheme: basic ## Download OpenAPI description - [API Reference](https://developer.zuora.com/_bundle/v1-api-reference/api.yaml) ## OAuth - [POST /oauth/token](https://developer.zuora.com/v1-api-reference/api/oauth/createtoken.md): Creates 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 [Authentication](https://developer.zuora.co ## Commerce - [POST /commerce/attributes/batchQuery](https://developer.zuora.com/v1-api-reference/api/commerce/batchqueryattributemetadataforproductrateplans.md): Returns the union set of Dynamic Pricing attribute metadata for each requested product rate plan (PRP). For a given PRP, the response includes attributes declared on any nested product rate plan charg - [POST /commerce/billable-metrics](https://developer.zuora.com/v1-api-reference/api/commerce/createbillablemetric.md): Creates a billable metric that numbered metered features can use to measure entitlement usage. Specify the event types to process, the aggregation method, optional filters, computed properties, and g - [GET /commerce/billable-metrics](https://developer.zuora.com/v1-api-reference/api/commerce/getbillablemetrics.md): Lists billable metrics that numbered metered features can use to measure entitlement usage. - [GET /commerce/billable-metrics/{id}](https://developer.zuora.com/v1-api-reference/api/commerce/getbillablemetric.md): Retrieves a billable metric by its unique identifier or metric number. - [PUT /commerce/billable-metrics/{id}](https://developer.zuora.com/v1-api-reference/api/commerce/updatebillablemetric.md): Updates an existing billable metric. Use this operation to change fields such as `name`, `description`, `filters`, `computed_properties`, and `group_keys`. Include `metric_key` in the request body to - [DELETE /commerce/billable-metrics/{id}](https://developer.zuora.com/v1-api-reference/api/commerce/deletebillablemetric.md): Deletes a billable metric by its unique identifier. - [POST /commerce/features](https://developer.zuora.com/v1-api-reference/api/commerce/createfeature.md): Creates a catalog feature. Supported feature types are boolean (`bool`), enum (`enumType`), numbered metered, and numbered unmetered. Numbered metered features must include `metricId` to reference a b - [GET /commerce/features](https://developer.zuora.com/v1-api-reference/api/commerce/getfeatures.md): Lists catalog features, including boolean, enum, numbered metered, and numbered unmetered features. - [PUT /commerce/features](https://developer.zuora.com/v1-api-reference/api/commerce/updatefeature.md): Updates an existing catalog feature. Use this operation to change fields such as `name`, `description`, `values`, and `tags`. Omit `tags` to preserve existing tags. Send `clear_tags: true` to remove a - [POST /commerce/features/search](https://developer.zuora.com/v1-api-reference/api/commerce/searchfeatures.md): Searches catalog features. Use `filters` to match fields such as `feature_type` or `feature_tag`, or send `filter.feature_tag`. Soft-deleted features are excluded from the results. - [GET /commerce/features/{id}](https://developer.zuora.com/v1-api-reference/api/commerce/getfeature.md): Retrieves a catalog feature by its unique identifier. - [DELETE /commerce/features/{id}](https://developer.zuora.com/v1-api-reference/api/commerce/deletefeature.md): Deletes a catalog feature by its unique identifier. - [POST /commerce/charges](https://developer.zuora.com/v1-api-reference/api/commerce/createproductrateplanchargewithdynamicpricing.md): Create a product rate plan charge (PRPC) in the Product Catalog. Use this endpoint to configure Dynamic Pricing, including default pricing at the charge level and conditional rate cards evaluated by - [PUT /commerce/charges](https://developer.zuora.com/v1-api-reference/api/commerce/updateproductrateplanchargewithdynamicpricing.md): Update an existing product rate plan charge (PRPC). Use this API to update default pricing and/or conditional rate cards. - [POST /commerce/charges/batchQuery](https://developer.zuora.com/v1-api-reference/api/commerce/batchqueryproductrateplanchargeswithdynamicpricing.md): Batch-queries product rate plan charges (PRPCs) with Dynamic Pricing support. The functionality matches "Query a product rate plan charge with Dynamic Pricing" (`POST /commerce/charges/query`), except - [POST /commerce/charges/query](https://developer.zuora.com/v1-api-reference/api/commerce/queryproductrateplanchargewithdynamicpricing.md): Returns a product rate plan charge (PRPC) by evaluating Dynamic Pricing against the provided attribute values. If a matching rate-card row is found, its pricing is returned; otherwise, the default c - [POST /commerce/products](https://developer.zuora.com/v1-api-reference/api/commerce/createproduct.md): Create a product in the Product Catalog with one or more plans and charges. Charges can be usage (per-unit), recurring (flat fee), or other supported models. - [PUT /commerce/products](https://developer.zuora.com/v1-api-reference/api/commerce/updateproduct.md): Updates an existing product in the Product Catalog. Use this API to update core product fields such as name, description, category, effective dates, and custom fields. - [POST /commerce/plans](https://developer.zuora.com/v1-api-reference/api/commerce/createplan.md): Create a product rate plan (Plan) under an existing product. A plan includes one or more **charges**. Each charge **must** include: - `name` - `charge_model` - `charge_type` - `bill_cycle` - `trigger_ - [PUT /commerce/plans](https://developer.zuora.com/v1-api-reference/api/commerce/updateproductrateplan.md): Updates an existing Product Rate Plan (PRP) in the Product Catalog. Use this API to update core plan fields such as name, description, grade, and effective dates. - [POST /commerce/plans/query](https://developer.zuora.com/v1-api-reference/api/commerce/querycommerceproductrateplans.md): Retrieve details of a **single** product rate plan (PRP) from the Product Catalog. You can expand associated product rate plan charges for each plan. This operation is a **strict lookup** and **requir - [POST /commerce/plans/list](https://developer.zuora.com/v1-api-reference/api/commerce/querycommerceplanslist.md): Queries product rate plans (PRPs) from the Product Catalog using filters such as plan ID, name, or product ID. You can optionally expand related Product Rate Plan Charges (PRPCs) in the response. - [POST /commerce/plans/{id}/entitlements](https://developer.zuora.com/v1-api-reference/api/commerce/createentitlementdefinition.md): Creates a catalog entitlement definition on a plan. The definition associates a product feature with the plan. Include `featureNumber` or `feature_number`. Numbered features can include `quantity` or - [PUT /commerce/plans/entitlements](https://developer.zuora.com/v1-api-reference/api/commerce/updateentitlementdefinition.md): Updates a catalog entitlement definition. Use this operation to link the definition to a charge, set boolean values, or change enforcement settings. - [GET /commerce/plans/entitlements/{id}](https://developer.zuora.com/v1-api-reference/api/commerce/getentitlementdefinition.md): Retrieves a catalog entitlement definition by its unique identifier or entitlement number. A catalog entitlement definition is not a runtime entitlement grant. Runtime grants are created by the Z-EMS - [POST /commerce/products/{product_key}](https://developer.zuora.com/v1-api-reference/api/commerce/getproductbykey.md): Retrieves detailed information about a specific product by its unique product number or ID. You can optionally specify related objects to expand in the request body. - [PUT /commerce/products/{id}/features/add](https://developer.zuora.com/v1-api-reference/api/commerce/addproductfeature.md): Links a catalog feature to a product. Include `feature_number` or `featureNumber`. After a feature is linked to a product, you can create an entitlement definition on a plan that belongs to that produ - [POST /commerce/legacy/products/list](https://developer.zuora.com/v1-api-reference/api/commerce/querylegacyproducts.md): This operation is functionally equivalent to the "Query products from the Product Catalog" operation, except that it returns results in the **V1 response format**. It is primarily intended for custome - [PUT /commerce/tiers](https://developer.zuora.com/v1-api-reference/api/commerce/updatetier.md): Updates the price and other editable attributes, when supported, for a specific **Product Rate Plan Charge Tier**. - [POST /commerce/purchase-options/list](https://developer.zuora.com/v1-api-reference/api/commerce/querypurchaseoptionsbyprpid.md): Retrieves one or more product rate plans (PRPs) from the Product Catalog based on specified filters such as product ID or PRP ID. You can optionally expand related product rate plan charges (PRPCs) in - [GET /commerce/entitlements/audit-events](https://developer.zuora.com/v1-api-reference/api/commerce/getentitlementauditevents.md): Lists entitlement audit events. Filter results by account, feature, grant, subscription, event type, and date. - [POST /commerce/entitlements/authorize](https://developer.zuora.com/v1-api-reference/api/commerce/authorizeentitlementconsumption.md): Authorizes consumption against a numbered metered feature and deducts `requestedQuantity` from the remaining entitlement balance when the request is allowed. - [POST /commerce/entitlements/bulk-challenge](https://developer.zuora.com/v1-api-reference/api/commerce/validateentitlementsbytag.md): Checks whether an account has access to features that match `featureTag`, or to the features in `featureKeys`. Do not send `featureTag` and `featureKey` in the same request. - [POST /commerce/entitlements/bulk-check](https://developer.zuora.com/v1-api-reference/api/commerce/validateentitlementfeatures.md): Checks whether an account has access to multiple features in one request. Include `requestedQuantity` when evaluating numbered metered features. - [POST /commerce/entitlements/bulk-grant](https://developer.zuora.com/v1-api-reference/api/commerce/bulkgrantentitlements.md): Creates runtime entitlement grants for multiple accounts or subscriptions in a single call. Each item uses the same shape as `POST /commerce/entitlements/grant`, but this operation reports each item's - [POST /commerce/entitlements/bulk-revoke](https://developer.zuora.com/v1-api-reference/api/commerce/bulkrevokeentitlements.md): Revokes one or more runtime entitlement grants. Include `revokedDate` when the revocation should take effect on a specific date. - [POST /commerce/entitlements/challenge](https://developer.zuora.com/v1-api-reference/api/commerce/validateentitlementaccess.md): Checks whether an account has access to a feature. For numbered metered features, include `requestedQuantity`. For enum features, include `enumValues`. - [POST /commerce/entitlements/grant](https://developer.zuora.com/v1-api-reference/api/commerce/createentitlementgrants.md): Creates one or more runtime entitlement grants. Use this operation to issue a manual grant for an account, independently of a catalog entitlement definition on a plan. - [GET /commerce/entitlements/grants](https://developer.zuora.com/v1-api-reference/api/commerce/getentitlementgrants.md): Lists runtime entitlement grants. Filter results by account, subscription, feature, state, or charge source. - [GET /commerce/entitlements/grants/{entitlementKey}](https://developer.zuora.com/v1-api-reference/api/commerce/getentitlementgrant.md): Retrieves one runtime entitlement grant by its entitlement key. - [POST /commerce/entitlements/{entitlementKey}/modify](https://developer.zuora.com/v1-api-reference/api/commerce/updateentitlementgrant.md): Updates the dates or quantity of a runtime entitlement grant. Use `redate` with `startDate` and/or `endDate` to change the grant term, or `increment` and `decrement` with `delta` to change the granted - [POST /commerce/entitlements/{entitlementKey}/state](https://developer.zuora.com/v1-api-reference/api/commerce/updateentitlementgrantstate.md): Updates the state of a runtime entitlement grant. Supported `action` values are `pause`, `resume`, `activate`, `deactivate`, and `revoke`. ## Accounts - [POST /v1/accounts](https://developer.zuora.com/v1-api-reference/api/accounts/post_account.md): Creates a customer account with a payment method, a bill-to contact, and optional sold-to and ship-to contacts. Request and response field descriptions and sample code are provided. Use this operation - [DELETE /v1/accounts/{account-key}](https://developer.zuora.com/v1-api-reference/api/accounts/delete_account.md): Deletes a specific account asynchronously. **Notes and Limitations:** - For account deletion, the system will start a backend job to remove all transactions under the accounts and change the status of - [GET /v1/accounts/{account-key}](https://developer.zuora.com/v1-api-reference/api/accounts/get_account.md): Retrieves basic information about a customer account. This operation is a quick retrieval that doesn't include the account's subscriptions, invoices, payments, or usage details. Use Get account summa - [PUT /v1/accounts/{account-key}](https://developer.zuora.com/v1-api-reference/api/accounts/put_account.md): Updates 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 request body will not be changed. 2. If - [GET /v1/accounts/{account-key}/payment-methods](https://developer.zuora.com/v1-api-reference/api/accounts/get_acountpaymentmethods.md): Retrieves the payment methods of the specified customer account. **Note:** This operation also supports retrieving custom payment methods created through the [Open Payment Method](https://docs.zuora.c - [GET /v1/accounts/{account-key}/payment-methods/cascading](https://developer.zuora.com/v1-api-reference/api/accounts/getaccountpaymentmethodcascading.md): Zuora provides the Cascading Payment Method feature to dynamically retry the failed payment with alternative payment methods according to a predefined priority list. Use this API operation to retrieve - [PUT /v1/accounts/{account-key}/payment-methods/cascading](https://developer.zuora.com/v1-api-reference/api/accounts/putaccountpaymentmethodcascading.md): Zuora provides the Cascading Payment Method feature to dynamically retry the failed payment with alternative payment methods according to a predefined priority list. Use this API operation to configur - [GET /v1/accounts/{account-key}/payment-methods/default](https://developer.zuora.com/v1-api-reference/api/accounts/get_acountdefaultpaymentmethod.md): Retrieves the default payment method of the specified customer account. **Notes:** This operation also supports retrieving the custom payment method created through the [Open Payment Method](https://d - [GET /v1/accounts/{account-key}/summary](https://developer.zuora.com/v1-api-reference/api/accounts/get_accountsummary.md): Retrieves detailed information about the specified customer account. The response includes the account information and a summary of the account’s subscriptions, invoices, payments, and usages. ### Not ## Contacts - [POST /v1/contacts](https://developer.zuora.com/v1-api-reference/api/contacts/post_createcontact.md): Creates a contact for a specified account. Each account must have at least one contact before it can be saved. You can add a maximum of 2000 contacts to an account. - [DELETE /v1/contacts/{contactId}](https://developer.zuora.com/v1-api-reference/api/contacts/delete_contact.md): Deletes a contact. - [GET /v1/contacts/{contactId}](https://developer.zuora.com/v1-api-reference/api/contacts/get_contact.md): Retrieves detailed information about a specific contact. - [PUT /v1/contacts/{contactId}](https://developer.zuora.com/v1-api-reference/api/contacts/put_contact.md): Updates a contact for a specified account. You can update contacts for cancelled accounts. - [PUT /v1/contacts/{contactId}/transfer](https://developer.zuora.com/v1-api-reference/api/contacts/transfercontent.md): This operation transfers contacts of the accounts within the Customer Hierarchy when removing the account. - [PUT /v1/contacts/{contactId}/scrub](https://developer.zuora.com/v1-api-reference/api/contacts/put_scrubcontact.md): Scrubs 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 dummy values that will be stored in Zuora d ## Contact Snapshots - [GET /v1/contact-snapshots/{contact-snapshot-id}](https://developer.zuora.com/v1-api-reference/api/contact-snapshots/get_contactsnapshot.md): Retrieves detailed information about the snapshot of a contact, either a bill-to contact or sold-to contact. ## Sign Up - [POST /v1/sign-up](https://developer.zuora.com/v1-api-reference/api/sign-up/post_signup.md): This call performs many actions. You can use this operation to implement the standard requirements for signing up a customer, such as validating the uniqueness of an account and limiting the number of ## Orders - [POST /v1/orders/preview](https://developer.zuora.com/v1-api-reference/api/orders/post_previeworder.md): **Notes**: - This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access - [POST /v1/async/orders/preview](https://developer.zuora.com/v1-api-reference/api/orders/post_previeworderasynchronously.md): **Notes:** - This operation is only available if you have the [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orde - [GET /v1/orders](https://developer.zuora.com/v1-api-reference/api/orders/get_allorders.md): **Note:** This feature is only available if you have the [Order Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/or - [POST /v1/orders](https://developer.zuora.com/v1-api-reference/api/orders/post_order.md): **Note:** This operation is only available if you have the [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/ - [POST /v1/async/orders](https://developer.zuora.com/v1-api-reference/api/orders/post_createorderasynchronously.md): **Note:** This operation is only available if you have the [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/ - [DELETE /v1/orders/{orderNumber}](https://developer.zuora.com/v1-api-reference/api/orders/delete_order.md): **Note:** This operation is only available if you have the [Orders](https://docs.zuora.com?resourceId=billing-overview-orders) feature enabled. If you are an existing Zuora Subscribe and Amend custome - [GET /v1/orders/{orderNumber}](https://developer.zuora.com/v1-api-reference/api/orders/get_order.md): **Note:** This feature is only available if you have the [Order Metrics](https://docs.zuora.com?resourceId=billing-order-metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally - [PUT /v1/orders/{orderNumber}](https://developer.zuora.com/v1-api-reference/api/orders/put_order.md): **Notes:** - This operation is only available if you have the [Orders](https://docs.zuora.com?resourceId=billing-overview-orders) feature enabled. If you are an existing Zuora Subscribe and Amend cust - [DELETE /v1/async/orders/{orderNumber}](https://developer.zuora.com/v1-api-reference/api/orders/deleteorderasynchronously.md): **Note:** This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the - [GET /v1/async-jobs/{jobId}](https://developer.zuora.com/v1-api-reference/api/orders/get_jobstatusandresponse.md): **Note:** This operation is only available if you have the [Orders](https://docs.zuora.com?resourceId=billing-overview-orders) feature enabled. If you are an existing Zuora Subscribe and Amend custome - [GET /v1/orders/subscriptionOwner/{accountNumber}](https://developer.zuora.com/v1-api-reference/api/orders/get_ordersbysubscriptionowner.md): **Note:** This feature is only available if you have the [Order Metrics](https://docs.zuora.com?resourceId=billing-order-metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally - [GET /v1/orders/subscription/{subscriptionNumber}](https://developer.zuora.com/v1-api-reference/api/orders/get_ordersbysubscriptionnumber.md): **Note:** This feature is only available if you have the [Order Metrics](https://docs.zuora.com?resourceId=billing-order-metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally - [GET /v1/orders/invoiceOwner/{accountNumber}](https://developer.zuora.com/v1-api-reference/api/orders/get_ordersbyinvoiceowner.md): **Note:** This feature is only available if you have the [Order Metrics](https://docs.zuora.com?resourceId=billing-order-metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally - [PUT /v1/orders/{orderNumber}/customFields](https://developer.zuora.com/v1-api-reference/api/orders/put_updateordercustomfields.md): **Note:** This feature is only available if you have the [Order Metrics](https://docs.zuora.com?resourceId=billing-order-metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally - [PUT /v1/subscriptions/{subscriptionNumber}/customFields](https://developer.zuora.com/v1-api-reference/api/orders/put_updatesubscriptioncustomfields.md): **Note:** This operation is only available if you have the [Orders](https://docs.zuora.com?resourceId=billing-overview-orders) feature enabled. If you are an existing Zuora Subscribe and Amend custome - [PUT /v1/orders/{orderNumber}/triggerDates](https://developer.zuora.com/v1-api-reference/api/orders/put_ordertriggerdates.md): **Note:** This operation is only available if you have the [Orders](https://docs.zuora.com?resourceId=billing-overview-orders) feature enabled. If you are an existing Zuora Subscribe and Amend custome - [PUT /v1/orders/{orderNumber}/activate](https://developer.zuora.com/v1-api-reference/api/orders/put_orderactivate.md): **Note:** This operation is only available if you have the [Orders](https://docs.zuora.com?resourceId=billing-overview-orders) feature enabled. If you are an existing Zuora Subscribe and Amend custome - [PUT /v1/orders/{orderNumber}/cancel](https://developer.zuora.com/v1-api-reference/api/orders/put_ordercancel.md): **Note:** This operation is only available if you have the [Orders](https://docs.zuora.com?resourceId=billing-overview-orders) feature enabled. If you are an existing Zuora Subscribe and Amend custome - [POST /v1/orders/commitments/{commitmentNumber}/associations/rescan](https://developer.zuora.com/v1-api-reference/api/orders/rescancommitmentaccountassociations.md): Re-evaluates a commitment's account eligibility condition against current account data and activates (inserts or reactivates) any newly-eligible accounts. This operation is **additive only**: it never - [GET /v1/orders/deltaMetrics/{orderNumber}](https://developer.zuora.com/v1-api-reference/api/orders/getorderdeltametricsbyordernumber.md): **Note**: This operation is only available if you have the [Order Delta Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transac - [GET /v1/orders/subscription/{subscription-key}/pending](https://developer.zuora.com/v1-api-reference/api/orders/get_pendingordersbysubscriptionnumber.md): **Note:** This feature is only available if you have the [Order Metrics](https://docs.zuora.com?resourceId=billing-order-metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally ## Order Actions - [PUT /v1/orderActions/{id}](https://developer.zuora.com/v1-api-reference/api/order-actions/put_orderactions.md): Updates the change reason and custom fields for an order action. ## Order Line Items - [GET /v1/order-line-items/{itemId}](https://developer.zuora.com/v1-api-reference/api/order-line-items/get_orderlineitem.md): **Note:** The [Order Line Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items) feature is now gener - [PUT /v1/order-line-items/{itemId}](https://developer.zuora.com/v1-api-reference/api/order-line-items/put_orderlineitem.md): **Note:** The [Order Line Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items) feature is now gener - [POST /v1/order-line-items/bulk](https://developer.zuora.com/v1-api-reference/api/order-line-items/post_orderlineitems.md): **Note:** The [Order Line Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items) feature is now gener ## Fulfillments - [POST /v1/fulfillments](https://developer.zuora.com/v1-api-reference/api/fulfillments/create_fulfillment.md): Creates one or multiple Fulfillment objects. You can also generate invoices or memos for these Fulfillment objects in this API call. The following tutorials demonstrate how to use this operation: * [C - [DELETE /v1/fulfillments/{key}](https://developer.zuora.com/v1-api-reference/api/fulfillments/delete_fulfillment.md): Deletes a specified fulfillment. A fulfillment can only be deleted when it is in the `Executing` state. - [GET /v1/fulfillments/{key}](https://developer.zuora.com/v1-api-reference/api/fulfillments/get_fulfillment.md): Retrieves the detailed information about a specified fulfillment. The following tutorial demonstrates how to use this operation: * [View details of a fulfillment](https://docs.zuora.com?resourceId=bil - [PUT /v1/fulfillments/{key}](https://developer.zuora.com/v1-api-reference/api/fulfillments/put_fulfillment.md): Updates a specified fulfillment. The `state` field of a fulfillment can only be updated when it is in a different state, to trigger the state transition. The other fields of a fulfillment can only be - [POST /v1/fulfillment-items](https://developer.zuora.com/v1-api-reference/api/fulfillments/create_fulfillmentitem.md): Creates one or multiple fulfillment items. - [DELETE /v1/fulfillment-items/{id}](https://developer.zuora.com/v1-api-reference/api/fulfillments/delete_fulfillmentitem.md): Deletes a specified fulfillment item. - [GET /v1/fulfillment-items/{id}](https://developer.zuora.com/v1-api-reference/api/fulfillments/get_fulfillmentitem.md): Retrieves the detailed information about a specified fulfillment item. - [PUT /v1/fulfillment-items/{id}](https://developer.zuora.com/v1-api-reference/api/fulfillments/put_fulfillmentitem.md): Updates a specified fulfillment item. ## Ramps - [GET /v1/ramps/{rampNumber}](https://developer.zuora.com/v1-api-reference/api/ramps/get_rampbyrampnumber.md): **Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscr - [GET /v1/ramps/{rampNumber}/ramp-metrics](https://developer.zuora.com/v1-api-reference/api/ramps/get_rampmetricsbyrampnumber.md): **Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscr - [GET /v1/subscriptions/{subscriptionKey}/ramps](https://developer.zuora.com/v1-api-reference/api/ramps/get_rampsbysubscriptionkey.md): **Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscr - [GET /v1/subscriptions/{subscriptionKey}/ramp-metrics](https://developer.zuora.com/v1-api-reference/api/ramps/get_rampmetricsbysubscriptionkey.md): **Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscr - [GET /v1/orders/{orderNumber}/ramp-metrics](https://developer.zuora.com/v1-api-reference/api/ramps/get_rampmetricsbyordernumber.md): **Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscr ## Subscriptions - [POST /v1/subscriptions/preview](https://developer.zuora.com/v1-api-reference/api/subscriptions/post_previewsubscription.md): The REST API reference describes how to create a new subscription in preview mode. This call does not require a valid customer account. It can be used to show potential new customers a preview of a su - [POST /v1/subscriptions/{subscription-key}/preview](https://developer.zuora.com/v1-api-reference/api/subscriptions/previewexistingsubscription.md): Describes how to preview an existing subscription to view information about existing and future invoices or credit memos. **Note**: The `Zuora-Version` parameter must be `207.0` or later. - [POST /v1/subscriptions](https://developer.zuora.com/v1-api-reference/api/subscriptions/post_subscription.md): This operation describes how to create a new subscription for an existing customer account. ### Notes If you have the Invoice Settlement feature enabled, it is best practice to set the `Zuora-Version` - [GET /v1/subscriptions/accounts/{account-key}](https://developer.zuora.com/v1-api-reference/api/subscriptions/get_subscriptionsbyaccount.md): Retrieves all subscriptions associated with the specified account. Zuora only returns the latest version of the subscriptions. Subscription data is returned in reverse chronological order based on `up - [GET /v1/subscriptions/{subscription-key}](https://developer.zuora.com/v1-api-reference/api/subscriptions/get_subscriptionsbykey.md): This REST API reference describes how to retrieve detailed information about a specified subscription in the latest version. - [PUT /v1/subscriptions/{subscription-key}](https://developer.zuora.com/v1-api-reference/api/subscriptions/put_subscription.md): 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 termed - Ad - [GET /v1/subscriptions/{subscription-key}/versions/{version}](https://developer.zuora.com/v1-api-reference/api/subscriptions/get_subscriptionsbykeyandversion.md): This REST API reference describes how to retrieve detailed information about a specified subscription in a specified version. When you create a subscription amendment, you create a new version of the - [PUT /v1/subscriptions/{subscription-key}/renew](https://developer.zuora.com/v1-api-reference/api/subscriptions/put_renewsubscription.md): Renews a termed subscription using existing renewal terms. When you renew a subscription, the current subscription term is extended by creating a new term. If any charge in your subscription has the - [PUT /v1/subscriptions/{subscription-key}/cancel](https://developer.zuora.com/v1-api-reference/api/subscriptions/put_cancelsubscription.md): This REST API reference describes how to cancel an active subscription. **Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `Zuora-Version` parameter to `211.0 - [PUT /v1/subscriptions/{subscription-key}/resume](https://developer.zuora.com/v1-api-reference/api/subscriptions/put_resumesubscription.md): This REST API reference describes how to resume a suspended subscription. **Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `Zuora-Version` parameter to `211 - [PUT /v1/subscriptions/{subscription-key}/suspend](https://developer.zuora.com/v1-api-reference/api/subscriptions/put_suspendsubscription.md): This REST API reference describes how to suspend an active subscription. **Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `Zuora-Version` parameter to `211. - [PUT /v1/subscriptions/{subscription-key}/delete](https://developer.zuora.com/v1-api-reference/api/subscriptions/put_deletesubscription.md): This REST API reference describes how to delete a subscription of the specified subscription number. - [PUT /v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields](https://developer.zuora.com/v1-api-reference/api/subscriptions/put_updatesubscriptioncustomfieldsofaspecifiedversion.md): Updates the custom fields of a specified subscription version. - [GET /v1/subscriptions/subscription-metrics](https://developer.zuora.com/v1-api-reference/api/subscriptions/getmetricsbysubscriptionnumbers.md): Lists subscription metrics for the subscriptions that you specify by subscription numbers. ## Omnichannel Subscriptions - [POST /v1/omni-channel-subscriptions](https://developer.zuora.com/v1-api-reference/api/omnichannel-subscriptions/postomnichannelsubscription.md): Creates or updates an omnichannel subscription for a customer account. You can also create a new customer account and assign it to the new omnichannel subscription. - [GET /v1/omni-channel-subscriptions/{subscriptionKey}](https://developer.zuora.com/v1-api-reference/api/omnichannel-subscriptions/getomnichannelsubscription.md): Retrieves the information about a specific omnichannel subscription. - [DELETE /v1/omni-channel-subscriptions/{subscriptionKey}](https://developer.zuora.com/v1-api-reference/api/omnichannel-subscriptions/deleteomnichannelsubscription.md): Deletes a specified omnichannel subscription. ## Rate Plans - [GET /v1/rateplans/{ratePlanId}](https://developer.zuora.com/v1-api-reference/api/rate-plans/get_rateplan.md): Retrieves the detailed information about a specific subscription rate plan. - If you have the Orders feature enabled, this operation retrieves information about a subscription rate plan and the relate ## Commitments - [GET /commitments](https://developer.zuora.com/v1-api-reference/api/commitments/getcommitments.md): Retrieves a paginated list of commitments for a commitment owner account. - [GET /commitments/{commitmentKey}](https://developer.zuora.com/v1-api-reference/api/commitments/getcommitmentbykey.md): Retrieves the details of a specific commitment using its ID or number. - [GET /commitments/periods](https://developer.zuora.com/v1-api-reference/api/commitments/getcommitmentperiods.md): Lists periods of the commitment. You can paginate the results using `page` and `pageSize` query parameters. - [GET /commitments/{commitmentId}/balancepreview](https://developer.zuora.com/v1-api-reference/api/commitments/getcommitmentbalancepreview.md): Preview the balance for a commitment for current and past periods. Future periods are not covered. **Note**: This API will not work for tenants that are configured to skip commitment evaluation in Zuo - [GET /commitments/{commitmentKey}/schedules](https://developer.zuora.com/v1-api-reference/api/commitments/listcommitmentschedules.md): Retrieves all the schedules for a specific commitment. - [PUT /prepayments/{prepaymentId}/expire](https://developer.zuora.com/v1-api-reference/api/commitments/expireprepayment.md): Expires a single commitment-linked prepayment and returns the updated prepayment state. After the prepayment is expired, it does not participate in future drawdown. - [GET /commitments/{commitmentKey}/commitmentChanges](https://developer.zuora.com/v1-api-reference/api/commitments/listcommitmenthistoricalchanges.md): Lists the historical changes made to a specific commitment, ordered by the most recent changes first. Notes: - Owner Transfer on Commitment accounts will transfer the associated subscription charges f ## Prepaid with Drawdown - [POST /v1/ppdd/reverse-rollover](https://developer.zuora.com/v1-api-reference/api/prepaid-with-drawdown/post_reverserollover.md): This REST API reference describes how to manually reverse fund rollover from source validity period to destination validity period. There are no path or query parameters. **Note**: This API will not w - [POST /v1/ppdd/rollover](https://developer.zuora.com/v1-api-reference/api/prepaid-with-drawdown/post_rollover.md): 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. This REST - [POST /v1/prepaid-balance-funds/deplete](https://developer.zuora.com/v1-api-reference/api/prepaid-with-drawdown/expireprepaidfunds.md): Depletes prepaid balance funds. A fund is depleted only when it exists, is not deleted, has a balance greater than zero, and its source type is a prepayment fund: charge-based unit funds, upfront curr ## Usage - [Note on dynamic pricing usage charges](https://developer.zuora.com/v1-api-reference/api/usage/note-on-dynamic-pricing-usage-charges.md): ### Note on dynamic pricing usage charges Legacy Billing Usage APIs (for example, "Upload a usage file" and the "CRUD: Create/Update/Delete a usage record" operations) can support usage records that - [POST /v1/usage](https://developer.zuora.com/v1-api-reference/api/usage/post_usage.md): This REST API reference describes how to post or import usage data for one or more accounts in the CSV format. There are no path or query parameters. The data is uploaded using the HTTP multipart/form - [GET /v1/invoices/invoice-item/{invoice-item-id}/usage-rate-detail](https://developer.zuora.com/v1-api-reference/api/usage/get_usage_rate_detail_by_invoice_item.md): Use this REST API operation to retrieve the usage rate detail for an invoice item to understand how the total amount is calculated. The information is the same as the Rate Detail presented on [PDF inv - [POST /v1/object/usage](https://developer.zuora.com/v1-api-reference/api/usage/object_postusage.md): Creates a usage record. - [DELETE /v1/object/usage/{id}](https://developer.zuora.com/v1-api-reference/api/usage/object_deleteusage.md): Deletes a usage record. Usage records that are associated with a dynamic pricing usage charge cannot be deleted with this legacy Billing endpoint. When a delete request targets such a record, the oper - [GET /v1/object/usage/{id}](https://developer.zuora.com/v1-api-reference/api/usage/object_getusage.md): Retrieve a usage record. - [PUT /v1/object/usage/{id}](https://developer.zuora.com/v1-api-reference/api/usage/object_putusage.md): Updates a usage record. Updating usage records that are associated with a dynamic pricing usage charge is not supported through this endpoint. The request fails and the record is not updated. Use Medi ## Meters - [POST /meters/run/{meterId}/{version}](https://developer.zuora.com/v1-api-reference/api/meters/runspecificversionofmeter.md): Executes a specific version of a meter in Zuora Mediation. You can choose to run it with either a local file or event store source by providing optional configurations. **Note on long-running meters a - [POST /meters/stop/{meterId}/{version}](https://developer.zuora.com/v1-api-reference/api/meters/stopmeterversion.md): Stops all runnable NORMAL-mode runs for a specific version of a meter in Zuora Mediation. By default, the API gracefully stops streaming meters by creating a savepoint. Streaming stops are asynchronou - [POST /meters/debug/{meterId}/{version}](https://developer.zuora.com/v1-api-reference/api/meters/testspecificversionofmeter.md): Test a specific version of a meter in Zuora Mediation without executing a full run. It supports multiple input methods, including uploaded files, sample files, and manual test data. This is useful for - [POST /meters/{meterId}/summary](https://developer.zuora.com/v1-api-reference/api/meters/retrievemetersummarydata.md): Retrieves summary data for a specific meter in Zuora Mediation, providing a rolled-up view of a meter run or time window. The API supports grouping by Operator ID, Error Code, or Session ID, and allow - [GET /meters/{meterId}/{version}/runStatus](https://developer.zuora.com/v1-api-reference/api/meters/getrunstatusofspecificmeterversion.md): Retrieves the current run status of a specific meter version in Zuora Mediation. It returns an integer code indicating the status, such as `RUNNING`, `COMPLETED`, or `FAILED`, which helps monitor the - [GET /meters/export/{meterId}](https://developer.zuora.com/v1-api-reference/api/meters/exportspecificmeter.md): The Export Meter operation exports the full definition of a specific meter in Zuora Mediation, including metadata, all versions, event schemas, and operator configurations (source, processor, sink). I - [POST /meters/import](https://developer.zuora.com/v1-api-reference/api/meters/importmeterdefinition.md): Import a meter definition into Zuora Mediation using a file exported from the Export Meter API. ## Data Ingestion - [POST /meters/files](https://developer.zuora.com/v1-api-reference/api/data-ingestion/uploadmeteringfile.md): Uploads and stores a file in Zuora Mediation for use in meter processing. Supported formats include CSV, Excel, and JSON. You can specify metadata like headers, delimiters, sheets, and data ranges. - [POST /usage/bulk/{meterGlobalId}](https://developer.zuora.com/v1-api-reference/api/data-ingestion/ingestusageevents.md): Ingests usage events directly into Zuora Mediation in real time. You can send a single event or batch multiple events in a JSON array to optimize throughput. Each event must conform to the meter's eve ## Audit Trail - [GET /meters/{meterId}/auditTrail/entries](https://developer.zuora.com/v1-api-reference/api/audit-trail/getaudittrailentriesformeter.md): Retrieves the audit trail entries for a specific meter in Zuora Mediation. The API provides detailed, record-level information about what happened during processing, including Payload and error detail - [GET /meters/{meterId}/auditTrail/export](https://developer.zuora.com/v1-api-reference/api/audit-trail/getaudittrailexportjobs.md): Retrieves the list of previously initiated export jobs for a specific meter in Zuora Mediation. You can filter the results by export type, session IDs, or request ID by using the `exportType`, `sessio - [POST /meters/{meterId}/auditTrail/export](https://developer.zuora.com/v1-api-reference/api/audit-trail/createaudittrailexportjob.md): Creates a background job to export the audit trail entries for a specific meter in Zuora Mediation. This API is for large-scale, offline access to audit data. Only one export job is processed per tena - [GET /meters/auditTrail/presignedUrl](https://developer.zuora.com/v1-api-reference/api/audit-trail/getpresignedurlformeterexport.md): Returns a pre-signed URL that you can use to download a specific export file (usually from object storage such as S3). The `fileKey` corresponds to one entry from the `fileList` array in the List API. - [GET /meters/{meterId}/prefetchAudit](https://developer.zuora.com/v1-api-reference/api/audit-trail/listprefetchauditrecords.md): List audit records for prefetch operations by processor ID with filtering and cursor-based pagination. ## Event Store - [POST /meters/events/bulkDelete](https://developer.zuora.com/v1-api-reference/api/event-store/bulkdeleteeventsfromeventstore.md): Allows you to delete multiple events from an event store in Zuora Mediation using a file that lists the event IDs to be removed. It is useful for cleaning up or correcting data in bulk. - [GET /meters/events/stores/{eventStoreId}/jobs/latest](https://developer.zuora.com/v1-api-reference/api/event-store/getlatestqueryjobofspecificeventstore.md): Retrieves the most recent query job executed on a specific event store in Zuora Mediation. It returns metadata such as query type (for example, DELETE), status, record counts, and timestamps. - [POST /meters/events/stores/{eventStoreId}/truncate](https://developer.zuora.com/v1-api-reference/api/event-store/truncateeventstore.md): Truncates (deletes) all events from a specific event store in Zuora Mediation. This operation runs asynchronously and returns a query job identifier that you can use with the Event Store query job AP - [POST /meters/event-store-queries](https://developer.zuora.com/v1-api-reference/api/event-store/submiteventstorequery.md): Submits a SQL-style asynchronous query to the Event Store to retrieve and inspect metering events for validation, troubleshooting, and reconciliation. The API returns a `queryId` that can be used to p - [GET /meters/event-store-queries/{queryId}](https://developer.zuora.com/v1-api-reference/api/event-store/getqueryresultsforeventstore.md): Retrieves paginated result rows and column metadata for a previously submitted Event Store query using its `queryId`, including total row count, row-level field values, and readiness status. Query exe ## Delivery Adjustments - [GET /v1/adjustments](https://developer.zuora.com/v1-api-reference/api/delivery-adjustments/get_subscription_adjustments.md): Describes how to retrieve detailed information about delivery adjustments of a subscription. **Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedba - [POST /v1/adjustments](https://developer.zuora.com/v1-api-reference/api/delivery-adjustments/create_adjustment.md): Describes how to create one or more delivery adjustments for a subscription. **Notes**: - The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a sma - [POST /v1/adjustments/preview](https://developer.zuora.com/v1-api-reference/api/delivery-adjustments/preview_adjustment.md): Describes how to preview delivery adjustments of a subscription. **Notes**: - The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of ea - [GET /v1/adjustments/{adjustment-key}](https://developer.zuora.com/v1-api-reference/api/delivery-adjustments/get_adjustment.md): Describes how to retrieve detailed information about a delivery adjustment. **Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small s - [PUT /v1/adjustments/{adjustmentId}/cancel](https://developer.zuora.com/v1-api-reference/api/delivery-adjustments/put_canceladjustment.md): Describes how to cancel an unbilled delivery adjustment. **Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopter ## Billing Documents - [GET /v1/billing-documents](https://developer.zuora.com/v1-api-reference/api/billing-documents/get_billingdocuments.md): Retrieves the information about all billing documents associated with a specified account. The billing documents contain invoices, credit memos, and debit memos. To retrieve information about credit m - [POST /v1/accounts/billing-documents/files/deletion-jobs](https://developer.zuora.com/v1-api-reference/api/billing-documents/post_billingdocumentfilesdeletionjob.md): Creates an asynchronous job to permanently delete all billing document PDF files for specific accounts. After the deletion job is completed, all billing document PDF files are permanently deleted. To - [GET /v1/accounts/billing-documents/files/deletion-jobs/{jobId}](https://developer.zuora.com/v1-api-reference/api/billing-documents/get_billingdocumentfilesdeletionjob.md): Retrieves information about an asynchronous job of permanently deleting all billing document PDF files for specific accounts. **Note**: This operation can be used only if you have the Billing user per - [POST /v1/accounts/{key}/billing-documents/generate](https://developer.zuora.com/v1-api-reference/api/billing-documents/post_generatebillingdocuments.md): Generates draft or posted billing documents for a specified account. You can also generate billing documents for specified subscriptions of a specified account. The billing documents contain invoices ## Invoices - [POST /v1/invoices](https://developer.zuora.com/v1-api-reference/api/invoices/post_standaloneinvoice.md): Creates a standalone invoice for selling physical goods, services or other items on a non-recurring basis to your subscription customers. To use this operation, you must have the **Modify Invoice** an - [PUT /v1/invoices](https://developer.zuora.com/v1-api-reference/api/invoices/put_batchupdateinvoices.md): Updates multiple invoices in batches with one call. The following tutorials demonstrate how to use this operation: - Add and delete invoice items of draft standalone invoices - Edit due dates of draft - [POST /v1/invoices/batch](https://developer.zuora.com/v1-api-reference/api/invoices/post_standaloneinvoices.md): Creates multiple standalone invoices for selling physical goods, services or other items on a non-recurring basis to your subscription customers. To use this operation, you must have the **Modify Invo - [POST /v1/invoices/bulk-post](https://developer.zuora.com/v1-api-reference/api/invoices/post_postinvoices.md): Posts multiple invoices. You can post a maximum of 50 invoices in one single request. Additionally, you can also update invoice dates while posting the invoices. **Note** : This operation is synchrono - [GET /v1/invoices/pdf-status](https://developer.zuora.com/v1-api-reference/api/invoices/getinvoicepdfstatus.md): Retrieves the PDF generation statuses of a batch of invoices. - [DELETE /v1/invoices/{invoiceKey}](https://developer.zuora.com/v1-api-reference/api/invoices/delete_deleteinvoice.md): Deletes a specific invoice. Whether to delete an invoice synchronously or asynchronously depends on the number of invoice items contained in the invoice. By default, if an invoice contains less than 1 - [GET /v1/invoices/{invoiceKey}](https://developer.zuora.com/v1-api-reference/api/invoices/get_getinvoice.md): Retrieves a specific invoice. - [PUT /v1/invoices/{invoiceKey}](https://developer.zuora.com/v1-api-reference/api/invoices/put_updateinvoice.md): Updates a specific invoice. The following tutorials demonstrate how to use this operation: - Add and delete invoice items of draft standalone invoices - Edit due dates of draft standalone invoices - E - [PUT /v1/invoices/{invoiceKey}/cancel](https://developer.zuora.com/v1-api-reference/api/invoices/cancelinvoice.md): Cancel the invoice synchronously or asynchronously based on the number of invoice items it contains. By default, Zuora cancels invoices with fewer than 1,000 invoice items synchronously and cancels in - [GET /v1/invoices/{invoiceKey}/application-parts](https://developer.zuora.com/v1-api-reference/api/invoices/get_invoiceapplicationparts.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/invoices/{invoiceKey}/emails](https://developer.zuora.com/v1-api-reference/api/invoices/post_emailinvoice.md): Sends a posted invoice to the specified email addresses manually. ### Notes - You must activate the **Manual Email For Invoice | Manual Email For Invoice** notification before emailing invoices. To in - [GET /v1/invoices/{invoiceKey}/files](https://developer.zuora.com/v1-api-reference/api/invoices/get_invoicefiles.md): Retrieves the information about all PDF files of a specified invoice. Invoice PDF files are returned in reverse chronological order by the value of the `versionNumber` field. **Note**: This API only r - [POST /v1/invoices/{invoiceKey}/files](https://developer.zuora.com/v1-api-reference/api/invoices/post_uploadfileforinvoice.md): Uploads 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 permission. See [Billing Permissions](https - [GET /v1/invoices/{invoiceKey}/items](https://developer.zuora.com/v1-api-reference/api/invoices/get_invoiceitems.md): Retrieves the information about all items of a specified invoice. - [GET /v1/invoices/{invoiceKey}/items/{itemId}/taxation-items](https://developer.zuora.com/v1-api-reference/api/invoices/get_taxationitemsofinvoiceitem.md): Retrieves information about the taxation items of a specific invoice item. - [PUT /v1/invoices/{invoiceKey}/reverse](https://developer.zuora.com/v1-api-reference/api/invoices/put_reverseinvoice.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/invoices/{invoiceKey}/split](https://developer.zuora.com/v1-api-reference/api/invoices/splitinvoice.md): Splits a draft invoice into 2 to 20 invoices based on specified amounts or percentages. The source invoice must be in Draft status. For amount-based splits, the sum of all split amounts must exactly e - [POST /v1/invoices/{invoiceKey}/taxation-items](https://developer.zuora.com/v1-api-reference/api/invoices/post_inv_taxationitems.md): Creates taxation items for an invoice. - [POST /v1/invoices/{invoiceKey}/write-off-async](https://developer.zuora.com/v1-api-reference/api/invoices/writeoffinvoiceasync.md): Asynchronously writes off a posted invoice. By writing off an invoice, a credit memo is created and applied to the invoice. If the invoice contains more than 2,000 items, this operation is performed a - [GET /v1/invoices/write-off-async-jobs/{asyncJobId}](https://developer.zuora.com/v1-api-reference/api/invoices/retrieveinvoicewriteoffasyncjob.md): Retrieves information about a specific asynchronous invoice write-off job. **Note:** This operation is only available if you have Invoice Settlement enabled. This feature includes Unapplied Payments, - [PUT /v1/invoices/{invoiceKey}/write-off](https://developer.zuora.com/v1-api-reference/api/invoices/put_writeoffinvoice.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/invoices/{invoiceKey}/unpost](https://developer.zuora.com/v1-api-reference/api/invoices/unpostinvoice.md): Unposts a posted invoice and changes its status to `Draft`. - For invoices with a large number of invoice items, Zuora might process this operation asynchronously. In this case, the response returns ` ## Credit Memos - [GET /v1/credit-memos](https://developer.zuora.com/v1-api-reference/api/credit-memos/get_creditmemos.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/credit-memos](https://developer.zuora.com/v1-api-reference/api/credit-memos/post_creditmemofromprpc.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/credit-memos/bulk](https://developer.zuora.com/v1-api-reference/api/credit-memos/post_createcreditmemos.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/credit-memos/bulk](https://developer.zuora.com/v1-api-reference/api/credit-memos/put_updatecreditmemos.md): **Notes:** - This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally availa - [GET /v1/credit-memos/pdf-status](https://developer.zuora.com/v1-api-reference/api/credit-memos/get_creditmemopdfstatus.md): Retrieves the PDF generation statuses of a batch of credit memos. - [GET /v1/credit-memos/{creditMemoId}/items/{cmitemid}/taxation-items](https://developer.zuora.com/v1-api-reference/api/credit-memos/get_taxationitemsofcreditmemoitem.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/credit-memos/{creditMemoId}/write-off](https://developer.zuora.com/v1-api-reference/api/credit-memos/put_writeoffcreditmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [DELETE /v1/credit-memos/{creditMemoKey}](https://developer.zuora.com/v1-api-reference/api/credit-memos/delete_creditmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/credit-memos/{creditMemoKey}](https://developer.zuora.com/v1-api-reference/api/credit-memos/get_creditmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/credit-memos/{creditMemoKey}](https://developer.zuora.com/v1-api-reference/api/credit-memos/put_updatecreditmemo.md): **Notes:** - This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally availa - [PUT /v1/credit-memos/{creditMemoKey}/apply](https://developer.zuora.com/v1-api-reference/api/credit-memos/put_applycreditmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/credit-memos/{creditMemoKey}/cancel](https://developer.zuora.com/v1-api-reference/api/credit-memos/put_cancelcreditmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/credit-memos/{creditMemoKey}/emails](https://developer.zuora.com/v1-api-reference/api/credit-memos/post_emailcreditmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/credit-memos/{creditMemoKey}/files](https://developer.zuora.com/v1-api-reference/api/credit-memos/post_uploadfileforcreditmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/credit-memos/{creditMemoKey}/files](https://developer.zuora.com/v1-api-reference/api/credit-memos/get_creditmemofiles.md): Retrieves the information about all PDF files of a specified credit memo. Credit Memo PDF files are returned in reverse chronological order by the value of the `versionNumber` field. **Note**: This AP - [GET /v1/credit-memos/{creditMemoKey}/items](https://developer.zuora.com/v1-api-reference/api/credit-memos/get_creditmemoitems.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/credit-memos/{creditMemoKey}/items/{cmitemid}](https://developer.zuora.com/v1-api-reference/api/credit-memos/get_creditmemoitem.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/credit-memos/{creditMemoKey}/parts](https://developer.zuora.com/v1-api-reference/api/credit-memos/get_creditmemoparts.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/credit-memos/{creditMemoKey}/parts/{partid}](https://developer.zuora.com/v1-api-reference/api/credit-memos/get_creditmemopart.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/credit-memos/{creditMemoKey}/pdfs](https://developer.zuora.com/v1-api-reference/api/credit-memos/post_creditmemopdf.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/credit-memos/{creditMemoKey}/post](https://developer.zuora.com/v1-api-reference/api/credit-memos/put_postcreditmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/credit-memos/{creditMemoKey}/refund](https://developer.zuora.com/v1-api-reference/api/credit-memos/post_refundcreditmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/credit-memos/{creditMemoKey}/reverse](https://developer.zuora.com/v1-api-reference/api/credit-memos/put_reversecreditmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/credit-memos/{creditMemoKey}/taxation-items](https://developer.zuora.com/v1-api-reference/api/credit-memos/post_cm_taxationitems.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/credit-memos/{creditMemoKey}/unapply](https://developer.zuora.com/v1-api-reference/api/credit-memos/put_unapplycreditmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/credit-memos/{creditMemoKey}/unpost](https://developer.zuora.com/v1-api-reference/api/credit-memos/put_unpostcreditmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/credit-memos/invoice/{invoiceKey}](https://developer.zuora.com/v1-api-reference/api/credit-memos/post_creditmemofrominvoice.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/credit-memos/unapply-async-jobs/{unapplyAsyncJobId}](https://developer.zuora.com/v1-api-reference/api/credit-memos/getunapplycreditmemoasyncjob.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/credit-memos/apply-async-jobs/{applyAsyncJobId}](https://developer.zuora.com/v1-api-reference/api/credit-memos/getapplycreditmemoasyncjob.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/credit-memos/{creditMemoKey}/apply-async](https://developer.zuora.com/v1-api-reference/api/credit-memos/applycreditmemoasync.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/credit-memos/{creditMemoKey}/unapply-async](https://developer.zuora.com/v1-api-reference/api/credit-memos/unapplycreditmemoasync.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available ## Debit Memos - [GET /v1/debit-memos](https://developer.zuora.com/v1-api-reference/api/debit-memos/get_debitmemos.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/debit-memos](https://developer.zuora.com/v1-api-reference/api/debit-memos/post_debitmemofromprpc.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/debit-memos](https://developer.zuora.com/v1-api-reference/api/debit-memos/put_updatedebitmemosduedates.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/debit-memos/bulk](https://developer.zuora.com/v1-api-reference/api/debit-memos/post_createdebitmemos.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/debit-memos/bulk](https://developer.zuora.com/v1-api-reference/api/debit-memos/put_updatedebitmemos.md): **Notes:** - This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally availa - [GET /v1/debit-memos/pdf-status](https://developer.zuora.com/v1-api-reference/api/debit-memos/get_debitmemopdfstatus.md): Retrieves the PDF generation statuses of a batch of debit memos. - [GET /v1/debit-memos/{debitMemoId}/application-parts](https://developer.zuora.com/v1-api-reference/api/debit-memos/get_debitmemoapplicationparts.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/debit-memos/{debitMemoId}/items/{dmitemid}/taxation-items](https://developer.zuora.com/v1-api-reference/api/debit-memos/get_taxationitemsofdebitmemoitem.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [DELETE /v1/debit-memos/{debitMemoKey}](https://developer.zuora.com/v1-api-reference/api/debit-memos/delete_debitmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/debit-memos/{debitMemoKey}](https://developer.zuora.com/v1-api-reference/api/debit-memos/get_debitmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/debit-memos/{debitMemoKey}](https://developer.zuora.com/v1-api-reference/api/debit-memos/put_debitmemo.md): **Notes:** - This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally availa - [PUT /v1/debit-memos/{debitMemoKey}/cancel](https://developer.zuora.com/v1-api-reference/api/debit-memos/put_canceldebitmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/debit-memos/{debitMemoKey}/collect](https://developer.zuora.com/v1-api-reference/api/debit-memos/post_debitmemocollect.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/debit-memos/{debitMemoKey}/emails](https://developer.zuora.com/v1-api-reference/api/debit-memos/post_emaildebitmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/debit-memos/{debitMemoKey}/files](https://developer.zuora.com/v1-api-reference/api/debit-memos/post_uploadfilefordebitmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/debit-memos/{debitMemoKey}/files](https://developer.zuora.com/v1-api-reference/api/debit-memos/get_debitmemofiles.md): Retrieves the information about all PDF files of a specified debit memo. Debit Memo PDF files are returned in reverse chronological order by the value of the `versionNumber` field. **Note**: This API - [GET /v1/debit-memos/{debitMemoKey}/items](https://developer.zuora.com/v1-api-reference/api/debit-memos/get_debitmemoitems.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/debit-memos/{debitMemoKey}/items/{dmitemid}](https://developer.zuora.com/v1-api-reference/api/debit-memos/get_debitmemoitem.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/debit-memos/{debitMemoKey}/pdfs](https://developer.zuora.com/v1-api-reference/api/debit-memos/post_debitmemopdf.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/debit-memos/{debitMemoKey}/post](https://developer.zuora.com/v1-api-reference/api/debit-memos/put_postdebitmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/debit-memos/{debitMemoKey}/taxation-items](https://developer.zuora.com/v1-api-reference/api/debit-memos/post_dm_taxationitems.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/debit-memos/{debitMemoKey}/unpost](https://developer.zuora.com/v1-api-reference/api/debit-memos/put_unpostdebitmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/debit-memos/invoice/{invoiceKey}](https://developer.zuora.com/v1-api-reference/api/debit-memos/post_debitmemofrominvoice.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/debit-memos/{debitMemoKey}/write-off](https://developer.zuora.com/v1-api-reference/api/debit-memos/put_writeoffdebitmemo.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available ## E-Invoicing - [GET /v1/einvoice/service-providers](https://developer.zuora.com/v1-api-reference/api/e-invoicing/get_einvoicingserviceproviders.md): Lists information about e-invoicing service providers. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. - [POST /v1/einvoice/service-providers](https://developer.zuora.com/v1-api-reference/api/e-invoicing/post_einvoicingserviceprovider.md): Creates an e-invoicing service provider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. - [DELETE /v1/einvoice/service-providers/{key}](https://developer.zuora.com/v1-api-reference/api/e-invoicing/delete_einvoicingserviceprovider.md): Deletes an e-invoicing service privider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. - [GET /v1/einvoice/service-providers/{key}](https://developer.zuora.com/v1-api-reference/api/e-invoicing/get_einvoicingserviceprovider.md): Retrieves information about an e-invoicing service privider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. - [PUT /v1/einvoice/service-providers/{key}](https://developer.zuora.com/v1-api-reference/api/e-invoicing/put_updateeinvoicingserviceprovider.md): Updates information about an e-invoicing service privider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. - [GET /v1/einvoice/business-regions](https://developer.zuora.com/v1-api-reference/api/e-invoicing/get_einvoicingbusinessregions.md): Lists information about e-invoicing business regions. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. - [POST /v1/einvoice/business-regions](https://developer.zuora.com/v1-api-reference/api/e-invoicing/post_createeinvoicingbusinessregion.md): Creates an e-invoicing business region. You must create business regions to store the business detail information as a seller. If you have multiple GSTINs for different states, you can create multiple - [DELETE /v1/einvoice/business-regions/{key}](https://developer.zuora.com/v1-api-reference/api/e-invoicing/delete_einvoicingbusinessregion.md): Deletes an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region. **Note**: This operation is available only if you have the E-Invoicing feature - [GET /v1/einvoice/business-regions/{key}](https://developer.zuora.com/v1-api-reference/api/e-invoicing/get_einvoicingbusinessregion.md): Retrieves information about an e-invoicing business region. You can search for an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region. **Note** - [PUT /v1/einvoice/business-regions/{key}](https://developer.zuora.com/v1-api-reference/api/e-invoicing/put_updateeinvoicingbusinessregion.md): Updates an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region. **Note**: This operation is available only if you have the E-Invoicing feature - [GET /v1/e-invoice/mandates](https://developer.zuora.com/v1-api-reference/api/e-invoicing/geteinvoicemandates.md): Fetches mandates for downloading files based on the country code, category, and process type selection. This API operation returns the the list of file formats in which the document can be downloaded. - [GET /v1/invoices/{invoiceKey}/e-invoice/mandate](https://developer.zuora.com/v1-api-reference/api/e-invoicing/geteinvoicemandateoninvoice.md): Fetches mandates for downloading e-invoice based on the country code, category, and process type selection. **Note**: This operation is available only if you have the E-Invoicing feature for Avalara i - [GET /v1/credit-memos/{creditMemoKey}/e-invoice/mandate](https://developer.zuora.com/v1-api-reference/api/e-invoicing/geteinvoicecreditmemomandate.md): Fetches mandates for downloading a Credit Memo file based on the country code, category, and process type selection. **Note**: This operation is available only if you have the E-Invoicing feature for - [GET /v1/debit-memos/{debitMemoKey}/e-invoice/mandate](https://developer.zuora.com/v1-api-reference/api/e-invoicing/geteinvoicedebitmemomandate.md): Fetches mandates for downloading a Debit Memo file based on the country code, category, and process type selection. **Note**: This operation is available only if you have the E-Invoicing feature for A - [GET /v1/invoices/{invoiceKey}/e-invoice/download](https://developer.zuora.com/v1-api-reference/api/e-invoicing/downloadeinvoiceofspecifiedformat.md): Downloads the e-invoice based on the selected file format. The system supports XML, UBL, PNG, or QR codes formats that each country requires or supports. - [GET /v1/credit-memos/{creditMemoKey}/e-invoice/download](https://developer.zuora.com/v1-api-reference/api/e-invoicing/downloadcreditmemoeinvoice.md): Downloads the credit memo based on the specified file format. The system supports XML, UBL, PNG, or QR codes formats that each country requires or supports. - [GET /v1/debit-memos/{debitMemoKey}/e-invoice/download](https://developer.zuora.com/v1-api-reference/api/e-invoicing/downloaddebitmemoeinvoice.md): Downloads the debit memo based on the specified file format. The system supports XML, UBL, PNG, or QR codes formats that each country requires or supports. - [PUT /v1/invoices/{invoiceKey}/e-invoice/cancel](https://developer.zuora.com/v1-api-reference/api/e-invoicing/canceleinvoicebyinvoicekey.md): Cancels the E-Invoice for the given billing document - [GET /v1/einvoice/templates](https://developer.zuora.com/v1-api-reference/api/e-invoicing/get_einvoicefiletemplates.md): Lists information about e-invoice file templates. You can query e-invoice file templates by conditions. For example, if your service provider is Sovos, you can use the following example URL to retriev - [POST /v1/einvoice/templates](https://developer.zuora.com/v1-api-reference/api/e-invoicing/post_createeinvoicefiletemplate.md): Creates an e-invoice file templates for your billing documents, including invoices, credit memos, and debit memos. Zuora provides default e-invoice file templates, so you can just customize them as ne - [DELETE /v1/einvoice/templates/{key}](https://developer.zuora.com/v1-api-reference/api/e-invoicing/delete_einvoicefiletemplate.md): Deletes an e-invoice file template by key. The key can be the unique ID or number of an e-invoice file template. **Note**: This operation is available only if you have the E-Invoicing feature in **Ear - [GET /v1/einvoice/templates/{key}](https://developer.zuora.com/v1-api-reference/api/e-invoicing/get_einvoicefiletemplate.md): Retrieves information about an e-invoice file template. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. - [PUT /v1/einvoice/templates/{key}](https://developer.zuora.com/v1-api-reference/api/e-invoicing/put_einvoicefiletemplate.md): Updates information about an e-invoice file template. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. - [PUT /v1/invoices/{invoiceKey}/e-invoice/sync-status](https://developer.zuora.com/v1-api-reference/api/e-invoicing/updateinvoiceinvokesyncstatus.md): Initiates a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the e-Invoice. **Note**: This API can on - [PUT /v1/debit-memos/{debitMemoKey}/e-invoice/sync-status](https://developer.zuora.com/v1-api-reference/api/e-invoicing/updatedebitmemoinvokesyncstatus.md): Initiates a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the debit memo. **Note**: This API can o - [PUT /v1/credit-memos/{creditMemoKey}/e-invoice/sync-status](https://developer.zuora.com/v1-api-reference/api/e-invoicing/updatecreditmemoinvokesyncstatus.md): Initiates a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the credit memo. **Note**: This API can - [PUT /v1/invoices/{invoiceKey}/einvoice/generate](https://developer.zuora.com/v1-api-reference/api/e-invoicing/put_generationeinvoicegenerationforinvoices.md): Generates an e-invoice file for an invoice. If the invoice status is **Failed** during e-invoice generation, you can use **Regenerate E-Invoice**. Once you fix the errors and trigger the regeneration, - [PUT /v1/credit-memos/{creditMemoKey}/e-invoice/generate](https://developer.zuora.com/v1-api-reference/api/e-invoicing/put_generateeinvoicefileforcreditmemo.md): Generates an e-invoice file for a credit memo. If the Credit Memo status is **Failed** during e-invoice generation, you can use **Regenerate E-Invoice**. Once you fix the errors and trigger the regene - [PUT /v1/debit-memos/{debitMemoKey}/e-invoice/generate](https://developer.zuora.com/v1-api-reference/api/e-invoicing/put_generateeinvoicefilefordebitmemo.md): Generates an e-invoice file for a debit memo. If the Credit Memo status is **Failed** during e-invoice generation, you can use **Regenerate E-Invoice**. Once you fix the errors and trigger the regener - [POST /v1/e-compliance/lifecycle/status-update](https://developer.zuora.com/v1-api-reference/api/e-invoicing/createeinvoicelifecyclestatusupdate.md): Creates a seller-initiated status update request for an e-invoice lifecycle. Use this operation to notify the tax authority when the business status of a source document changes, such as when payment - [GET /v1/e-compliance/lifecycle/status-updates](https://developer.zuora.com/v1-api-reference/api/e-invoicing/geteinvoicelifecyclestatusupdates.md): Lists e-invoice business lifecycle status update audit records, optionally filtered by document, status, and requested action. - [GET /v1/e-compliance/lifecycle/status-updates/{key}](https://developer.zuora.com/v1-api-reference/api/e-invoicing/geteinvoicelifecyclestatusupdate.md): Retrieves a single e-invoice business lifecycle status update audit record by its unique identifier. - [POST /v1/e-compliance/reconcile](https://developer.zuora.com/v1-api-reference/api/e-invoicing/reconcileecompliance.md): Reconciles an e-compliance request for the supplied source object. **Note**: In the broader e-compliance workflow, this operation can work alongside the "Create an e-invoice lifecycle status update" o - [POST /v1/e-compliance/trigger](https://developer.zuora.com/v1-api-reference/api/e-invoicing/triggerecompliancerequest.md): Creates an e-compliance request for the supplied source object. - [POST /v1/e-compliance/regenerate](https://developer.zuora.com/v1-api-reference/api/e-invoicing/regenerateecompliancerequest.md): Regenerates a failed or rejected e-compliance request. ## E-Reporting - [POST /v1/e-compliance/reconcile](https://developer.zuora.com/v1-api-reference/api/e-reporting/reconcileecompliance.md): Reconciles an e-compliance request for the supplied source object. **Note**: In the broader e-compliance workflow, this operation can work alongside the "Create an e-invoice lifecycle status update" o - [GET /v1/e-reporting/templates](https://developer.zuora.com/v1-api-reference/api/e-reporting/getereportingtemplates.md): Lists information about e-reporting templates. - [POST /v1/e-reporting/templates](https://developer.zuora.com/v1-api-reference/api/e-reporting/createereportingtemplate.md): Creates an e-reporting template. - [DELETE /v1/e-reporting/templates/{key}](https://developer.zuora.com/v1-api-reference/api/e-reporting/deleteereportingtemplate.md): Deletes an e-reporting template. - [GET /v1/e-reporting/templates/{key}](https://developer.zuora.com/v1-api-reference/api/e-reporting/getereportingtemplate.md): Retrieves an e-reporting template. - [PUT /v1/e-reporting/templates/{key}](https://developer.zuora.com/v1-api-reference/api/e-reporting/updateereportingtemplate.md): Updates an e-reporting template - [GET /v1/e-reporting/business-regions](https://developer.zuora.com/v1-api-reference/api/e-reporting/listereportingbusinessregions.md): Lists e-reporting business regions. - [POST /v1/e-reporting/business-regions](https://developer.zuora.com/v1-api-reference/api/e-reporting/createereportingbusinessregion.md): Creates an e-reporting business region. - [DELETE /v1/e-reporting/business-regions/{key}](https://developer.zuora.com/v1-api-reference/api/e-reporting/deleteereportingbusinessregion.md): Deletes an e-reporting business region. - [GET /v1/e-reporting/business-regions/{key}](https://developer.zuora.com/v1-api-reference/api/e-reporting/getereportingbusinessregion.md): Retrieves an e-reporting business region. - [PUT /v1/e-reporting/business-regions/{key}](https://developer.zuora.com/v1-api-reference/api/e-reporting/updateereportingbusinessregion.md): Updates an e-reporting business region. - [GET /v1/e-compliance/e-reporting/requests](https://developer.zuora.com/v1-api-reference/api/e-reporting/getereportingrequests.md): Lists e-reporting requests, optionally filtered by source object and status. - [GET /v1/e-compliance/e-reporting/requests/{key}](https://developer.zuora.com/v1-api-reference/api/e-reporting/getereportingrequest.md): Retrieves a single e-reporting request by its unique identifier. - [GET /v1/e-compliance/{complianceType}/files/{sourceObjectType}/{sourceObjectId}](https://developer.zuora.com/v1-api-reference/api/e-reporting/downloadecompliancefile.md): Downloads the provider-certified compliance document for the given source object. The response Content-Type depends on the format returned by the provider (e.g. application/xml or application/pdf). - [GET /v1/e-compliance/{complianceType}/snapshots/{sourceObjectType}/{sourceObjectId}](https://developer.zuora.com/v1-api-reference/api/e-reporting/downloadecompliancesnapshot.md): Downloads the provider-certified compliance snapshot for the given source object. The snapshot contains the raw payload submitted to the compliance provider. - [POST /v1/e-compliance/trigger](https://developer.zuora.com/v1-api-reference/api/e-reporting/triggerecompliancerequest.md): Creates an e-compliance request for the supplied source object. - [POST /v1/e-compliance/regenerate](https://developer.zuora.com/v1-api-reference/api/e-reporting/regenerateecompliancerequest.md): Regenerates a failed or rejected e-compliance request. ## Invoice Schedules - [POST /v1/invoice-schedules](https://developer.zuora.com/v1-api-reference/api/invoice-schedules/post_createinvoiceschedule.md): Creates an invoice schedule. ### Limitations This API operation has the following limitations: * You can create at most 50 invoice schedule items in one request. * You can associate at most 10 orders - [DELETE /v1/invoice-schedules/{scheduleKey}](https://developer.zuora.com/v1-api-reference/api/invoice-schedules/delete_invoiceschedule.md): Deletes an invoice schedule in Pending status. The status of the invoice schedule to be deleted must be `Pending`. **Note**: This operation is available only if you have the Billing Schedule feature e - [GET /v1/invoice-schedules/{scheduleKey}](https://developer.zuora.com/v1-api-reference/api/invoice-schedules/get_invoiceschedule.md): Retrieves detailed information about an invoice schedule. **Note**: This operation is available only if you have the Billing Schedule feature enabled. - [PUT /v1/invoice-schedules/{scheduleKey}](https://developer.zuora.com/v1-api-reference/api/invoice-schedules/put_updateinvoiceschedule.md): Updates a pending invoice schedule. You can use this API operation to update invoice schedules in the following aspects: - Update notes and pending invoice schedule items - Update orders associated wi - [POST /v1/invoice-schedules/{scheduleKey}/execute](https://developer.zuora.com/v1-api-reference/api/invoice-schedules/post_executeinvoiceschedule.md): Executes an invoice schedule immediately. During the execution, a bill run is created and generates an invoice or a credit memo asynchronously. When you use this API operation to execute an invoice sc - [PUT /v1/invoice-schedules/{scheduleKey}/pause](https://developer.zuora.com/v1-api-reference/api/invoice-schedules/put_pauseinvoiceschedule.md): Pauses an invoice schedule immediately. A paused invoice schedule and charges inside cannot be automatically executed by Zuora Scheduler or by the Execute an invoice schedule API operation. In this ca - [PUT /v1/invoice-schedules/{scheduleKey}/resume](https://developer.zuora.com/v1-api-reference/api/invoice-schedules/put_resumeinvoiceschedule.md): Resumes an invoice schedule in Paused status immediately. After an invoice schedule is resumed, it can continue to be automatically executed by Zuora Scheduler or by the [Execute an invoice schedule]( - [PUT /v1/invoice-schedules/{scheduleKey}/detach](https://developer.zuora.com/v1-api-reference/api/invoice-schedules/detachchargesfrominvoiceschedule.md): Detaches charges from an invoice schedule. The invoice schedules you want to detach charges from must be in Fully Processed or Partially Processed status. Invoice schedules do not bill detached charge - [PUT /v1/invoice-schedules/{scheduleKey}/attach](https://developer.zuora.com/v1-api-reference/api/invoice-schedules/attachchargestoinvoiceschedule.md): Attaches charges to an invoice schedule. The invoice schedules you want to attach charges to must be in Fully Processed or Partially Processed status. You can attach charges only if they were previou ## Taxation Items - [POST /v1/object/taxation-item](https://developer.zuora.com/v1-api-reference/api/taxation-items/object_posttaxationitem.md): Creates a Taxation Item object. - [DELETE /v1/taxation-items/{id}](https://developer.zuora.com/v1-api-reference/api/taxation-items/delete_taxationitem.md): Deletes a specific taxation item by ID. - [GET /v1/taxation-items/{id}](https://developer.zuora.com/v1-api-reference/api/taxation-items/get_taxationitem.md): Retrieves the information about a specific taxation item by ID. - [PUT /v1/taxation-items/{id}](https://developer.zuora.com/v1-api-reference/api/taxation-items/put_taxationitem.md): Updates a specific taxation item by ID. ## Sequence Sets - [GET /v1/sequence-sets](https://developer.zuora.com/v1-api-reference/api/sequence-sets/get_sequencesets.md): Retrieves information about all sequence sets configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. You can use query parameters t - [POST /v1/sequence-sets](https://developer.zuora.com/v1-api-reference/api/sequence-sets/post_sequencesets.md): Creates sequence sets, allowing distinct numbering sequences for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. You can create a maximum o - [DELETE /v1/sequence-sets/{id}](https://developer.zuora.com/v1-api-reference/api/sequence-sets/delete_sequenceset.md): Deletes a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. **Note**: The Credit and Debit Memos feature - [GET /v1/sequence-sets/{id}](https://developer.zuora.com/v1-api-reference/api/sequence-sets/get_sequenceset.md): Retrieves information about a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos **Note**: The Credit and - [PUT /v1/sequence-sets/{id}](https://developer.zuora.com/v1-api-reference/api/sequence-sets/put_sequenceset.md): Updates a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. **Note**: The Credit and Debit Memos feature ## Operations - [POST /v1/operations/billing-preview](https://developer.zuora.com/v1-api-reference/api/operations/post_billingpreview.md): Generates a preview of future invoice items for one customer account. Use the BillingPreview call to calculate how much a single customer will be invoiced from the most recent invoice to a specific en - [POST /v1/operations/invoice-collect](https://developer.zuora.com/v1-api-reference/api/operations/post_transactioninvoicepayment.md): Generates and posts invoices and credit memos, and collects payments for posted invoices. Credit memos are only available if you have the Invoice Settlement feature enabled and negative charges exist. - [GET /v1/operations/jobs/{jobId}](https://developer.zuora.com/v1-api-reference/api/operations/get_operationjob.md): Retrieves information about a specific operation job. Currently, you can use this API operation to retrieve the status information about invoice deletion and reversal operation jobs, as well as summa - [POST /v1/operations/bulk-pdf](https://developer.zuora.com/v1-api-reference/api/operations/create_bulkpdftozipgeneration.md): The background job that compresses large number of PDF(s) into ZIP files. For answers to frequently asked questions regarding exporting bulk PDF files, see Export Bulk PDF Files FAQs. **Note**: Do not - [GET /v1/operations/bulk-pdf/{jobId}](https://developer.zuora.com/v1-api-reference/api/operations/get_bulkpdftozipgeneration.md): Retrieves information about the job which includes its status, message, and downloadable ZIP file URL link. ## Summary Statements - [POST /v1/summary-statement-runs](https://developer.zuora.com/v1-api-reference/api/summary-statements/createsummarystatementrun.md): Allows you to initiate the generation of a summary statement run. You can specify parameters such as the run type (AdHoc or scheduled) and the target account categories (single or multiple accounts). - [DELETE /v1/summary-statement-runs/{summaryStatementRunKey}](https://developer.zuora.com/v1-api-reference/api/summary-statements/deletesummarystatementrun.md): Deletes a specific summary statement run and all its associated statements. Whether to delete a run synchronously or asynchronously depends on the number of statements contained in the run. By default - [DELETE /v1/summary-statements/{summaryStatementKey}](https://developer.zuora.com/v1-api-reference/api/summary-statements/deletesummarystatement.md): Deletes a specific summary statement. You can delete a summary statement only when both the summary statement and its parent summary statement run are in terminal states. Allowed summary statement sta ## Bill Run - [POST /v1/bill-runs](https://developer.zuora.com/v1-api-reference/api/bill-run/post_createbillrun.md): Creates an ad-hoc bill run or a scheduled bill run. Support the following: - Create ad-hoc or scheduled bill runs by batch - Create ad-hoc or scheduled bill runs by account - Create a bill run by subs - [DELETE /v1/bill-runs/{billRunId}](https://developer.zuora.com/v1-api-reference/api/bill-run/delete_deletebillrun.md): Deletes a bill run. You can only delete bill runs in `Canceled` or `Error` status. - [GET /v1/bill-runs/{billRunId}](https://developer.zuora.com/v1-api-reference/api/bill-run/get_billrun.md): Retrieves the information about a specific bill run. - [PUT /v1/bill-runs/{billRunId}/cancel](https://developer.zuora.com/v1-api-reference/api/bill-run/put_cancelbillrun.md): Cancels a bill run in Draft status. When cancelling a scheduled bill run, keep the following information in mind: - If you set `cancelOnce` to `true`, only the current bill run is cancelled. The other - [PUT /v1/bill-runs/{billRunId}/post](https://developer.zuora.com/v1-api-reference/api/bill-run/put_postbillrun.md): Posts a bill run asynchronously. To post a bill run, the current bill run must be in `Completed` status. When a bill run is being posted, its status is changed to `PostInProgress`. After all invoices - [POST /v1/bill-runs/{billRunKey}/emails](https://developer.zuora.com/v1-api-reference/api/bill-run/post_emailbillingdocumentsfrombillrun.md): Manually emails all the billing documents that are generated from a specified bill run to your customers. Bill runs can generate invoices and credit memos based on your [invoice and credit memo genera ## Billing Preview Run - [POST /v1/billing-preview-runs](https://developer.zuora.com/v1-api-reference/api/billing-preview-run/post_billingpreviewrun.md): Creates a billing preview run for single and multiple customer accounts. The maximum supported preview duration is 20 years, calculated from the current date to the target date. You can run up to 20 b - [GET /v1/billing-preview-runs/{billingPreviewRunId}](https://developer.zuora.com/v1-api-reference/api/billing-preview-run/get_billingpreviewrun.md): Retrieves a preview of future invoice items for multiple customer accounts through a billing preview run. If you have the Invoice Settlement feature enabled, you can also retrieve a preview of future ## Payment Methods - [POST /v1/payment-methods](https://developer.zuora.com/v1-api-reference/api/payment-methods/post_paymentmethods.md): 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. To view the appl - [POST /v1/payment-methods/decryption](https://developer.zuora.com/v1-api-reference/api/payment-methods/post_paymentmethodsdecryption.md): 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 information * - [DELETE /v1/payment-methods/{payment-method-id}](https://developer.zuora.com/v1-api-reference/api/payment-methods/delete_paymentmethods.md): Deletes 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 first designate a different payment metho - [GET /v1/payment-methods/{payment-method-id}](https://developer.zuora.com/v1-api-reference/api/payment-methods/get_paymentmethod.md): Use this operation to get the detailed information of an electronic payment method. To retrieve information of both electronic and non-electronic payment methods, use the [Object Query](https://develo - [PUT /v1/payment-methods/{payment-method-id}](https://developer.zuora.com/v1-api-reference/api/payment-methods/put_paymentmethod.md): This operation allows you to update an existing payment method. The following fields in the request body can be updated for any payment method types: - `maxConsecutivePaymentFailures` - `paymentRetryW - [PUT /v1/payment-methods/{payment-method-id}/verify](https://developer.zuora.com/v1-api-reference/api/payment-methods/put_verifypaymentmethods.md): Sends an authorization request to the corresponding payment gateway to verify the payment method, even though no changes are made for the payment method. Supported payment methods are Credit Cards and - [PUT /v1/payment-methods/{payment-method-id}/scrub](https://developer.zuora.com/v1-api-reference/api/payment-methods/put_scrubpaymentmethods.md): 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 Zuora database - [GET /v1/payment-methods/{payment-method-id}/balance](https://developer.zuora.com/v1-api-reference/api/payment-methods/getbankaccountbalance.md): Zuora supports Plaid's Auth and Balance products for ACH transactions. Auth authenticates account details before sending requests to the gateway, while Balance checks the real-time account balance bef - [GET /v1/payment-methods/{payment-method-id}/profiles](https://developer.zuora.com/v1-api-reference/api/payment-methods/get_storedcredentialprofiles.md): Retrieves the stored credential profiles within a payment method. - [POST /v1/payment-methods/{payment-method-id}/profiles](https://developer.zuora.com/v1-api-reference/api/payment-methods/post_createstoredcredentialprofile.md): Creates a stored credential profile within a payment method. The stored credential profile represents a consent agreement that you have established with a customer. When you use the payment method in - [POST /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel](https://developer.zuora.com/v1-api-reference/api/payment-methods/post_cancelstoredcredentialprofile.md): Cancels a stored credential profile within a payment method. Cancelling the stored credential profile indicates that the stored credentials are no longer valid, per a customer request. You cannot rea - [POST /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire](https://developer.zuora.com/v1-api-reference/api/payment-methods/post_expirestoredcredentialprofile.md): Expires a stored credential profile within a payment method. Expiring the stored credential profile indicates that the stored credentials are no longer valid, per an expiration policy in the stored c - [POST /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/profile-data](https://developer.zuora.com/v1-api-reference/api/payment-methods/addgatewayprofiledata.md): Adds gateway profile data to an existing stored credential profile within a payment method. Use this operation to seed or backfill gateway-specific data, such as the `authGateway` and `networkTransact - [GET /v1/payment-methods/wallet/domains](https://developer.zuora.com/v1-api-reference/api/payment-methods/getwalletdomains.md): Use this operation to retreive list of registered domains. You can use `domainName` as the query parameter to restrict domains returned in the response. Specify a domain name and the registered domain - [POST /v1/payment-methods/wallet/domains](https://developer.zuora.com/v1-api-reference/api/payment-methods/registerwalletdomain.md): 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. Use this operati - [DELETE /v1/payment-methods/wallet/domains/{id}](https://developer.zuora.com/v1-api-reference/api/payment-methods/deleteunregisterwalletdomain.md): Use this operation to unregister a wallet domain. - [POST /web-payments/sessions](https://developer.zuora.com/v1-api-reference/api/payment-methods/post_createpaymentsession.md): Use this operation to create a payment session on your server side. The response contains a token for the payment session data. In addition to the required `accountId` and `currency` fields, you can s ## Custom Payment Method Types - [POST /open-payment-method-types](https://developer.zuora.com/v1-api-reference/api/custom-payment-method-types/post_createdraftopenpaymentmethodtype.md): Creates a draft version of a custom payment method type. Revision number 1 is assigned to this version. You can update your draft version through the [Update a custom payment method type](https://deve - [PUT /open-payment-method-types/publish/{paymentMethodTypeName}](https://developer.zuora.com/v1-api-reference/api/custom-payment-method-types/put_publishopenpaymentmethodtype.md): Publish the latest draft revision of a specific custom payment method type. - [PUT /open-payment-method-types/{paymentMethodTypeName}](https://developer.zuora.com/v1-api-reference/api/custom-payment-method-types/put_updateopenpaymentmethodtype.md): Update the latest draft version of your custom payment method type. If the latest draft version has been published, the revision number is increased by 1 after the draft version is updated. You must p - [GET /open-payment-method-types/{paymentMethodTypeName}/draft/{revisionNumber}](https://developer.zuora.com/v1-api-reference/api/custom-payment-method-types/get_openpaymentmethodtyperevision.md): Retrieves a specific draft revision of a custom payment method type. - [GET /open-payment-method-types/{paymentMethodTypeName}/published](https://developer.zuora.com/v1-api-reference/api/custom-payment-method-types/get_openpaymentmethodtypepublish.md): Retrieves a published custom payment method type. ## Payment Method Updater - [GET /v1/payment-method-updaters](https://developer.zuora.com/v1-api-reference/api/payment-method-updater/get_paymentmethodupdaterinstances.md): Retrieves the detailed information of all Payment Method Updater (PMU) instances on your tenant, except for American Express (AMEX). - [POST /v1/payment-method-updaters/batches](https://developer.zuora.com/v1-api-reference/api/payment-method-updater/post_paymentmethodupdaterbatch.md): Creates a Payment Method Updater (PMU) batch asynchronously. PMU for American Express (AMEX) is not supported. ## Payment Method Snapshots - [GET /v1/object/payment-method-snapshot/{id}](https://developer.zuora.com/v1-api-reference/api/payment-method-snapshots/object_getpaymentmethodsnapshot.md): This 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 transaction. If the Payment Method is delete ## Payment Method Transaction Logs - [GET /v1/object/payment-method-transaction-log/{id}](https://developer.zuora.com/v1-api-reference/api/payment-method-transaction-logs/object_getpaymentmethodtransactionlog.md): Retrieves a Payment Method Transaction Log object. ## Hosted Pages - [GET /v1/hostedpages](https://developer.zuora.com/v1-api-reference/api/hosted-pages/get_hostedpages.md): Returns the Payment Pages configuration metadata, specifically, page ID, page version, payment method type. The following are the version-specific and general REST requests for Payment Pages: * The re ## RSA Signatures - [POST /v1/rsa-signatures](https://developer.zuora.com/v1-api-reference/api/rsa-signatures/post_rsasignatures.md): The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature. The POST rsa_signatures call generates and returns the required digi - [POST /v1/rsa-signatures/decrypt](https://developer.zuora.com/v1-api-reference/api/rsa-signatures/post_decryptrsasignatures.md): The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature. You use rsa_signatures to generate the required digital signature an ## Payment Authorization - [POST /v1/payment-methods/{payment-method-id}/authorize](https://developer.zuora.com/v1-api-reference/api/payment-authorization/post_createauthorization.md): Enables you to authorize the availability of funds for a transaction but delay the capture of funds until a later time. Subsequently, use [Create a payment](https://developer.zuora.com/api-references/ - [POST /v1/payment-methods/{payment-method-id}/voidAuthorize](https://developer.zuora.com/v1-api-reference/api/payment-authorization/post_cancelauthorization.md): Allows you to cancel an authorization. For gateway integrations that support this operation, see Delayed Capture. ## Payment Gateways - [GET /v1/paymentgateways](https://developer.zuora.com/v1-api-reference/api/payment-gateways/get_paymentgateways.md): Retrieves all payment gateways configured in your tenant in a single, non-paginated response. There is no limit on the number of gateways returned. - [POST /v1/payment-gateways/pre-debit-notification](https://developer.zuora.com/v1-api-reference/api/payment-gateways/triggerpredebitnotification.md): To support processing recurring UPI payments through Adyen Integration v2.0, a pre-debit notification for each posted invoice must be sent to the UPI users before collecting the recurring payments. Us ## Payment Gateway Reconciliation - [POST /v1/gateway-settlement/payments/{payment-key}/chargeback](https://developer.zuora.com/v1-api-reference/api/payment-gateway-reconciliation/post_reversepayment.md): 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 request, and - [POST /v1/gateway-settlement/payments/{payment-key}/reject](https://developer.zuora.com/v1-api-reference/api/payment-gateway-reconciliation/post_rejectpayment.md): 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 returns th - [POST /v1/gateway-settlement/payments/{payment-key}/settle](https://developer.zuora.com/v1-api-reference/api/payment-gateway-reconciliation/post_settlepayment.md): 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. If the Asynchronous - [POST /v1/refunds/{refund-key}/reconcile](https://developer.zuora.com/v1-api-reference/api/payment-gateway-reconciliation/post_reconcilerefund.md): Reconciles a refund when receiving the gateway reconciliation request or event. ## Payments - [GET /v1/payments](https://developer.zuora.com/v1-api-reference/api/payments/get_retrieveallpayments.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [POST /v1/payments](https://developer.zuora.com/v1-api-reference/api/payments/post_createpayment.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/payments/{paymentKey}](https://developer.zuora.com/v1-api-reference/api/payments/put_updatepayment.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [DELETE /v1/payments/{paymentKey}](https://developer.zuora.com/v1-api-reference/api/payments/delete_payment.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/payments/{paymentKey}](https://developer.zuora.com/v1-api-reference/api/payments/get_payment.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/payments/{paymentKey}/apply](https://developer.zuora.com/v1-api-reference/api/payments/put_applypayment.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/payments/{paymentKey}/cancel](https://developer.zuora.com/v1-api-reference/api/payments/put_cancelpayment.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/payments/{paymentKey}/parts](https://developer.zuora.com/v1-api-reference/api/payments/get_paymentparts.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/payments/{paymentKey}/parts/{partid}](https://developer.zuora.com/v1-api-reference/api/payments/get_paymentpart.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/payments/{paymentKey}/parts/{partid}/item-parts](https://developer.zuora.com/v1-api-reference/api/payments/get_paymentitemparts.md): **Note:** This operation is only available if you have the [Invoice Item Settlement](https://docs.zuora.com?resourceId=billing-invoice-item-settlement) feature enabled. Invoice Item Settlement must be - [GET /v1/payments/{paymentKey}/parts/{partid}/item-parts/{itempartid}](https://developer.zuora.com/v1-api-reference/api/payments/get_paymentitempart.md): **Note:** This operation is only available if you have the [Invoice Item Settlement](https://docs.zuora.com?resourceId=billing-invoice-item-settlement) feature enabled. Invoice Item Settlement must be - [POST /v1/payments/{paymentKey}/refunds](https://developer.zuora.com/v1-api-reference/api/payments/post_refundpayment.md): **Note:** This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature incl - [POST /v1/payments/{paymentKey}/refunds/unapply](https://developer.zuora.com/v1-api-reference/api/payments/post_refundpaymentwithautounapply.md): **Note:** This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature incl - [PUT /v1/payments/{paymentKey}/transfer](https://developer.zuora.com/v1-api-reference/api/payments/put_transferpayment.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/payments/{paymentKey}/unapply](https://developer.zuora.com/v1-api-reference/api/payments/put_unapplypayment.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available ## Payment Transaction Logs - [GET /v1/object/payment-transaction-log/{id}](https://developer.zuora.com/v1-api-reference/api/payment-transaction-logs/object_getpaymenttransactionlog.md): Retrieves information about a specific payment transaction log. ## Payment Runs - [GET /v1/payment-runs](https://developer.zuora.com/v1-api-reference/api/payment-runs/get_paymentruns.md): Retrieves the information about all payment runs. You can define filterable fields to restrict the data returned in the response. ### Filtering You can use query parameters to restrict the data return - [POST /v1/payment-runs](https://developer.zuora.com/v1-api-reference/api/payment-runs/post_paymentrun.md): Creates 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 filter the payments to be collected for a pa - [DELETE /v1/payment-runs/{paymentRunKey}](https://developer.zuora.com/v1-api-reference/api/payment-runs/delete_paymentrun.md): Deletes a payment run. Only payment runs with the Canceled or Error status can be deleted. - [GET /v1/payment-runs/{paymentRunKey}](https://developer.zuora.com/v1-api-reference/api/payment-runs/get_paymentrun.md): Retrives the information about a specific payment run. - [PUT /v1/payment-runs/{paymentRunKey}](https://developer.zuora.com/v1-api-reference/api/payment-runs/put_paymentrun.md): Updates the information about an unexecuted payment run. Only pending payment runs can be updated. If none of the **accountId**, **batch**, **billCycleDay**, **currency**, **paymentGatewayId**, and ** - [GET /v1/payment-runs/{paymentRunKey}/data](https://developer.zuora.com/v1-api-reference/api/payment-runs/get_paymentrundata.md): Retrieves payment run data and the processing result with details, if the `data` field was specified in the Create payment run operation. - [GET /v1/payment-runs/{paymentRunKey}/summary](https://developer.zuora.com/v1-api-reference/api/payment-runs/get_paymentrunsummary.md): Retrives the summary of a payment run. ## Payment Schedules - [POST /v1/payment-schedule-items/retry-payment](https://developer.zuora.com/v1-api-reference/api/payment-schedules/post_retrypaymentscheduleitem.md): Retries failed payment schedule items. The payment method and payment gateway of the failed payment can be updated to new values before the retry. Note that you can retry a payment schedule item only - [PUT /v1/payment-schedule-items/{item-id}/cancel](https://developer.zuora.com/v1-api-reference/api/payment-schedules/put_cancelpaymentscheduleitem.md): Cancels a payment schedule item by ID. **Note:** - The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releas - [PUT /v1/payment-schedule-items/{item-id}/skip](https://developer.zuora.com/v1-api-reference/api/payment-schedules/put_skippaymentscheduleitem.md): Skips a payment schedule item by ID. The skipped payment schedule item will turn to the `canceled` status, and a new item will be scheduled on the next recurring date after the last existing scheduled - [GET /v1/payment-schedule-items/{psi-id}](https://developer.zuora.com/v1-api-reference/api/payment-schedules/get_paymentscheduleitem.md): Retrieves a payment schedule item by ID. **Note:** - The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before rele - [PUT /v1/payment-schedule-items/{psi-id}](https://developer.zuora.com/v1-api-reference/api/payment-schedules/put_paymentscheduleitem.md): Updates a payment schedule item by ID. **Note:** - The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releas - [DELETE /v1/payment-schedule-items/{psi-id}](https://developer.zuora.com/v1-api-reference/api/payment-schedules/deletepaymentscheduleitem.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/payment-schedules](https://developer.zuora.com/v1-api-reference/api/payment-schedules/get_paymentschedules.md): Retrieves payment schedules of a customer account. **Note:** - The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters b - [POST /v1/payment-schedules](https://developer.zuora.com/v1-api-reference/api/payment-schedules/post_paymentschedule.md): Creates a payment schedule. You can create either recurring payment schedules or custom payment schedules. **Note:** - This operation is only available if you have [Invoice Settlement](https://docs.zu - [POST /v1/payment-schedules/batch](https://developer.zuora.com/v1-api-reference/api/payment-schedules/post_paymentschedules.md): Creates multiple payment schedules at once. You can create both recurring payment schedules and custom payment schedules in one request. The maximum number of payment schedules that can be created by - [GET /v1/payment-schedules/statistics/{yyyy-mm-dd}](https://developer.zuora.com/v1-api-reference/api/payment-schedules/get_paymentschedulestatistic.md): Retrieves the payment schedule statistic of a specific date. **Note:** - The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early - [GET /v1/payment-schedules/{paymentScheduleKey}](https://developer.zuora.com/v1-api-reference/api/payment-schedules/get_paymentschedule.md): Retrieves a payment schedule by payment schedule key. **Note:** - The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopter - [PUT /v1/payment-schedules/{paymentScheduleKey}](https://developer.zuora.com/v1-api-reference/api/payment-schedules/put_paymentschedule.md): Updates a payment schedule. For custom payment schedules, only the custom fields on the payment schedules can be udpated. Use the [Update a payment schedule item](https://developer.zuora.com/api-refer - [DELETE /v1/payment-schedules/{paymentScheduleKey}](https://developer.zuora.com/v1-api-reference/api/payment-schedules/deletepaymentschedule.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/payment-schedules/{paymentScheduleKey}/cancel](https://developer.zuora.com/v1-api-reference/api/payment-schedules/put_cancelpaymentschedule.md): Cancels a payment schedule. **Note:** - All pending payment schedule items will be canceled, effective from `cancelDate`. - The Payment Schedules feature is in the **Early Adopter** phase. We are acti - [POST /v1/payment-schedules/{paymentScheduleKey}/items](https://developer.zuora.com/v1-api-reference/api/payment-schedules/post_additemstocustompaymentschedule.md): Adds payment schedule items to a custom payment schedule. You cannot use this operation to add payment schedule items to recurring payment schedules. **Note:** - The Payment Schedules feature is in th - [PUT /v1/payment-schedules/{paymentScheduleKey}/preview](https://developer.zuora.com/v1-api-reference/api/payment-schedules/put_paymentscheduleupdatepreview.md): Preview the result of a payment schedule update. This operation only provides a preview. No changes will be made to the database. For custom payment schedules, only the custom fields on the payment sc ## Refunds - [GET /v1/refunds](https://developer.zuora.com/v1-api-reference/api/refunds/get_refunds.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/refunds/{refundKey}](https://developer.zuora.com/v1-api-reference/api/refunds/put_updaterefund.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [DELETE /v1/refunds/{refundKey}](https://developer.zuora.com/v1-api-reference/api/refunds/delete_refund.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/refunds/{refundKey}](https://developer.zuora.com/v1-api-reference/api/refunds/get_refund.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [PUT /v1/refunds/{refundKey}/cancel](https://developer.zuora.com/v1-api-reference/api/refunds/put_cancelrefund.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/refunds/{refundKey}/parts](https://developer.zuora.com/v1-api-reference/api/refunds/get_refundparts.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/refunds/{refundKey}/parts/{refundpartid}](https://developer.zuora.com/v1-api-reference/api/refunds/get_refundpart.md): **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available - [GET /v1/refunds/{refundKey}/parts/{refundpartid}/item-parts](https://developer.zuora.com/v1-api-reference/api/refunds/get_refunditemparts.md): **Note:** This operation is only available if you have the [Invoice Item Settlement](https://docs.zuora.com?resourceId=billing-invoice-item-settlement) feature enabled. Invoice Item Settlement must be - [GET /v1/refunds/{refundKey}/parts/{refundpartid}/item-parts/{itempartid}](https://developer.zuora.com/v1-api-reference/api/refunds/get_refunditempart.md): **Note:** This operation is only available if you have the [Invoice Item Settlement](https://docs.zuora.com?resourceId=billing-invoice-item-settlement) feature enabled. Invoice Item Settlement must be ## Payment Profiles - [PUT /v1/payment-profile](https://developer.zuora.com/v1-api-reference/api/payment-profiles/upsertpaymentprofiles.md): Bulk creates payment profiles or updates payment profiles if they already exist. You can create or update a maximum of 50 payment profiles in a single call. ## Configurable Payment Retry - [GET /api/v1/payments/active_invoice_cycle_information/{invoice_id}](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/getactiveinvoicecycle.md): Gets information of active retry cycles that have not been completed for an invoice in Configurable Payment Retry. - [GET /api/v1/payments/active_debit_memo_cycle_information/{debit_memo_id}](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/getactivedebitmemocycle.md): Gets information of active retry cycles that have not been completed for a debit memo in Configurable Payment Retry. - [GET /api/v1/payments/active_account_cycle_information/{account_id}](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/getactiveaccountcycle.md): Gets information of active retry cycles that have not been completed for an account in Configurable Payment Retry. - [GET /api/v1/payments/invoice_cycle_history/{invoice_id}](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/getinvoicecyclehistory.md): Gets information of all retry cycles for an invoice in Configurable Payment Retry. - [GET /api/v1/payments/debit_memo_cycle_history/{debit_memo_id}](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/getdebitmemocyclehistory.md): Gets information of all retry cycles for a debit memo in Configurable Payment Retry. - [GET /api/v1/payments/account_cycle_history/{account_id}](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/getaccountcyclehistory.md): Gets information of all retry cycles for an account in Configurable Payment Retry. - [PUT /api/v1/payments/execute_invoice_payment/{invoice_id}](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/putexecuteinvoicepayment.md): For all active retry cycles associated with an invoice, schedules the next payment retry attempt to occur in the next hourly payment processor run. - [PUT /api/v1/payments/execute_debit_memo_payment/{debit_memo_id}](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/putexecutedebitmemopayment.md): For all active retry cycles associated with a debit memo, schedules the next payment retry attempt to occur in the next hourly payment processor run. - [PUT /api/v1/payments/execute_account_payments/{account_id}](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/putexecuteaccountpayments.md): For all active retry cycles associated with an account, schedules the next payment retry attempt to occur in the next hourly payment processor run. - [POST /api/v1/payments/execute_payments](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/postexecutepayments.md): For all active retry cycles associated with the invoice, debit memo, and/or account IDs provided, schedules the next payment retry attempt to occur in the next hourly payment processor run. - [PUT /api/v1/payments/remove_invoice_from_retry_cycle/{invoice_id}](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/putremoveinovicefromcycle.md): Stops any active retry cycles associated with the invoice provided. - [PUT /api/v1/payments/remove_debit_memo_from_retry_cycle/{debit_memo_id}](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/putremovedebitmemofromcycle.md): Stops any active retry cycles associated with the debit memo provided. - [PUT /api/v1/payments/remove_account_from_retry_cycle/{account_id}](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/putremoveaccountfromcycle.md): Stops any active retry cycles associated with the account provided. - [POST /api/v1/payments/submit_failed_payment](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/postsubmitpaymenttocycle.md): This API request submits a failed payment to the Configurable Payment Retry retry cycle. The request adds the failed payment to the existing CPR retry cycle. If no CPR retry cycle exists, this request - [GET /api/v1/metrics/baseline](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/getbaselinemetrics.md): Gets baseline metrics for Configurable Payment Retry, including Retry Success Rate and trend, Document Success Rate and trend, and Average Days Outstanding and trend. See Response Schema for detailed - [GET /api/v1/metrics/amount_recovered](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/getamountrecovered.md): Gets the Amount Recovered metrics, including the total amount recovered and the amount recovered over the last 30 days broken down by currency. - [GET /api/v1/metrics/customer_group_over_time](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/getdocumentsuccessratebycustomergroup.md): Gets the Document Success Rate timeseries for each customer group over the past 6 months. The data of the current month will not be included. For example, if it is April 15th today, the data for April - [GET /api/v1/metrics/customer_group](https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry/getcustomergroupmetrics.md): Gets the following metrics for each customer group that is in the active status: - Document Success Rate and trend - Retry Success Rate - Average Attempts ## Object Queries - [GET /object-query/accounts](https://developer.zuora.com/v1-api-reference/api/object-queries/queryaccounts.md): Lists accounts. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/accounts/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryaccountbykey.md): Retrieve the details of a specific Account object. - [GET /object-query/amendments](https://developer.zuora.com/v1-api-reference/api/object-queries/queryamendments.md): Lists amendments. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/amendments/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryamendmentbykey.md): Retrieve the details of a specific Amendment object. - [GET /object-query/billing-runs](https://developer.zuora.com/v1-api-reference/api/object-queries/querybillingruns.md): Lists bill runs. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/billing-runs/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querybillingrunbykey.md): Retrieve the details of a specific Bill Run object. - [GET /object-query/contacts](https://developer.zuora.com/v1-api-reference/api/object-queries/querycontacts.md): Lists contacts. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/contacts/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querycontactbykey.md): Retrieve the details of a specific Contact object. - [GET /object-query/credit-memos](https://developer.zuora.com/v1-api-reference/api/object-queries/querycreditmemos.md): Lists credit memos. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/credit-memos/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querycreditmemobykey.md): Retrieve the details of a specific Credit Memo object. - [GET /object-query/credit-memo-applications](https://developer.zuora.com/v1-api-reference/api/object-queries/querycreditmemoapplications.md): Lists credit memo applications. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/credit-memo-applications/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querycreditmemoapplicationbykey.md): Retrieve the details of a specific Credit Memo Application object. - [GET /object-query/credit-memo-items](https://developer.zuora.com/v1-api-reference/api/object-queries/querycreditmemoitems.md): Lists credit memo items. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/credit-memo-items/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querycreditmemoitembykey.md): Retrieve the details of a specific Credit Memo Item object. - [GET /object-query/daily-consumption-summaries](https://developer.zuora.com/v1-api-reference/api/object-queries/querydailyconsumptionsummaries.md): Lists daily consumption summaries. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/daily-consumption-summaries/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querydailyconsumptionsummarybykey.md): Retrieve the details of a specific Daily Consumption Summary object. - [GET /object-query/debit-memos](https://developer.zuora.com/v1-api-reference/api/object-queries/querydebitmemos.md): Lists debit memos. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/debit-memos/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querydebitmemobykey.md): Retrieve the details of a specific Debit Memo object. - [GET /object-query/debit-memo-items](https://developer.zuora.com/v1-api-reference/api/object-queries/querydebitmemoitems.md): Lists debit memo items. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/debit-memo-items/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querydebitmemoitembykey.md): Retrieve the details of a specific Debit Memo Item object. - [GET /object-query/delivery-adjustments](https://developer.zuora.com/v1-api-reference/api/object-queries/querydeliveryadjustments.md): Lists Delivery Adjustment objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/delivery-adjustments/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querydeliveryadjustmentbykey.md): Retrieves a Delivery Adjustment object. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/fulfillments](https://developer.zuora.com/v1-api-reference/api/object-queries/queryfulfillments.md): Lists Fulfillment objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/fulfillments/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryfulfillmentbykey.md): Retrieves a Fulfillment object. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/invoices](https://developer.zuora.com/v1-api-reference/api/object-queries/queryinvoices.md): Lists invoices. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/invoices/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryinvoicebykey.md): Retrieves the details of a specific Invoice object. - [GET /object-query/invoice-items](https://developer.zuora.com/v1-api-reference/api/object-queries/queryinvoiceitems.md): Lists invoice items. You can use the query parameters to filter, expand, and sort the returned results. **Note**: You must specify a `filter[]` query parameter to query invoice items. - [GET /object-query/invoice-items/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryinvoiceitembykey.md): Retrieve the details of a specific Invoice Item object. - [GET /object-query/invoice-schedules](https://developer.zuora.com/v1-api-reference/api/object-queries/queryinvoiceschedules.md): Lists invoice schedules. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/invoice-schedules/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryinvoiceschedulebykey.md): Retrieves the details of a specific Invoice Schedule object. - [GET /object-query/order-actions](https://developer.zuora.com/v1-api-reference/api/object-queries/queryorderactions.md): Lists order actions. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/order-actions/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryorderactionbykey.md): Retrieve the details of a specific Order Action object. - [GET /object-query/order-line-items](https://developer.zuora.com/v1-api-reference/api/object-queries/queryorderlineitems.md): Lists order line items. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/order-line-items/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryorderlineitembykey.md): Retrieve the details of a specific Order Line Item object. - [GET /object-query/orders](https://developer.zuora.com/v1-api-reference/api/object-queries/queryorders.md): Lists orders. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/orders/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryordersbykey.md): Retrieve the details of a specific Order object. - [GET /object-query/payments](https://developer.zuora.com/v1-api-reference/api/object-queries/querypayments.md): Lists payments. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/payments/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querypaymentbykey.md): Retrieve the details of a specific Payment object. - [GET /object-query/payment-applications](https://developer.zuora.com/v1-api-reference/api/object-queries/querypaymentapplications.md): Lists payment applications. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/payment-applications/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querypaymentapplicationbykey.md): Retrieve the details of a specific Payment Application object. - [GET /object-query/payment-methods](https://developer.zuora.com/v1-api-reference/api/object-queries/querypaymentmethods.md): Lists payment methods. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/payment-methods/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querypaymentmethodbykey.md): Retrieve the details of a specific Payment Method object. - [GET /object-query/payment-method-snapshots](https://developer.zuora.com/v1-api-reference/api/object-queries/querypaymentmethodsnapshots.md): Lists payment method snapshots. You can use the query parameters to filter, expand, and sort the returned results. **Note**: You must specify a `filter[]` query parameter to query payment method snaps - [GET /object-query/payment-method-snapshots/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querypaymentmethodsnapshotbykey.md): Retrieve the details of a specific Payment Method Snapshot object. - [GET /object-query/payment-runs](https://developer.zuora.com/v1-api-reference/api/object-queries/querypaymentruns.md): Lists payment runs. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/payment-runs/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querypaymentrunbykey.md): Retrieve the details of a specific Payment Run object. - [GET /object-query/payment-schedules](https://developer.zuora.com/v1-api-reference/api/object-queries/querypaymentschedules.md): Lists payment schedules. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/payment-schedules/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querypaymentschedulebykey.md): Retrieve the details of a specific Payment Schedule object. - [GET /object-query/payment-schedule-items](https://developer.zuora.com/v1-api-reference/api/object-queries/querypaymentscheduleitems.md): Lists Payment Schedule Item objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/payment-schedule-items/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querypaymentscheduleitembykey.md): Retrieve the details of a specific Payment Schedule Item object. - [GET /object-query/prepaid-balances](https://developer.zuora.com/v1-api-reference/api/object-queries/queryprepaidbalances.md): Lists Prepaid Balance objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/prepaid-balances/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryprepaidbalancebykey.md): Retrieve the details of a specific Prepaid Balance object. - [GET /object-query/prepaid-balance-funds](https://developer.zuora.com/v1-api-reference/api/object-queries/queryprepaidbalancefunds.md): Lists prepaid balance funds. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/prepaid-balance-funds/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryprepaidbalancefundbykey.md): Retrieve the details of a specific Prepaid Balance Fund object. - [GET /object-query/prepaid-balance-transactions](https://developer.zuora.com/v1-api-reference/api/object-queries/queryprepaidbalancetransactions.md): Lists prepaid balance transactions. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/prepaid-balance-transactions/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryprepaidbalancetransactionbykey.md): Retrieve the details of a Prepaid Balance Transaction object. - [GET /object-query/processed-usages](https://developer.zuora.com/v1-api-reference/api/object-queries/queryprocessedusages.md): Lists Processed Usage Record objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/processed-usages/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryprocessedusagebykey.md): Retrieve the details of a specific Processed Usage Record object. - [GET /object-query/products](https://developer.zuora.com/v1-api-reference/api/object-queries/queryproducts.md): Lists Product objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/products/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryproductbykey.md): Retrieve the details of a specific Product object. - [GET /object-query/product-rate-plans](https://developer.zuora.com/v1-api-reference/api/object-queries/queryproductrateplans.md): Lists Product Rate Plan objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/product-rate-plans/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryproductrateplanbykey.md): Retrieve the details of a specific Product Rate Plan object. - [GET /object-query/product-rate-plan-charges](https://developer.zuora.com/v1-api-reference/api/object-queries/queryproductrateplancharges.md): Lists Product Rate Plan Charge objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/product-rate-plan-charges/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryproductrateplanchargebykey.md): Retrieve the details of a specific Product Rate Plan Charge object. - [GET /object-query/product-rate-plan-charge-tiers](https://developer.zuora.com/v1-api-reference/api/object-queries/queryproductrateplanchargetiers.md): Lists Product Rate Plan Charge Tier objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/product-rate-plan-charge-tiers/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryproductrateplanchargetierbykey.md): Retrieve the details of a specific Product Rate Plan Charge Tier object. - [GET /object-query/ramps](https://developer.zuora.com/v1-api-reference/api/object-queries/queryramps.md): Lists Ramp objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/ramps/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryrampbykey.md): Retrieve a Ramp object. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/rate-plans](https://developer.zuora.com/v1-api-reference/api/object-queries/queryrateplans.md): Lists Rate Plan objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/rate-plans/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryrateplanbykey.md): Retrieve the details of a specific Rate Plan object. - [GET /object-query/rate-plan-charges](https://developer.zuora.com/v1-api-reference/api/object-queries/queryrateplancharges.md): Lists Rate Plan Charge objects. You can use the query parameters to filter, expand, and sort the returned results. **Note**: You must specify a `filter[]` query parameter to query rate plan charges. - [GET /object-query/rate-plan-charges/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryrateplanchargebykey.md): Retrieve the details of a specific Rate Plan Charge object. - [GET /object-query/rate-plan-charge-tiers](https://developer.zuora.com/v1-api-reference/api/object-queries/queryrateplanchargetiers.md): Lists Rate Plan Charge Tier objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/rate-plan-charge-tiers/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryrateplanchargetierbykey.md): Retrieve the details of a specific Rate Plan Charge Tier object. - [GET /object-query/rating-results](https://developer.zuora.com/v1-api-reference/api/object-queries/queryratingresults.md): Lists Rating Result objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/rating-results/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryratingresultbykey.md): Retrieve the details of a specific Rating Result object. - [GET /object-query/refunds](https://developer.zuora.com/v1-api-reference/api/object-queries/queryrefunds.md): Lists Refund objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/refunds/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryrefundbykey.md): Retrieve the details of a specific Refund object. - [GET /object-query/refund-applications](https://developer.zuora.com/v1-api-reference/api/object-queries/queryrefundapplications.md): Lists Refund Application objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/refund-applications/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryrefundapplicationbykey.md): Retrieve the details of a specific Refund Application object. - [GET /object-query/refund-application-items](https://developer.zuora.com/v1-api-reference/api/object-queries/queryrefundapplicationitems.md): Lists Refund Application Item objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/refund-application-items/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryrefundapplicationitembykey.md): Retrieve the details of a specific Refund Application Item object. - [GET /object-query/summarystatementruns](https://developer.zuora.com/v1-api-reference/api/object-queries/getsummarystatementruns.md): Lists statement runs. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/summarystatementruns/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/getsummarystatementrun.md): Retrieves a statement run by using the statement run ID or number. - [GET /object-query/summarystatements](https://developer.zuora.com/v1-api-reference/api/object-queries/getsummarystatements.md): Lists summary statements. - [GET /object-query/summarystatements/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/getsummarystatement.md): Retrieves a statement based on the specified summary statement key. - [GET /object-query/subscriptions](https://developer.zuora.com/v1-api-reference/api/object-queries/querysubscriptions.md): Lists Subscription objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/subscriptions/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querysubscriptionbykey.md): Retrieve the details of a specific Subscription object. - [GET /object-query/taxation-items](https://developer.zuora.com/v1-api-reference/api/object-queries/querytaxationitems.md): Lists Taxation Item objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/taxation-items/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querytaxationitembykey.md): Retrieve the details of a specific Taxation Item object. - [GET /object-query/usages](https://developer.zuora.com/v1-api-reference/api/object-queries/queryusages.md): Lists Usage Record objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/usages/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryusagebykey.md): Retrieve the details of a specific Usage Record object. - [GET /object-query/validity-period-summaries](https://developer.zuora.com/v1-api-reference/api/object-queries/queryvalidityperiodsummarys.md): Lists Validity Period Summary objects. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/validity-period-summaries/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryvalidityperiodsummarybykey.md): Retrieve the details of a specific Validity Period Summary object. - [GET /object-query/{custom-object-name}](https://developer.zuora.com/v1-api-reference/api/object-queries/querycustomobjects.md): Lists custom object records. You can use the query parameters to filter, expand, and sort the returned results. The name of a custom object is in the `{namespace}__{objectname}s` format, for example, - [GET /object-query/{custom-object-name}/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querycustomobjectbykey.md): Retrieve the details of a specific custom object record. The name of a custom object is in the `{namespace}__{objectname}s` format, for example, `default__cars`. - [GET /object-query/contact-snapshots](https://developer.zuora.com/v1-api-reference/api/object-queries/querycontactsnapshots.md): Lists contact snapshots. You can use the query parameters to filter, expand, and sort the returned results. - [GET /object-query/contact-snapshots/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/querycontactsnapshotbykey.md): Retrieves detailed information about a specific contact snapshot by its unique ID. - [GET /object-query/rating-details](https://developer.zuora.com/v1-api-reference/api/object-queries/queryratingdetails.md): Lists rating details. Use query parameters to paginate and filter results. - [GET /object-query/rating-details/{key}](https://developer.zuora.com/v1-api-reference/api/object-queries/queryratingdetailbykey.md): Retrieves a single rating detail by ID. ## Accounting Codes - [GET /v1/accounting-codes](https://developer.zuora.com/v1-api-reference/api/accounting-codes/get_allaccountingcodes.md): This reference describes how to query all accounting codes in your chart of accounts through the REST API. - [POST /v1/accounting-codes](https://developer.zuora.com/v1-api-reference/api/accounting-codes/post_accountingcode.md): This 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. ### Prerequisites If you have Zuora Finance enable - [DELETE /v1/accounting-codes/{ac-id}](https://developer.zuora.com/v1-api-reference/api/accounting-codes/delete_accountingcode.md): This 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 have the Delete Unused Accounting Code - [GET /v1/accounting-codes/{ac-id}](https://developer.zuora.com/v1-api-reference/api/accounting-codes/get_accountingcode.md): This reference describes how to query an accounting code through the REST API. - [PUT /v1/accounting-codes/{ac-id}](https://developer.zuora.com/v1-api-reference/api/accounting-codes/put_accountingcode.md): This reference describes how to update an existing accounting code through the REST API. ### Prerequisites If you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code p - [PUT /v1/accounting-codes/{ac-id}/activate](https://developer.zuora.com/v1-api-reference/api/accounting-codes/put_activateaccountingcode.md): This reference describes how to activate an accounting code through the REST API. Prerequisites ------------- If you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Cod - [PUT /v1/accounting-codes/{ac-id}/deactivate](https://developer.zuora.com/v1-api-reference/api/accounting-codes/put_deactivateaccountingcode.md): This reference describes how to deactivate an accounting code through the REST API. ### Prerequisites If you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permiss ## Accounting Periods - [GET /v1/accounting-periods](https://developer.zuora.com/v1-api-reference/api/accounting-periods/get_allaccountingperiods.md): Retrieves all accounting periods on your tenant. - [POST /v1/accounting-periods](https://developer.zuora.com/v1-api-reference/api/accounting-periods/post_accountingperiod.md): Creates an accounting period. Prerequisites --- * You must have Zuora Finance enabled on your tenant. * You must have the Create Accounting Period user permission. Limitations --- * When creati - [DELETE /v1/accounting-periods/{ap-id}](https://developer.zuora.com/v1-api-reference/api/accounting-periods/delete_accountingperiod.md): Deletes an accounting period. ### Prerequisites * You must have Zuora Finance enabled on your tenant. * You must have the Delete Accounting Period user permission. See [Finance Roles](https://docs.zuo - [GET /v1/accounting-periods/{ap-id}](https://developer.zuora.com/v1-api-reference/api/accounting-periods/get_accountingperiod.md): Retrieves an accounting period. **Prerequisites**: You must have Zuora Finance enabled on your tenant. - [PUT /v1/accounting-periods/{ap-id}](https://developer.zuora.com/v1-api-reference/api/accounting-periods/put_updateaccountingperiod.md): Updates an accounting period. Prerequisites --- * You must have Zuora Finance enabled on your tenant. * You must have the Create Accounting Period user permission. See [Finance Roles](https://docs. - [PUT /v1/accounting-periods/{ap-id}/close](https://developer.zuora.com/v1-api-reference/api/accounting-periods/put_closeaccountingperiod.md): Close an accounting period by accounting period ID. Prerequisites --- You must have Zuora Finance enabled on your tenant. You must have the Manage Close Process and Run Trial Balance user permissio - [PUT /v1/accounting-periods/{ap-id}/pending-close](https://developer.zuora.com/v1-api-reference/api/accounting-periods/put_pendingcloseaccountingperiod.md): Sets an accounting period to pending close. Prerequisites --- * You must have Zuora Finance enabled on your tenant. * You must have the Manage Close Process and Run Trial Balance user permissions. - [PUT /v1/accounting-periods/{ap-id}/reopen](https://developer.zuora.com/v1-api-reference/api/accounting-periods/put_reopenaccountingperiod.md): Re-opens an accounting period. Prerequisites --- * You must have Zuora Finance enabled on your tenant. * You must have the Manage Close Process and Run Trial Balance user permissions. Limitations - [PUT /v1/accounting-periods/{ap-id}/run-trial-balance](https://developer.zuora.com/v1-api-reference/api/accounting-periods/put_runtrialbalance.md): Runs the trial balance for an accounting period. Prerequisites --- * You must have Zuora Finance enabled on your tenant. * You must have the Manage Close Process and Run Trial Balance user permissi ## Summary Journal Entries - [POST /v1/journal-entries](https://developer.zuora.com/v1-api-reference/api/summary-journal-entries/post_summaryjournalentry.md): This REST API reference describes how to manually create a summary journal entry. Request and response field descriptions and sample code are provided. ### Requirements 1.The sum of debits must equal - [GET /v1/journal-entries/journal-runs/{jr-number}](https://developer.zuora.com/v1-api-reference/api/summary-journal-entries/get_allsummaryjournalentries.md): This REST API reference describes how to retrieve information about all summary journal entries in a journal run. - [DELETE /v1/journal-entries/{je-number}](https://developer.zuora.com/v1-api-reference/api/summary-journal-entries/delete_summaryjournalentry.md): This reference describes how to delete a summary journal entry using the REST API. You must have the "Delete Cancelled Journal Entry" user permission enabled to delete summary journal entries. A sum - [GET /v1/journal-entries/{je-number}](https://developer.zuora.com/v1-api-reference/api/summary-journal-entries/get_summaryjournalentry.md): This REST API reference describes how to get information about a summary journal entry by its journal entry number. - [PUT /v1/journal-entries/{je-number}/basic-information](https://developer.zuora.com/v1-api-reference/api/summary-journal-entries/put_basicsummaryjournalentry.md): This REST API reference describes how to update the basic information of a summary journal entry. Request and response field descriptions and sample code are provided. - [PUT /v1/journal-entries/{je-number}/cancel](https://developer.zuora.com/v1-api-reference/api/summary-journal-entries/put_summaryjournalentry.md): This reference describes how to cancel a summary journal entry using the REST API. You must have the "Cancel Journal Entry" user permission enabled to cancel summary journal entries. A summa ## Journal Runs - [POST /v1/journal-runs](https://developer.zuora.com/v1-api-reference/api/journal-runs/post_journalrun.md): This REST API reference describes how to create a journal run. Request and response field descriptions and sample code are provided. - [DELETE /v1/journal-runs/{jr-number}](https://developer.zuora.com/v1-api-reference/api/journal-runs/delete_journalrun.md): This 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 - [GET /v1/journal-runs/{jr-number}](https://developer.zuora.com/v1-api-reference/api/journal-runs/get_journalrun.md): This REST API reference describes how to get information about a journal run. Request and response field descriptions and sample code are provided. - [PUT /v1/journal-runs/{jr-number}/cancel](https://developer.zuora.com/v1-api-reference/api/journal-runs/put_journalrun.md): This 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 "Example" section below for details. You mu ## Mass Updater - [POST /v1/bulk](https://developer.zuora.com/v1-api-reference/api/mass-updater/post_massupdater.md): Describes 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 about the mass action you want to perform. - [GET /v1/bulk/{bulk-key}](https://developer.zuora.com/v1-api-reference/api/mass-updater/get_massupdater.md): Describes how to get information about the result of a mass action through the REST API. - [PUT /v1/bulk/{bulk-key}/stop](https://developer.zuora.com/v1-api-reference/api/mass-updater/put_massupdater.md): Describes 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 action, you can get the mass action result ## Notifications - [POST /notifications/notification-definitions](https://developer.zuora.com/v1-api-reference/api/notifications/post_create_notification_definition.md): Creates a notification definition. If a filter rule is specified, it will be evaluated to see if the notification definition is qualified to handle the incoming events during runtime. If the notificat - [GET /notifications/notification-definitions](https://developer.zuora.com/v1-api-reference/api/notifications/get_query_notification_definitions.md): Queries notification definitions with the specified filters. - [GET /notifications/notification-definitions/{id}](https://developer.zuora.com/v1-api-reference/api/notifications/get_get_notification_definition.md): Queries the notification definition of the given ID. - [PUT /notifications/notification-definitions/{id}](https://developer.zuora.com/v1-api-reference/api/notifications/put_update_notification_definition.md): Updates a notification definition. - [DELETE /notifications/notification-definitions/{id}](https://developer.zuora.com/v1-api-reference/api/notifications/delete_delete_notification_definition.md): Deletes a notification definition. - [POST /notifications/email-templates/import](https://developer.zuora.com/v1-api-reference/api/notifications/post_createorupdateemailtemplates.md): 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. For each email template whe - [POST /notifications/email-templates](https://developer.zuora.com/v1-api-reference/api/notifications/post_create_email_template.md): Creates an email template. This operation supports creating the email template for all event types. - If you specify the `eventCategory` field, the email template is created based on a standard event. - [GET /notifications/email-templates](https://developer.zuora.com/v1-api-reference/api/notifications/get_query_email_templates.md): Queries email templates. This operation supports querying email templates for all event types. - [GET /notifications/email-templates/{id}](https://developer.zuora.com/v1-api-reference/api/notifications/get_get_email_template.md): Queries the email template based on the specified ID. This operation supports retrieving the email template for all event types. - [PUT /notifications/email-templates/{id}](https://developer.zuora.com/v1-api-reference/api/notifications/put_update_email_template.md): Updates an email template. This operation supports updating the email template for all event types. - [DELETE /notifications/email-templates/{id}](https://developer.zuora.com/v1-api-reference/api/notifications/delete_delete_email_template.md): Deletes an email template. This operation supports deleting an email template for all event types. - [POST /notifications/callout-templates/import](https://developer.zuora.com/v1-api-reference/api/notifications/createorupdatecallouttemplates.md): Creates callout templates for standard or custom events if you do not specify callout template IDs, or updates existing callout templates if you specify valid callout template IDs. For each callout te - [POST /notifications/callout-templates](https://developer.zuora.com/v1-api-reference/api/notifications/createcallouttemplate.md): Creates a callout template. This operation supports creating the callout template for all event types: - To create a callout template for a standard event, you must specify the `eventCategory` field. - [GET /notifications/callout-templates](https://developer.zuora.com/v1-api-reference/api/notifications/getcallouttemplates.md): Queries callout templates. This operation supports querying callout templates for all event types. - [GET /notifications/callout-templates/{id}](https://developer.zuora.com/v1-api-reference/api/notifications/getcallouttemplte.md): Queries the callout template based on the specified ID. This operation supports retrieving the callout template for all event types. - [PUT /notifications/callout-templates/{id}](https://developer.zuora.com/v1-api-reference/api/notifications/updatecallouttemplate.md): Updates a callout template. This operation supports updating the callout template for all event types. - [DELETE /notifications/callout-templates/{id}](https://developer.zuora.com/v1-api-reference/api/notifications/deletecallouttemplate.md): Deletes a callout template. This operation supports deleting a callout template for all event types. - [POST /notifications/reusable-blocks/import](https://developer.zuora.com/v1-api-reference/api/notifications/createorupdatereusableblocks.md): Creates reusable blocks if you do not specify block IDs, or updates existing reusable blocks if you specify valid block IDs. All fields must be provided for each reusable block you want to update. Th - [POST /notifications/reusable-blocks](https://developer.zuora.com/v1-api-reference/api/notifications/createreusableblock.md): Creates a reusable block for email templates, such as email headers or footers. - [GET /notifications/reusable-blocks](https://developer.zuora.com/v1-api-reference/api/notifications/getreusableblocks.md): Queries reusable blocks. - [GET /notifications/reusable-blocks/{blockKey}](https://developer.zuora.com/v1-api-reference/api/notifications/getreusableblock.md): Queries the reusable block based on the specified ID or name. - [PUT /notifications/reusable-blocks/{blockKey}](https://developer.zuora.com/v1-api-reference/api/notifications/updatereusableblock.md): Updates a reusable block. - [DELETE /notifications/reusable-blocks/{blockKey}](https://developer.zuora.com/v1-api-reference/api/notifications/deletereusableblock.md): Deletes a reusable block. - [DELETE /notifications/history](https://developer.zuora.com/v1-api-reference/api/notifications/delete_delete_notification_history_for_account.md): Delete all notification histories for the given account. All email and callout notifications for this account will be deleted upon successful operation. - [GET /notifications/history/tasks/{id}](https://developer.zuora.com/v1-api-reference/api/notifications/get_get_notification_history_deletion_task.md): Get the notification history deletion task by ID. - [POST /notifications/callout-histories/resend](https://developer.zuora.com/v1-api-reference/api/notifications/post_resendcalloutnotifications.md): Resends callout notifications if your customers did not receive previous callout notifications. Details about the status codes and response contents of this operation are as follows: | Scenario | Stat - [POST /notifications/email-histories/resend](https://developer.zuora.com/v1-api-reference/api/notifications/post_resendemailnotifications.md): Resends email notifications if your customers did not receive previous email notifications. Details about the status codes and response contents of this operation are as follows: | Scenario | Status c - [GET /v1/notification-history/callout](https://developer.zuora.com/v1-api-reference/api/notifications/get_callouthistory.md): Describes how to get a notification history for callouts. - [GET /v1/notification-history/email](https://developer.zuora.com/v1-api-reference/api/notifications/get_emailhistory.md): Describes how to get a notification history for notification emails. ### Notes Request parameters and their values may be appended with a "?" following the HTTPS GET request. Additional request param ## Custom Event Triggers - [POST /events/event-triggers](https://developer.zuora.com/v1-api-reference/api/custom-event-triggers/post_eventtrigger.md): When 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 which object to define a trigger on. - [GET /events/event-triggers](https://developer.zuora.com/v1-api-reference/api/custom-event-triggers/get_eventtriggers.md) - [GET /events/event-triggers/{id}](https://developer.zuora.com/v1-api-reference/api/custom-event-triggers/get_eventtrigger.md) - [PUT /events/event-triggers/{id}](https://developer.zuora.com/v1-api-reference/api/custom-event-triggers/put_eventtrigger.md) - [DELETE /events/event-triggers/{id}](https://developer.zuora.com/v1-api-reference/api/custom-event-triggers/delete_eventtrigger.md) ## Custom Scheduled Events - [POST /events/scheduled-events](https://developer.zuora.com/v1-api-reference/api/custom-scheduled-events/post_scheduledevent.md): To create a custom scheduled event, you must specify the base object, the base field and the scheduled time. - [GET /events/scheduled-events](https://developer.zuora.com/v1-api-reference/api/custom-scheduled-events/get_scheduledevents.md) - [GET /events/scheduled-events/{id}](https://developer.zuora.com/v1-api-reference/api/custom-scheduled-events/get_scheduledeventbyid.md) - [PUT /events/scheduled-events/{id}](https://developer.zuora.com/v1-api-reference/api/custom-scheduled-events/update_scheduledeventbyid.md) - [DELETE /events/scheduled-events/{id}](https://developer.zuora.com/v1-api-reference/api/custom-scheduled-events/delete_scheduledeventbyid.md) ## Custom Object Definitions - [Error handling](https://developer.zuora.com/v1-api-reference/api/custom-object-definitions/error-handling.md): ### Error handling If the Custom Objects API call fails, an error code will be returned in the response body. See See Custom Objects API error code for details. - [POST /objects/definitions/default](https://developer.zuora.com/v1-api-reference/api/custom-object-definitions/post_customobjectdefinitions.md): You can post custom object definitions with the request body schema described below. This operation also allows you to use the [List custom object definitions](https://developer.zuora.com/api-referenc - [GET /objects/definitions/default](https://developer.zuora.com/v1-api-reference/api/custom-object-definitions/get_allcustomobjectdefinitionsinnamespace.md): Get 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 this operation in your old tenant and then u - [POST /objects/migrations](https://developer.zuora.com/v1-api-reference/api/custom-object-definitions/updateobjectdefinition.md): Updates custom object definitions or custom field definitions for standard and custom objects. The system asynchronously processes requests to update custom object definitions or advanced custom field - [GET /objects/definitions/default/{object}](https://developer.zuora.com/v1-api-reference/api/custom-object-definitions/get_customobjectdefinitionbytype.md): Retrieves the custom object definition by type for the given tenant. - [DELETE /objects/definitions/default/{object}](https://developer.zuora.com/v1-api-reference/api/custom-object-definitions/delete_customobjectdefinitionbytype.md): Deletes 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. ## Custom Object Records - [Error handling](https://developer.zuora.com/v1-api-reference/api/custom-object-records/error-handling.md): ### Error handling If the Custom Objects API call fails, an error code will be returned in the response body. See Custom Objects API error code for details. - [POST /objects/records/default/{object}](https://developer.zuora.com/v1-api-reference/api/custom-object-records/post_customobjectrecords.md): Creates 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 successfully processed and stored. ### Limi - [GET /objects/records/default/{object}](https://developer.zuora.com/v1-api-reference/api/custom-object-records/get_allrecordsforcustomobjecttype.md): Lists all object records of the given type. You can also use the `q` query parameter to filter the output records. ### Custom Objects read consistency Custom Objects support eventually consistency. Wh - [GET /objects/records/default/{object}/{id}](https://developer.zuora.com/v1-api-reference/api/custom-object-records/get_customobjectrecordbyid.md): Retrieves a record of a given type by ID. - [PUT /objects/records/default/{object}/{id}](https://developer.zuora.com/v1-api-reference/api/custom-object-records/put_customobjectrecord.md): Updates 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 following example: ``` { "records": [ - [PATCH /objects/records/default/{object}/{id}](https://developer.zuora.com/v1-api-reference/api/custom-object-records/patch_partialupdatecustomobjectrecord.md): Updates one or many fields of a custom object record. Patch update uses JSON Merge Patch as specified in [RFC 7386](https://tools.ietf.org/html/rfc7386). ### Limitations * The storage of empty strings - [DELETE /objects/records/default/{object}/{id}](https://developer.zuora.com/v1-api-reference/api/custom-object-records/delete_customobjectrecordbyid.md): Deletes 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 identified and successfully deleted * The rec - [POST /objects/batch/default/{object}](https://developer.zuora.com/v1-api-reference/api/custom-object-records/post_customobjectrecordsbatchupdateordelete.md): Makes a batch update or delete of custom object records. ### Limitations This call has the following limitations: * The maximum number of records that you can update by one call is 1,000. * The maximu ## Custom Object Jobs - [Error handling](https://developer.zuora.com/v1-api-reference/api/custom-object-jobs/error-handling.md): ### Error handling If the Custom Objects API call fails, an error code will be returned in the response body. See Custom Objects API error code for details. - [POST /objects/jobs](https://developer.zuora.com/v1-api-reference/api/custom-object-jobs/post_customobjectbulkjob.md): Submits 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 used to poll the job status or upload the - [GET /objects/jobs](https://developer.zuora.com/v1-api-reference/api/custom-object-jobs/get_allcustomobjectbulkjobs.md): Lists all custom object bulk jobs submitted by your tenant. - [GET /objects/jobs/{id}](https://developer.zuora.com/v1-api-reference/api/custom-object-jobs/get_customobjectbulkjob.md): Retrieves 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. See [Platform Permissions](https://docs.zuor - [POST /objects/jobs/{id}/files](https://developer.zuora.com/v1-api-reference/api/custom-object-jobs/post_uploadfileforcustomobjectbulkjob.md): Uploads a `.csv` file for a custom object bulk job to create or update custom object records. The job must be in `pending` status. Only one file is allowed per job. Each file supports only one type of - [GET /objects/jobs/{id}/errors](https://developer.zuora.com/v1-api-reference/api/custom-object-jobs/get_customobjectbulkjoberrors.md): Lists all errors for a custom object bulk job. - [PATCH /objects/jobs/{id}/cancel](https://developer.zuora.com/v1-api-reference/api/custom-object-jobs/patch_customobjectbulkjob.md): Cancel a custom object bulk job. Note that you can cancel a custom object bulk job only if the job status is `accepted` or `pending`. ## API Health - [GET /system-health/api-requests/volume-summary](https://developer.zuora.com/v1-api-reference/api/api-health/get_systemhealthapivolumesummary.md): Returns volume summary of [API](https://docs.zuora.com?resourceId=platform-rest-api) usage that generated by your Zuora tenant within a specified time range. You can filter the summary by API path nam - [GET /system-health/api-requests/failures](https://developer.zuora.com/v1-api-reference/api/api-health/getsystemhealthapifailurerecords.md): Returns failure records of API usage that are generated by your Zuora tenant within a specified time range. You can filter the failure records by one or multiple of the following fields: - API path na - [GET /system-health/api-requests/details](https://developer.zuora.com/v1-api-reference/api/api-health/getsystemhealthapiperformancerecords.md): Returns records of API usage that are generated by your Zuora tenant within a specified time range. You can filter the records by one or multiple of the following fields: - API path name - HTTP method ## Bill Run Health - [GET /system-health/billing-documents/volume-summary](https://developer.zuora.com/v1-api-reference/api/bill-run-health/get_systemhealthbillingdocvolumesummary.md): 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. ## Electronic Payments Health - [GET /system-health/payments/volume-summary](https://developer.zuora.com/v1-api-reference/api/electronic-payments-health/get_systemhealthpaymentvolumesummary.md): Returns a summary of electronic payments handled by your Zuora tenant within a specified time range. You can filter the summary by payment gateway type and payment method type. - [GET /system-health/payments/details](https://developer.zuora.com/v1-api-reference/api/electronic-payments-health/getsystemhealthpaymentrecords.md): Returns System Health Electronic Payments records that are generated by your Zuora tenant within a specified time range. You can filter the failure records by one or multiple of the following fields: ## Tax Health - [GET /system-health/tax/details](https://developer.zuora.com/v1-api-reference/api/tax-health/getsystemhealthtaxrecords.md): Returns System Health Electronic records that are generated by your Zuora tenant within a specified time range. You can filter the failure records by one or multiple of the following fields: - vendorN ## Workflows - [POST /auth_providers](https://developer.zuora.com/v1-api-reference/api/workflows/createauthproviderworkflows.md): Creates an authentication provider for reuse in Workflow tasks and supported integrations. - [PUT /auth_providers/{provider_id}](https://developer.zuora.com/v1-api-reference/api/workflows/updateauthproviderworkflows.md): Updates an authentication provider that is used for Workflow tasks and supported integrations. Only supplied fields are changed. The `auth_type` field cannot be changed after creation. - [DELETE /auth_providers/{provider_id}](https://developer.zuora.com/v1-api-reference/api/workflows/deleteauthproviderworkflows.md): Deletes an authentication provider that is used for Workflow tasks and supported integrations. - [DELETE /workflows/versions/{version_id}](https://developer.zuora.com/v1-api-reference/api/workflows/delete_workflowversion.md): Delete a workflow version based on the version id. ### User Access Permission You must be assigned the **Workflow Manage Access** permission to run this operation. - [GET /workflows](https://developer.zuora.com/v1-api-reference/api/workflows/get_workflows.md): Retrieves a list of workflow definitions available in your Zuora tenant. ### User Access Permission You must be assigned the **Workflow View Access** permission to run this operation. - [POST /workflows/import](https://developer.zuora.com/v1-api-reference/api/workflows/post_workflowimport.md): Create a new workflow definition and its first version using the exported JSON document of an existing workflow version. ### User Access Permission You must be assigned the **Workflow Manage Access** - [GET /workflows/metrics.json](https://developer.zuora.com/v1-api-reference/api/workflows/get_workflowsusages.md): Gets workflow task usage sorted by day within a specified time frame. ### User Access Permission You must be assigned the **Workflow View Access** permission to run this operation. - [GET /workflows/tasks](https://developer.zuora.com/v1-api-reference/api/workflows/get_workflowstasks.md): Retrieves a list of workflow tasks available in your Zuora tenant. ### User Access Permission You must be assigned the **Workflow View Access** permission to run this operation. - [PUT /workflows/tasks/batch_update](https://developer.zuora.com/v1-api-reference/api/workflows/put_workflowstasksupdate.md): Updates a group of workflow tasks. ### User Access Permission You must be assigned the **Workflow Manage Access** permission to run this operation. - [GET /workflows/tasks/{task_id}](https://developer.zuora.com/v1-api-reference/api/workflows/get_workflowstask.md): Retrieves a specific workflow task by its ID. ### User Access Permission You must be assigned the **Workflow View Access** permission to run this operation. - [POST /workflows/tasks/{task_id}/rerun](https://developer.zuora.com/v1-api-reference/api/workflows/post_workflowstaskrerun.md): Reruns a specific workflow task by its ID. ### User Access Permission You must be assigned the **Workflow Run Access** permission to run this operation. - [GET /workflows/workflow_runs/{workflow_run_id}](https://developer.zuora.com/v1-api-reference/api/workflows/get_workflow_run.md): Retrieves information about a specific workflow run by its ID. ### User Access Permission You must be assigned the **Workflow View Access** permission to run this operation. - [DELETE /workflows/{workflow_id}](https://developer.zuora.com/v1-api-reference/api/workflows/delete_workflow.md): Deletes a specific workflow by its ID. ### User Access Permission You must be assigned the **Workflow Manage Access** permission to run this operation. - [GET /workflows/{workflow_id}](https://developer.zuora.com/v1-api-reference/api/workflows/get_workflow.md): Retrieves information about a specific workflow by its ID. ### User Access Permission You must be assigned the **Workflow View Access** permission to run this operation. - [PATCH /workflows/{workflow_id}](https://developer.zuora.com/v1-api-reference/api/workflows/patch_updateworkflow.md): Updates a specific workflow by its ID, which allows you to [configure the settings of a workflow](https://docs.zuora.com?resourceId=platform-manage-access-permissions-workflow) via API. ### User Acces - [GET /workflows/{workflow_id}/export](https://developer.zuora.com/v1-api-reference/api/workflows/get_workflowexport.md): Exports a workflow version into a JSON file. This file can be used to create a copy of this workflow version. ### User Access Permission You must be assigned the **Workflow View Access** permission to - [POST /workflows/{workflow_id}/run](https://developer.zuora.com/v1-api-reference/api/workflows/post_run_workflow.md): Run a specified workflow. In the request body, you can include parameters that you want to pass to the workflow. For the parameters to be recognized and picked up by tasks in the workflow, you need to - [GET /workflows/{workflow_id}/versions](https://developer.zuora.com/v1-api-reference/api/workflows/get_workflowversions.md): Return a list of all workflow versions under a workflow definition ### User Access Permission You must be assigned the **Workflow View Access** permission to run this operation. - [POST /workflows/{workflow_id}/versions/import](https://developer.zuora.com/v1-api-reference/api/workflows/post_workflowversionsimport.md): Create a new workflow version under a workflow definition using the exported JSON document of an existing workflow version. ### User Access Permission You must be assigned the **Workflow Manage Access - [PUT /workflows/workflow_runs/{workflow_run_id}/stop](https://developer.zuora.com/v1-api-reference/api/workflows/put_stopworkflowrun.md): Stop a specific workflow run by its ID. ### User Access Permission You must be assigned the **Workflow View Access** permission to run this operation. ## Data Queries - [GET /query/jobs](https://developer.zuora.com/v1-api-reference/api/data-queries/get_dataqueryjobs.md): Returns a list of [data query](https://docs.zuora.com?resourceId=platform-data-query-overview) jobs that have been created in your Zuora tenant. You can filter the list by status. If you are an admini - [POST /query/jobs](https://developer.zuora.com/v1-api-reference/api/data-queries/post_dataqueryjob.md): Submits a [data query](https://docs.zuora.com?resourceId=platform-data-query-overview) to be executed by Zuora, creating a new query job. Use the [Retrieve a data query job](https://developer.zuora.co - [DELETE /query/jobs/{job-id}](https://developer.zuora.com/v1-api-reference/api/data-queries/delete_dataqueryjob.md): Cancels a [data query](https://docs.zuora.com?resourceId=platform-data-query-overview) job, which prevents Zuora from performing the query. This operation is only applicable if the status of the query - [GET /query/jobs/{job-id}](https://developer.zuora.com/v1-api-reference/api/data-queries/get_dataqueryjob.md): Retrieves a [data query](https://docs.zuora.com?resourceId=platform-data-query-overview) job. You can use this operation to track the status of the query job and obtain the URL of the query results. I ## Aggregate Queries - [POST /v1/batch-query](https://developer.zuora.com/v1-api-reference/api/aggregate-queries/post_batchqueryjob.md): Submits an AQuA job that contains an aggregated list of ZOQL and Export ZOQL queries. - [GET /v1/batch-query/jobs/partner/{partner}/project/{project}](https://developer.zuora.com/v1-api-reference/api/aggregate-queries/get_lastbatchqueryjob.md): Returns the details of the last completed job. The completed AQuA jobs that were created 180 days ago are deleted permanently from Zuora, so you cannot query these jobs through API or AQuA job finder - [DELETE /v1/batch-query/jobs/{jobid}](https://developer.zuora.com/v1-api-reference/api/aggregate-queries/delete_batchqueryjob.md): Cancels the current AQuA job, only if the job is not complete. If the job is complete, an error is thrown. - [GET /v1/batch-query/jobs/{jobid}](https://developer.zuora.com/v1-api-reference/api/aggregate-queries/get_batchqueryjob.md): Retrieves an aggregate query using the Job ID. Note that the completed AQuA jobs that were created 180 days ago are deleted permanently from Zuora, so you cannot query these jobs through API or AQuA ## Configuration Templates - [GET /deployment-manager/deployment_artifacts](https://developer.zuora.com/v1-api-reference/api/configuration-templates/get_downloaddeploymenttemplate.md): Download a template for migration in the Deployment manager from the source tenant to the target tenant. - [POST /deployment-manager/deployment_artifacts/compare](https://developer.zuora.com/v1-api-reference/api/configuration-templates/post_comparetemplate.md): To Compare the configurations from the template downloaded and used in deployment manager for migration which is available in source and target tenant. - [POST /deployment-manager/deployment_artifacts/deploy](https://developer.zuora.com/v1-api-reference/api/configuration-templates/post_migratetenantsettings.md): To migrate the selected configuration of a tenant in Deployment Manager migration while using template from the compare screen. - [GET /deployment-manager/deployment_artifacts/retrieve-settings](https://developer.zuora.com/v1-api-reference/api/configuration-templates/get_sourcecomponentdetails.md): When the advanced option is clicked, get the details/metadata of the components, such as settings, notifications, workflow, etc. - [GET /deployment-manager/deployment_templates](https://developer.zuora.com/v1-api-reference/api/configuration-templates/get_templates.md): Retrieves all the templates and their details which are created already. - [POST /deployment-manager/deployment_templates](https://developer.zuora.com/v1-api-reference/api/configuration-templates/post_deploymenttemplate.md): Creates templates based on user preference. There are 2 ways to select components. - Selecting the whole component. - Advanced Options -> which helps user to select specific components to be migrated. - [DELETE /deployment-manager/deployment_templates/{id}](https://developer.zuora.com/v1-api-reference/api/configuration-templates/delete_deploymenttemplate.md): Deletes a specific template by passing the ID. - [GET /deployment-manager/deployment_templates/{id}](https://developer.zuora.com/v1-api-reference/api/configuration-templates/get_deploymenttemplatedetail.md): Returns the detailed information of a specific template by passing its template ID. - [POST /deployment-manager/deployment_templates/sync](https://developer.zuora.com/v1-api-reference/api/configuration-templates/syncdeploymenttemplate.md): Synchronizes an existing deployment template with the latest changes in the source tenant. ## Metadata Deployment - [POST /deployment-manager/deployments/tenants](https://developer.zuora.com/v1-api-reference/api/metadata-deployment/comparedeploytenant.md): Compare and deploy a source tenant to a target tenant. - [POST /deployment-manager/deployments/templates](https://developer.zuora.com/v1-api-reference/api/metadata-deployment/comparedeploytemplate.md): Compare and deploy a template to a tenant. - [POST /deployment-manager/deployments/{migrationId}/revert](https://developer.zuora.com/v1-api-reference/api/metadata-deployment/revertdeployment.md): Revert a deployment. - [GET /deployment-manager/deployments/{migrationId}](https://developer.zuora.com/v1-api-reference/api/metadata-deployment/fetchdeploymentlogs.md): Retrieve a deployment log. - [POST /deployment-manager/deployments/tenant/product_catalog](https://developer.zuora.com/v1-api-reference/api/metadata-deployment/comparedeploytenantproductcatalog.md): Compare and deploy the product catalog of a tenant to a target tenant. - [POST /deployment-manager/deployments/template/product_catalog](https://developer.zuora.com/v1-api-reference/api/metadata-deployment/comparedeploytemplateproductcatalog.md): Compare and deploy a template for product catalog to a tenant. ## Bulk Data - [POST /bulk-data/bulk-jobs](https://developer.zuora.com/v1-api-reference/api/bulk-data/createbulkjob.md): Creates a new bulk job. The job type can be one of Import, Delete, Update, or Cancel. The response includes the job ID and information needed to upload your data file to S3. ### Next Step: Upload the - [POST /bulk-data/bulk-jobs/{id}/submissions](https://developer.zuora.com/v1-api-reference/api/bulk-data/submitbulkjob.md): Submits a previously created bulk job for processing. This endpoint must be called **after** the file has been successfully uploaded to the S3 URL using the `uploadFileInfo` details from the create jo - [GET /bulk-data/bulk-jobs/{id}/summary](https://developer.zuora.com/v1-api-reference/api/bulk-data/getbulkjobsummary.md): Get the summary of a specific job by its ID. This operation returns a summary of the specified bulk job. - [POST /bulk-data/bulk-jobs/{id}/cancellations](https://developer.zuora.com/v1-api-reference/api/bulk-data/cancelbulkjob.md): Cancels an existing bulk job. Once a job is cancelled, no further processing can be done, and its status will be marked as `Cancelled`. **Note**: Cancellation of a job is only allowed before it reache - [POST /bulk-data/bulk-jobs/{id}/aborts](https://developer.zuora.com/v1-api-reference/api/bulk-data/deleteabortjob.md): Aborts an existing job by sending a POST request to this URI. The request URI identifies the job to abort. When a job is aborted, no more records are processed. - [GET /bulk-data/bulk-jobs/{id}/downloads](https://developer.zuora.com/v1-api-reference/api/bulk-data/getdownloadlinksforjob.md): Retrieves the download links for the files associated with a completed job. These files include success rows, error rows, and logs. - [GET /bulk-data/bulk-jobs/summaries](https://developer.zuora.com/v1-api-reference/api/bulk-data/getbulkjobsummaries.md): Lists summaries for bulk jobs. You can filter the results using query parameters. - [GET /bulk-data/bulk-jobs/{id}/mappings](https://developer.zuora.com/v1-api-reference/api/bulk-data/getmappingsforjob.md): Retrieves the mappings for an existing bulk job. The mappings define how columns in the source file correspond to fields in the object type template. ## SCIM - [Prerequisites](https://developer.zuora.com/v1-api-reference/api/scim/prerequisites.md): ### Prerequisites 1. You need to have a One-ID account. 2. You need to create OAuth 2.0 Clients. 3. Use the client credentials to generate the bearer token. 4. Generate the authentication token by hit - [Steps to generate the bearer token](https://developer.zuora.com/v1-api-reference/api/scim/steps-to-generate-the-bearer-token.md): ### Steps to generate the bearer token 1. Hit the endpoint to get the token: ```bash curl --location 'https://one.zuora.com/oauth2/token' \ --header 'Content-Type: application/x-www-form-urlencoded - [GET /scim/v2/Groups](https://developer.zuora.com/v1-api-reference/api/scim/getlistgroups.md): Returns a paginated list of groups, ten groups per page by default. Use the startIndex and count (max 100) query parameters to paginate long lists of groups. It's possible to return a list of specific - [POST /scim/v2/Groups](https://developer.zuora.com/v1-api-reference/api/scim/createanewgroup.md): Creates a new group. Must include the displayName attribute. Users can be added to the group during creation by supplying the user ID values in the members array attribute. - [POST /scim/v2/Groups/bulk](https://developer.zuora.com/v1-api-reference/api/scim/postbulkcreategroups.md): Creates multiple Groups within an organization. Must include the displayName attribute. Users can be added to the group during creation by supplying the user ID values in the members array attribute. - [PATCH /scim/v2/Groups/bulk](https://developer.zuora.com/v1-api-reference/api/scim/patchbulkpatchgroups.md): Updates an existing group resource, allowing individual (or groups of) users to be added or removed from the group with a single operation. Setting the operation attribute of a member object to delet - [POST /scim/v2/Groups/delete](https://developer.zuora.com/v1-api-reference/api/scim/postbulkdeletegroups.md): Permanently removes groups from an organization (members are not deleted, only the group). - [GET /scim/v2/Groups/{id}](https://developer.zuora.com/v1-api-reference/api/scim/getaspecificgroup.md): Retrieves a single group resource. - [PUT /scim/v2/Groups/{id}](https://developer.zuora.com/v1-api-reference/api/scim/updateaspecificgroup.md): Updates an existing group resource, overwriting all values for a group even if an attribute is empty or not provided. PUT will replace all members of a group with those members provided via the member - [DELETE /scim/v2/Groups/{id}](https://developer.zuora.com/v1-api-reference/api/scim/deleteaspecificgroup.md): Permanently removes a group (members are not deleted, only the group). - [PATCH /scim/v2/Groups/{id}](https://developer.zuora.com/v1-api-reference/api/scim/partiallyupdateaspecificgroup.md): Updates an existing group resource, allowing individual (or groups of) users to be added or removed from the group with a single operation. Setting the operation attribute of a member object to delete - [GET /scim/v2/ResourceTypes](https://developer.zuora.com/v1-api-reference/api/scim/gettheressourcetype.md): Retrieves all Resource Types managed by OneId. Resource Types define the resource name, endpoint URL, schemas, and other metadata that indicate where a resource is managed and how it is composed, e.g. - [GET /scim/v2/ResourceTypes/{id}](https://developer.zuora.com/v1-api-reference/api/scim/getaspecificresourcetype.md): Get related information on a single resource type. Examples: ``` /scim/v2/ResourceTypes/User /scim/v2/ResourceTypes/Group ``` - [GET /scim/v2/Schemas](https://developer.zuora.com/v1-api-reference/api/scim/getschemaofscim.md): Lists all schemas for all supported resources. A schema is a collection of attribute definitions that describe the contents of an entire or partial resource, e.g., "urn:ietf:params:scim:schemas:core:2 - [GET /scim/v2/Schemas/{id}](https://developer.zuora.com/v1-api-reference/api/scim/gettheschemaofspecificscim.md): Gets a specific resource schema by ID. Examples: ``` /scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group /scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User /scim/v2/Schemas/urn:zuo - [GET /scim/v2/ServiceProviderConfig](https://developer.zuora.com/v1-api-reference/api/scim/gettheserviceproviderconfig.md): Returns Zuora’s service provider configuration. - [GET /scim/v2/Users](https://developer.zuora.com/v1-api-reference/api/scim/getlistofusers.md): Returns a paginated list of users, 100 users per page by default. When querying larger instances, reduce the count parameter to 1,000 or less, and use the startIndex parameter to paginate through user - [POST /scim/v2/Users](https://developer.zuora.com/v1-api-reference/api/scim/createauser.md): Creates a user. Must include the userName attribute and an email address. User will be created as an SSO user by default and a federated ID must be provided for the user. - [POST /scim/v2/Users/bulk](https://developer.zuora.com/v1-api-reference/api/scim/bulkcreateusers.md): Creates multiple users within an organization. - [PATCH /scim/v2/Users/bulk](https://developer.zuora.com/v1-api-reference/api/scim/bulkupdateusers.md): Updates an existing multiple user resource, overwriting values for specified attributes. - [POST /scim/v2/Users/delete](https://developer.zuora.com/v1-api-reference/api/scim/deletealistofusers.md): Sets multiple users to deactivate. The value of the `id` should be the user's corresponding user ID. - [GET /scim/v2/Users/{id}](https://developer.zuora.com/v1-api-reference/api/scim/getaspecificuser.md): Retrieves a single user resource. The value of the should be the user's corresponding user ID. - [PUT /scim/v2/Users/{id}](https://developer.zuora.com/v1-api-reference/api/scim/updateaspecificuser.md): Updates an existing user resource, overwriting all values for a user even if an attribute is empty or not provided. If an attribute that had been set previously is left blank during a PUT operation, t - [DELETE /scim/v2/Users/{id}](https://developer.zuora.com/v1-api-reference/api/scim/deleteaspecificuser.md): Deactivates a specific user identified by the user ID. - [PATCH /scim/v2/Users/{id}](https://developer.zuora.com/v1-api-reference/api/scim/partialupdateaspecificuser.md): Updates an existing user resource, overwriting values for specified attributes. The value of the {id} should be the user's corresponding user ID. Attributes that are not provided in the request will r ## Audit Logs - [POST /admin/audit/v2/global-logins](https://developer.zuora.com/v1-api-reference/api/audit-logs/searchgloballogins.md): Searches for global login events with page-number based pagination. Returns totalPages and totalElements for direct page navigation. No filter is required for global login queries. - [POST /admin/audit/v2/global-settings](https://developer.zuora.com/v1-api-reference/api/audit-logs/searchglobalsettings.md): Searches for global setting change events with page-number based pagination. Returns totalPages and totalElements for direct page navigation. No filter is required for global setting queries. - [POST /admin/audit/v2/tenant-logins](https://developer.zuora.com/v1-api-reference/api/audit-logs/searchtenantlogins.md): Searches for tenant-level login events with page-number based pagination. Requires a tenantId filter in filter.must. Returns totalPages and totalElements for direct page navigation. - [POST /admin/audit/v2/tenant-settings](https://developer.zuora.com/v1-api-reference/api/audit-logs/searchtenantsettings.md): Searches for tenant-level setting change events with page-number based pagination. Requires a `tenantId` filter in `filter.must`. Returns `totalPages` and `totalElements` for direct page navigation. - [POST /admin/audit/v2/tenant-objects](https://developer.zuora.com/v1-api-reference/api/audit-logs/searchtenantobjects.md): Searches for tenant-level object change events with page-number based pagination. Requires a `tenantId` filter in `filter.must`. Optionally accepts an objectType filter with values such as `USER`, `RO ## Admin Integrations - [GET /admin/integrations/data/global-users](https://developer.zuora.com/v1-api-reference/api/admin-integrations/getglobalusersdata.md): Returns paginated global user data for an organization. Supports filtering by status and standard Spring pagination parameters. - [GET /admin/integrations/data/global-roles](https://developer.zuora.com/v1-api-reference/api/admin-integrations/getglobalrolesdata.md): Returns paginated global roles at the organization level. Supports standard Spring pagination parameters. - [GET /admin/integrations/data/tenant-roles](https://developer.zuora.com/v1-api-reference/api/admin-integrations/gettenantrolesdata.md): Returns paginated roles for a specific tenant entity. Supports standard Spring pagination parameters. - [GET /admin/integrations/data/tenant-roles-permissions](https://developer.zuora.com/v1-api-reference/api/admin-integrations/gettenantrolespermissionsdata.md): Returns paginated tenant roles with their full permission details. Supports standard Spring pagination parameters. ## Data Labeling - [General guidelines](https://developer.zuora.com/v1-api-reference/api/data-labeling/general-guidelines.md): ### General guidelines * Firstly, create the org hierarchy and determine the data categorization strategy, for example, by currency, by region, by custom fields etc. * You have to migrate all customer - [Order of object labeling](https://developer.zuora.com/v1-api-reference/api/data-labeling/order-of-object-labeling.md): ### Order of object labeling Except for `Account` and `Product`, there are no dependencies between objects, users can label them in parallel. But please keep in mind that the data access control ensue - [Caveats⚠️](https://developer.zuora.com/v1-api-reference/api/data-labeling/caveats.md): ### Caveats⚠️ This API is primarily designed for data migration to assist in labeling existing datasets. It may also serve for data corrections, such as reassigning an account's organizational label - [POST /v1/multi-organizations/data-labeling-job](https://developer.zuora.com/v1-api-reference/api/data-labeling/post_datalabelingjob.md): Submits a data labeling job. - [GET /v1/multi-organizations/data-labeling-job/{job-id}](https://developer.zuora.com/v1-api-reference/api/data-labeling/get_datalabelingjob.md): Retrieves a data labeling job. You can use this operation to track the status of the data labeling job. ## Data Backfill - [POST /v1/uno/data-backfill/bookingdate/jobs](https://developer.zuora.com/v1-api-reference/api/data-backfill/post_createbookingdatebackfilljob.md): Creates a booking date backfill job to update the booking date with your charge's original created-on date. - [GET /v1/uno/data-backfill/bookingdate/jobs](https://developer.zuora.com/v1-api-reference/api/data-backfill/get_listbookingdatebackfilljobs.md): Use this operation to list all booking date backfill jobs. - [GET /v1/uno/data-backfill/bookingdate/jobs/{jobId}](https://developer.zuora.com/v1-api-reference/api/data-backfill/get_bookingdatebackfilljobbyid.md): Use this operation to retrieve a specific booking date backfill job. - [PUT /v1/uno/data-backfill/bookingdate/jobs/{jobId}](https://developer.zuora.com/v1-api-reference/api/data-backfill/put_stopbookingdatebackfilljobbyid.md): Use this operation to stop a booking date backfill job. - [POST /v1/uno/data-backfill/jobs](https://developer.zuora.com/v1-api-reference/api/data-backfill/post_createdatabackfilljob.md): Use this operation to perform the following types of data backfill actions. Also, you need to upload a corresponding file to perform a data backfill action. * Update Product Rate Plan Charge * Update - [GET /v1/uno/data-backfill/jobs/{jobId}](https://developer.zuora.com/v1-api-reference/api/data-backfill/get_databackfilljobbyid.md): Returns a single Data Backfill job - [PUT /v1/uno/data-backfill/jobs/{jobId}](https://developer.zuora.com/v1-api-reference/api/data-backfill/put_stopdatabackfilljobbyid.md): Use this operation to stop a data backfill job. - [GET /v1/uno/data-backfill/listjobs](https://developer.zuora.com/v1-api-reference/api/data-backfill/get_listdatabackfilljobs.md) - [GET /v1/uno/data-backfill/jobs/{type}/template](https://developer.zuora.com/v1-api-reference/api/data-backfill/get_databackfilltemplate.md): Use this operation to download a data backfill template file of the specific type. - [GET /v1/uno/data-backfill/propagation/jobs](https://developer.zuora.com/v1-api-reference/api/data-backfill/get_listautobackfilljob.md): Use this operation to list all auto backfill jobs. - [POST /v1/uno/data-backfill/propagation/jobs](https://developer.zuora.com/v1-api-reference/api/data-backfill/post_createautobackfilljob.md): Creates an autobackfill job to update the rate plan charge and order line item with product rate plan charge. - [GET /v1/uno/data-backfill/propagation/jobs/{jobId}](https://developer.zuora.com/v1-api-reference/api/data-backfill/get_autobackfilljobbyid.md): Use this operation to retrieve a specific auto backfill job. - [PUT /v1/uno/data-backfill/propagation/jobs/{jobId}](https://developer.zuora.com/v1-api-reference/api/data-backfill/put_stopautobackfilljobbyid.md): Use this operation to stop an auto backfill job. ## Regenerate - [POST /v1/uno-regenerate/booking-transaction](https://developer.zuora.com/v1-api-reference/api/regenerate/post_regeneratebookingtransaction.md): Use this operation to generate booking transactions. This call is useful in the following two use cases: * During customer onboarding, there is a common scenario when customers perform data backfill o - [POST /v1/uno-regenerate/billing-transaction](https://developer.zuora.com/v1-api-reference/api/regenerate/post_regeneratebillingtransaction.md): Use this operation to generate billing transactions. This call is useful in the following two use cases: * During customer onboarding, there is a common scenario when customers perform data backfill o - [POST /v1/uno-regenerate/rev-rec-events](https://developer.zuora.com/v1-api-reference/api/regenerate/post_createrevrecevents.md): Use this operation to generate Delivery Schedule based revenue recognition events transactions. - [POST /v1/uno-regenerate/rev-rec-events/daily-consumption](https://developer.zuora.com/v1-api-reference/api/regenerate/post_generaterevreceventsfordailyconsumption.md): Use this operation to generate Daily Consumption based revenue recognition events transactions when the Prepaid with Drawdown feature is enabled. ## Test Environments - [GET /test-environments](https://developer.zuora.com/v1-api-reference/api/test-environments/getalltestenvironments.md): Use this operation to retrieves a list of all Test Environments. It returns an ArrayResponse containing TestEnvironmentResponse objects, representing the available Test Environments in the system. ### - [GET /test-environments/{id}](https://developer.zuora.com/v1-api-reference/api/test-environments/gettestenvironment.md): Use this operation to retrieves a specific Test Environment by its unique identifier. It returns a TestEnvironmentResponse object if the environment is found. If the specified Test Environment does no ## Test Environment Jobs - [POST /test-environments/{id}/jobs](https://developer.zuora.com/v1-api-reference/api/test-environment-jobs/createtestenvironmentjob.md): Use this operation to create a new job for a specific Test Environment. It handles HTTP POST requests to the /test-environments/{id}/jobs endpoint, accepting a JobRequest object in the request body. U - [GET /test-environments/{id}/jobs](https://developer.zuora.com/v1-api-reference/api/test-environment-jobs/getalljobsoftestenvironment.md): Use this operation to retrieve a list of job responses associated with a specific Test Environment. It handles HTTP GET requests to the /test-environments/{id}/jobs endpoint and returns an ArrayRespon - [GET /test-environments/{id}/jobs/{jobId}](https://developer.zuora.com/v1-api-reference/api/test-environment-jobs/getjoboftestenvironment.md): Use this operation to retrieve a specific job associated with a Test Environment by its unique job ID. It handles HTTP GET requests to the /test-environments/{id}/jobs/{jobId} endpoint and returns a J - [POST /test-environments/{id}/jobs/{jobId}/actions](https://developer.zuora.com/v1-api-reference/api/test-environment-jobs/performactionofjob.md): Use this operation to perform a specified action on a Test Environment job. It handles HTTP POST requests to the /test-environments/{id}/jobs/{jobId}/actions endpoint, accepting a JobActionRequest obj ## Test Environment Notifications - [POST /test-environments/{id}/notifications](https://developer.zuora.com/v1-api-reference/api/test-environment-notifications/createtestenvironmentnotification.md): Use this operation to create a new notification for a specific Test Environment. It handles HTTP POST requests to the /test-environments/{id}/notifications endpoint, accepting a TestEnvironmentNotific - [GET /test-environments/{id}/notifications](https://developer.zuora.com/v1-api-reference/api/test-environment-notifications/getallemailnotificationoftestenv.md): Use this operation to retrieve all notifications associated with a specific Test Environment. It handles HTTP GET requests to the /test-environments/{id}/notifications endpoint and returns an ArrayRes - [GET /test-environments/{id}/notifications/{notificationId}](https://developer.zuora.com/v1-api-reference/api/test-environment-notifications/gettestenvironmentnotification.md): Use this operation to retrieve a specific notification associated with a Test Environment by its unique notification ID. It handles HTTP GET requests to the /test-environments/{id}/notifications/{noti - [PATCH /test-environments/{id}/notifications/{notificationId}](https://developer.zuora.com/v1-api-reference/api/test-environment-notifications/updatetestenvironmentnotification.md): Use this operation to update an existing notification for a specific Test Environment. It handles HTTP PATCH requests to the /test-environments/{id}/notifications/{notificationId} endpoint, accepting - [DELETE /test-environments/{id}/notifications/{notificationId}](https://developer.zuora.com/v1-api-reference/api/test-environment-notifications/deletetestenvironmentnotification.md): Use this operation to delete a specific notification associated with a Test Environment. It handles HTTP DELETE requests to the /test-environments/{id}/notifications/{notificationId} endpoint and retu ## Actions - [POST /v1/action/create](https://developer.zuora.com/v1-api-reference/api/actions/action_postcreate.md): Use 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 apply to only one type of object. ### Limitat - [POST /v1/action/delete](https://developer.zuora.com/v1-api-reference/api/actions/action_postdelete.md): Deletes 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 object. The following information applies t - [POST /v1/action/query](https://developer.zuora.com/v1-api-reference/api/actions/action_postquery.md): 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. You can use [ - [POST /v1/action/queryMore](https://developer.zuora.com/v1-api-reference/api/actions/action_postquerymore.md): Use 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 query for the additional results. Any `query - [POST /v1/action/update](https://developer.zuora.com/v1-api-reference/api/actions/action_postupdate.md): Updates 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 update call must apply to only one type of obje ## Settings - [POST /settings/batch-requests](https://developer.zuora.com/v1-api-reference/api/settings/post_processsettingsbatchrequest.md): Submit a batch of settings requests by this single API operation. See a [200 response sample in CSV format](https://developer.zuora.com/settings-api/ListAllSettingsResponseSample.csv) that lists all a - [GET /settings/listing](https://developer.zuora.com/v1-api-reference/api/settings/get_listallsettings.md): Get a list of all available settings in your tenant. The response message is by default in JSON format. If you want to receive all the available settings in csv format, include `Accept` in the header ## Files - [GET /v1/files/{file-id}](https://developer.zuora.com/v1-api-reference/api/files/get_files.md): Retrieve files such as export results, invoices, and accounting period reports. The response content type depends on the type of file that you retrieve. For example, if you retrieve an invoice PDF, th - [PUT /v1/files/{file-id}/restore](https://developer.zuora.com/v1-api-reference/api/files/put_files.md): Restores a previously archived file to its RESTORED status. Once a file is archived, it cannot be used directly until the file is restored using this API. ### Notes - This API operation will fail if t - [GET /v1/files/{file-id}/status](https://developer.zuora.com/v1-api-reference/api/files/get_filestatus.md): Retrieves the status of the file. ## Imports - [POST /v1/object/import](https://developer.zuora.com/v1-api-reference/api/imports/object_postimport.md): Creates a data import. - [GET /v1/object/import/{id}](https://developer.zuora.com/v1-api-reference/api/imports/object_getimport.md): Retrieve an data import job. ## Custom Exchange Rates - [GET /v1/custom-exchange-rates/{currency}](https://developer.zuora.com/v1-api-reference/api/custom-exchange-rates/get_customexchangerates.md): This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). This reference describes how to query cus ## Attachments - [POST /v1/attachments](https://developer.zuora.com/v1-api-reference/api/attachments/post_attachments.md): 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. You can only use this operation if y - [DELETE /v1/attachments/{attachment-id}](https://developer.zuora.com/v1-api-reference/api/attachments/delete_attachments.md): Use the Delete Attachment REST request to delete an attachment from a Zuora object. You can only use this operation if you have a Billing role that includes the Manage Attachments permission and the D - [GET /v1/attachments/{attachment-id}](https://developer.zuora.com/v1-api-reference/api/attachments/get_attachments.md): Use the View Attachment REST request to retrieve information about an attachment document. You can only use this operation if you have a Billing role that includes the Manage Attachments permission. F - [PUT /v1/attachments/{attachment-id}](https://developer.zuora.com/v1-api-reference/api/attachments/put_attachments.md): Use 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 the actual content of the attached file in - [GET /v1/attachments/{object-type}/{object-key}](https://developer.zuora.com/v1-api-reference/api/attachments/get_attachmentslist.md): 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. You can only use this operation if you have a Billing role ## Metadata - [GET /object-metadata](https://developer.zuora.com/v1-api-reference/api/metadata/listmetadataobjects.md): Returns all available objects for the specified metadata context. Each object includes basic metadata such as object name, label, category, custom field support indicator, and a link to retrieve the f - [GET /object-metadata/{objectName}](https://developer.zuora.com/v1-api-reference/api/metadata/retrievemetadataobjectschema.md): Returns the complete JSON Schema for the specified object. The response includes standard JSON Schema properties and Zuora-specific metadata extensions, including field types, constraints, relationshi ## Describe - [GET /v1/describe/{object}](https://developer.zuora.com/v1-api-reference/api/describe/get_describe.md): Provides 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: Create Export](https://developer.zuora.com/a ## Products - [POST /v1/object/product](https://developer.zuora.com/v1-api-reference/api/products/object_postproduct.md) - [GET /v1/object/product/{id}](https://developer.zuora.com/v1-api-reference/api/products/object_getproduct.md): Retrieve a specific product. - [PUT /v1/object/product/{id}](https://developer.zuora.com/v1-api-reference/api/products/object_putproduct.md): Updates a Product object. - [DELETE /v1/object/product/{id}](https://developer.zuora.com/v1-api-reference/api/products/object_deleteproduct.md): Deletes a specific product. ## Catalog - [GET /v1/catalog/products](https://developer.zuora.com/v1-api-reference/api/catalog/get_catalog.md): Retrieves the entire product catalog, including all products, features, and their corresponding product rate plans, charges. Products are returned in reverse chronological order on the `UpdatedDate` f - [GET /v1/catalog/products/{product-key}](https://developer.zuora.com/v1-api-reference/api/catalog/get_product.md): Retrieves detailed information about a specific product, including information about its product rate plans and charges. This operation returns a maximum of 300 product rate plans and 300 product ra ## Catalog Groups - [POST /v1/catalog-groups](https://developer.zuora.com/v1-api-reference/api/catalog-groups/post_createcataloggroup.md): **Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this earl - [GET /v1/catalog-groups](https://developer.zuora.com/v1-api-reference/api/catalog-groups/get_listallcataloggroups.md): **Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this earl - [GET /v1/catalog-groups/{catalog-group-key}](https://developer.zuora.com/v1-api-reference/api/catalog-groups/get_retrievecataloggroup.md): **Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this earl - [PUT /v1/catalog-groups/{catalog-group-key}](https://developer.zuora.com/v1-api-reference/api/catalog-groups/put_updatecataloggroup.md): **Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this earl - [DELETE /v1/catalog-groups/{catalog-group-key}](https://developer.zuora.com/v1-api-reference/api/catalog-groups/delete_cataloggroup.md): **Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this earl ## Product Rate Plans - [GET /v1/products/{product-key}/product-rate-plans](https://developer.zuora.com/v1-api-reference/api/product-rate-plans/get_productrateplans.md): Retrieves information about all product rate plans of a specific product. - [GET /v1/product-rate-plans/{id}](https://developer.zuora.com/v1-api-reference/api/product-rate-plans/get_productrateplan.md): Retrieves a product rate plan by its ID. - [GET /v1/product-rate-plans/external-id/{id}](https://developer.zuora.com/v1-api-reference/api/product-rate-plans/get_productrateplansbyexternalid.md): Retrieves information about one or multiple product rate plans by external ID. - [POST /v1/object/product-rate-plan](https://developer.zuora.com/v1-api-reference/api/product-rate-plans/object_postproductrateplan.md): Retrieves a product rate plan. - [GET /v1/object/product-rate-plan/{id}](https://developer.zuora.com/v1-api-reference/api/product-rate-plans/object_getproductrateplan.md): Retrieves a product rate plan. - [PUT /v1/object/product-rate-plan/{id}](https://developer.zuora.com/v1-api-reference/api/product-rate-plans/object_putproductrateplan.md): Updates a product rate plan. - [DELETE /v1/object/product-rate-plan/{id}](https://developer.zuora.com/v1-api-reference/api/product-rate-plans/object_deleteproductrateplan.md): Deletes a product rate plan. ## Product Rate Plan Definitions - [POST /v1/product-rateplan-definitions](https://developer.zuora.com/v1-api-reference/api/product-rate-plan-definitions/post_createproductrateplandefinition.md): Creates a product rate plan definition to use a charge in a product rate plan. In the request, you must specify either the unique ID or number of both the charge and the product rate plan to add the s - [GET /v1/product-rateplan-definitions](https://developer.zuora.com/v1-api-reference/api/product-rate-plan-definitions/get_retrieveproductrateplandefinitions.md): Retrieves basic information about the product rate plan definitions for a product rate plan. **Note**: This operation requires the [Attribute-based Pricing](https://docs.zuora.com?resourceId=billing-a - [GET /v1/product-rateplan-definitions/{product-rateplan-definition-key}](https://developer.zuora.com/v1-api-reference/api/product-rate-plan-definitions/get_retrieveproductrateplandefinition.md): Retrieves basic information about a product rate plan definition. **Note**: This operation requires the [Attribute-based Pricing](https://docs.zuora.com?resourceId=billing-attribute-based-pricing) fea - [DELETE /v1/product-rateplan-definitions/{product-rateplan-definition-key}](https://developer.zuora.com/v1-api-reference/api/product-rate-plan-definitions/delete_productrateplandefnition.md): Deletes a product rate plan definition. **Note**: This operation requires the [Attribute-based Pricing](https://docs.zuora.com?resourceId=billing-attribute-based-pricing) feature to be enabled, which ## Product Rate Plan Charges - [GET /v1/product-rate-plan-charges/{product-rate-plan-charge-key}](https://developer.zuora.com/v1-api-reference/api/product-rate-plan-charges/get_retrieveproductrateplancharge.md): Retrieves basic information about a product rate plan charge. **Note**: A request header `X-Zuora-WSDL-Version` greater than `155.0` is required. - [POST /v1/object/product-rate-plan-charge](https://developer.zuora.com/v1-api-reference/api/product-rate-plan-charges/object_postproductrateplancharge.md): Creates 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 fees. **Note**: To use the enhanced unit- - [GET /v1/object/product-rate-plan-charge/{id}](https://developer.zuora.com/v1-api-reference/api/product-rate-plan-charges/object_getproductrateplancharge.md): Retrieves a specific product rate plan charge. **Note**: To use the enhanced unit-based Prepaid with Drawdown fields, set the `X-Zuora-WSDL-Version` request header to a value greater than `155.0`. - [PUT /v1/object/product-rate-plan-charge/{id}](https://developer.zuora.com/v1-api-reference/api/product-rate-plan-charges/object_putproductrateplancharge.md): Updates the information about a product rate plan charge. **Note**: To use the enhanced unit-based Prepaid with Drawdown fields, set the `X-Zuora-WSDL-Version` request header to a value greater than ` - [DELETE /v1/object/product-rate-plan-charge/{id}](https://developer.zuora.com/v1-api-reference/api/product-rate-plan-charges/object_deleteproductrateplancharge.md): Deletes a product rate plan charge. ## Product Charge Definitions - [POST /v1/product-charge-definitions](https://developer.zuora.com/v1-api-reference/api/product-charge-definitions/post_createproductchargedefinition.md): Creates a product charge definition for a charge. You can create as many product charge definitions as needed for one charge. In the request, you must specify the unique ID or number of the charge for - [GET /v1/product-charge-definitions](https://developer.zuora.com/v1-api-reference/api/product-charge-definitions/get_retrieveproductchargedefinitions.md): Retrieves basic information about the product charge definitions. **Note**: This operation requires the [Attribute-based Pricing](https://docs.zuora.com?resourceId=billing-attribute-based-pricing) fea - [POST /v1/product-charge-definitions/bulk](https://developer.zuora.com/v1-api-reference/api/product-charge-definitions/post_createproductchargedefinitionbulk.md): Bulk creates product charge definitions for a charge. You can create up to 1000 product charge definitions at a given time for a specific charge. In the request, you must specify the unique ID or numb - [PUT /v1/product-charge-definitions/bulk](https://developer.zuora.com/v1-api-reference/api/product-charge-definitions/put_updateproductchargedefinitionbulk.md): Bulk updates multiple product charge definitions. **Note**: This operation requires the [Attribute-based Pricing](https://docs.zuora.com?resourceId=billing-attribute-based-pricing) feature to be enabl - [GET /v1/product-charge-definitions/{product-charge-definition-key}](https://developer.zuora.com/v1-api-reference/api/product-charge-definitions/get_retrieveproductchargedefinition.md): Retrieves basic information about a product charge definition. **Note**: This operation requires the [Attribute-based Pricing](https://docs.zuora.com?resourceId=billing-attribute-based-pricing) featur - [PUT /v1/product-charge-definitions/{product-charge-definition-key}](https://developer.zuora.com/v1-api-reference/api/product-charge-definitions/put_updateproductchargedefinition.md): Update a product charge definition. **Note**: This operation requires the [Attribute-based Pricing](https://docs.zuora.com?resourceId=billing-attribute-based-pricing) feature to be enabled, which is i - [DELETE /v1/product-charge-definitions/{product-charge-definition-key}](https://developer.zuora.com/v1-api-reference/api/product-charge-definitions/delete_productchargedefnition.md): Deletes a product charge definition. **Note**: This operation requires the [Attribute-based Pricing](https://docs.zuora.com?resourceId=billing-attribute-based-pricing) feature to be enabled, which is ## Product Rate Plan Charge Tiers - [GET /v1/object/product-rate-plan-charge-tier/{id}](https://developer.zuora.com/v1-api-reference/api/product-rate-plan-charge-tiers/object_getproductrateplanchargetier.md): Retrieves a specific product rate plan charge tier. - [PUT /v1/object/product-rate-plan-charge-tier/{id}](https://developer.zuora.com/v1-api-reference/api/product-rate-plan-charge-tiers/object_putproductrateplanchargetier.md): Updates 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](https://developer.zuora.com/api-references/ ## Zuora Revenue Integration - [PUT /v1/revpro-accounting-codes](https://developer.zuora.com/v1-api-reference/api/zuora-revenue-integration/put_revproaccountingcodes.md): Update the Zuora Revenue accounting code that corresponds to a specific Product Rate Plan Charge Id in Zuora Billing.