Zuora
API integration

create_a_zuora_oauth_token

Create an OAuth bearer token in Zuora for authenticating with the REST API. Returns: access_token, expires_in, jti, scope, token_type. Required: client_id, client_secret, grant_type. The grant_type must be `client_credentials`; the OAuth client must already exist in Zuora.

create_a_zuora_object_product

CRUD: Create a product. Returns: Id, Success. Required: EffectiveEndDate, EffectiveStartDate, Name.

get_single_zuora_object_product_by_id

Get a specific Zuora product by id. Returns the full product object including Id, Name, SKU, Description, EffectiveStartDate, EffectiveEndDate, CreatedDate, and UpdatedDate. Required: id.

update_a_zuora_object_product_by_id

Update an existing Zuora product object by id. Returns the product Id and a Success boolean confirming the update. Required: id.

delete_a_zuora_object_product_by_id

Delete a Zuora product by id. Returns: id, success. Required: id.

list_all_zuora_catalog_products

List all products in the Zuora catalog including rate plans and charges. Returns: nextPage, products, success, category, description, effectiveEndDate, effectiveStartDate, id, name, productNumber, productRatePlans, sku. Products are sorted in reverse chronological order by updated date; up to 300 rate plans and 300 charges per product.

get_single_zuora_catalog_product_by_id

Retrieve a single Zuora catalog product by ID, SKU, or product number. Returns: category, description, effectiveEndDate, effectiveStartDate, id, name, organizationLabels, productFeatures, productNumber, productRatePlans, sku, tags, IntegrationId__NS, IntegrationStatus__NS, and 3 more. Required: id. Returns up to 300 rate plans and 300 charges.

list_all_zuora_catalog_groups

List all catalog groups in Zuora. Returns each group's id, name, catalogGroupNumber, description, type, and productRatePlans. This operation is in the Early Adopter phase.

create_a_zuora_catalog_group

Create a catalog group in Zuora that groups a list of product rate plans. Returns the created group including id, name, catalogGroupNumber, description, type, and productRatePlans. This operation is in the Early Adopter phase.

get_single_zuora_catalog_group_by_id

Retrieve a single Zuora catalog group by its id or catalog group number. Returns: catalogGroupNumber, description, id, name, productRatePlans, type. Required: id. This operation is in the Early Adopter phase.

update_a_zuora_catalog_group_by_id

Update a Zuora catalog group by its unique number or ID. Returns the updated catalog group including id, name, description, catalogGroupNumber, productRatePlans, and type. Required: id. Only specify the fields you want to change; the catalog group type cannot be changed.

delete_a_zuora_catalog_group_by_id

Delete a Zuora catalog group by its unique number or ID. Returns: processId, reasons, requestId, success. Required: id.

list_all_zuora_product_product_rate_plans

List all product rate plans for a specific Zuora product. Returns: nextPage, productRatePlans, success. Required: product_key.

get_single_zuora_product_rate_plan_by_id

Get a Zuora product rate plan by its ID, external ID, or natural key. Returns: ExternalIdSourceSystem, description, effectiveEndDate, effectiveStartDate, externallyManagedPlanIds, grade, id, name, organizationLabels, productRatePlanNumber, status, success, externalIdSourceSystem. Required: id.

get_single_zuora_product_rate_plans_external_id_by_id

Get one or more Zuora product rate plans by external ID. Returns the success flag and a productRatePlans array, where each plan includes id, status, name, description, effectiveStartDate, effectiveEndDate, externalIdSourceSystem, externallyManagedPlanIds, and productRatePlanNumber. Required: id.

create_a_zuora_object_product_rate_plan

Create a new product rate plan in Zuora. Returns: Id, Success. Required: Name, ProductId.

get_single_zuora_object_product_rate_plan_by_id

Get a product rate plan in Zuora by id. Returns: ActiveCurrencies, CreatedById, CreatedDate, Description, EffectiveEndDate, EffectiveStartDate, Grade, Id, Name, ProductId, UpdatedById, UpdatedDate, BillingPeriod__NS, Class__NS, Department__NS, IncludeChildren__NS, IntegrationId__NS, IntegrationStatus__NS, ItemType__NS, and 5 more. Required: id.

update_a_zuora_object_product_rate_plan_by_id

Update a product rate plan in Zuora by id. Returns: Id, Success. Required: id.

delete_a_zuora_object_product_rate_plan_by_id

Delete a product rate plan in Zuora by id. Returns: id, success. Required: id.

list_all_zuora_product_rateplan_definitions

List product rate plan definitions in Zuora, optionally filtered by charge or rate plan. Returns: productRatePlanDefinitions, success. Requires the Attribute-based Pricing feature (Early Adopter) to be enabled.

create_a_zuora_product_rateplan_definition

Create a product rate plan definition in Zuora to use a charge in a product rate plan. Returns: id, success. Requires specifying either the unique ID or number of both the charge and the product rate plan in the request body. Requires the Attribute-based Pricing feature (Early Adopter).

get_single_zuora_product_rateplan_definition_by_id

Get a Zuora product rate plan definition by id. Returns: id, productRatePlanChargeId, productRatePlanChargeName, productRatePlanChargeNumber, productRatePlanId, productRatePlanName, productRatePlanNumber, success. Required: id. Requires the Attribute-based Pricing feature (Early Adopter).

delete_a_zuora_product_rateplan_definition_by_id

Delete a Zuora product rate plan definition by id. Returns: processId, reasons, requestId, success. Required: id. Requires the Attribute-based Pricing feature (Early Adopter).

get_single_zuora_product_rate_plan_charge_by_id

Get a Zuora product rate plan charge by id. Returns the full charge object including id, name, type, model, pricing, billingPeriod, taxCode, financeInformation, and success. Required: id.

create_a_zuora_object_product_rate_plan_charge

Create a product rate plan charge in Zuora. Charges can be one-time fees, recurring fees, or usage fees. Returns: Id, Success. Required: BillCycleType, BillingPeriod, ChargeModel, ChargeType, Name, ProductRatePlanChargeTierData, ProductRatePlanId, TriggerEvent, UseDiscountSpecificAccountingCode.

get_single_zuora_object_product_rate_plan_charge_by_id

Get a single Zuora product rate plan charge by id. Returns the full charge object including Id, Name, ChargeModel, ChargeType, ProductRatePlanId, BillingPeriod, TriggerEvent, CreatedDate, UpdatedDate, and prepaid/drawdown configuration fields. Required: id.

update_a_zuora_object_product_rate_plan_charge_by_id

Update a Zuora product rate plan charge by id. Returns: Id, Success. Required: id, BillCycleType, BillingPeriod, ChargeModel, ProductRatePlanChargeTierData, ProductRatePlanId, TriggerEvent, UseDiscountSpecificAccountingCode.

delete_a_zuora_object_product_rate_plan_charge_by_id

Delete a Zuora product rate plan charge by id. Returns: id, success. Required: id.

list_all_zuora_product_charge_definitions

List Zuora product charge definitions, optionally filtered by charge or rate plan. Returns: chargeDefinitions, success. Requires the Attribute-based Pricing feature (Early Adopter phase).

create_a_zuora_product_charge_definition

Create a product charge definition for a charge in Zuora. Returns: chargeDefinitionId, chargeDefinitionNumber, success. The request must specify the unique ID or number of the charge for which this definition is created; the product rate plan ID or number is optional. Requires the Attribute-based Pricing feature (Early Adopter phase).

zuora_product_charge_definitions_bulk_create

Bulk create up to 1000 product charge definitions for a specific charge in Zuora. Returns: summary, results, success. The request body must specify the charge ID or number; the product rate plan ID or number is optional. Requires the Attribute-based Pricing feature to be enabled.

zuora_product_charge_definitions_bulk_update

Bulk update multiple product charge definitions in Zuora. Returns: chargeDefinitions, success. Requires the Attribute-based Pricing feature (Early Adopter phase).

get_single_zuora_product_charge_definition_by_id

Get a Zuora product charge definition by id. Returns: applyDiscountTo, billingDay, billingPeriod, billingPeriodAlignment, billingTiming, chargeModel, chargeType, customFields, defaultQuantity, deliverySchedule, description, discountClass, discountLevel, effectiveEndDate, effectiveStartDate, endDateCondition, and 52 more. Required: id.

update_a_zuora_product_charge_definition_by_id

Update a Zuora product charge definition by id. Returns the updated charge definition including productChargeDefinitionId, productChargeDefinitionNumber, chargeModel, billingPeriod, prices, and success. Required: id. Requires the Attribute-based Pricing feature (Early Adopter).

delete_a_zuora_product_charge_definition_by_id

Delete a Zuora product charge definition by id. Returns: processId, reasons, requestId, success. Required: id. Requires the Attribute-based Pricing feature (Early Adopter).

get_single_zuora_object_product_rate_plan_charge_tier_by_id

Get a Zuora product rate plan charge tier by id. Returns: CreatedById, CreatedDate, Currency, EndingUnit, Id, Price, PriceFormat, StartingUnit, Tier, UpdatedById, UpdatedDate. Required: id.

update_a_zuora_object_product_rate_plan_charge_tier_by_id

Update the price of a Zuora product rate plan charge tier by id. Returns: Id, Success. Required: id. Only the price can be updated via this endpoint; for other field updates use the product rate plan charge update endpoint with ProductRatePlanChargeTierData.

zuora_revpro_accounting_codes_bulk_update

Update a Zuora Revenue accounting code. Returns: success. Required: adjustmentLiabilityAccount, adjustmentRevenueAccount, contractAssetAccount, contractLiabilityAccount, productRatePlanChargeId, recognizedRevenueAccount, unbilledReceivablesAccount.

create_a_zuora_commerce_charge

Create a product rate plan charge (PRPC) with Dynamic Pricing in the Zuora Product Catalog, configuring default pricing at the charge level and conditional rate cards evaluated by attribute values. Returns: accounting, attributes, billCycle, chargeFunction, chargeModel, chargeType, createdById, createdTime, and 42 more. Required: charge.

zuora_commerce_charges_bulk_update

Update an existing product rate plan charge (PRPC) in Zuora with Dynamic Pricing, including default pricing and/or conditional rate cards. Returns the full updated charge object including id, name, chargeModel, chargeType, pricing, productRatePlanChargeNumber, and createdTime. Required: charge.

create_a_zuora_charges_query

Query a product rate plan charge in Zuora by evaluating Dynamic Pricing against provided attribute values. Returns the matching PRPC object including its id, name, chargeModel, chargeType, pricing, and productRatePlanChargeNumber. If a matching rate-card row is found its pricing is returned; otherwise the default charge-level pricing is used.

create_a_zuora_commerce_product

Create a product in the Zuora Product Catalog with one or more plans and charges. Charges can be usage (per-unit), recurring (flat fee), or other supported models. Returns: id, name, category, description, productNumber, sku, startDate, endDate, state, allowFeatureChanges, and 13 more. Required: name, start_date, end_date, category, plans.

get_single_zuora_commerce_product_by_id

Get a Zuora commerce product by its product key (ID or product number). Returns: allowFeatureChanges, category, contextFilters, createdBy, createdTime, customFields, customObjects, dacTag, endDate, features, id, legacyFeatures, name, netsuite, organizationLabels, productNumber, and 8 more. The request body optionally expands…. Required: id.

zuora_commerce_products_bulk_update

Update an existing product in the Zuora Product Catalog, including core fields such as name, description, category, effective dates, and custom fields. Returns: id, name, description, category, productNumber, sku, startDate, endDate, state, allowFeatureChanges, features, legacyFeatures, contextFilters, customFields, and 8 more. Required: id.

create_a_zuora_commerce_plan

Create a product rate plan in Zuora under an existing product, including one or more charges. Each charge must include name, charge_model, charge_type, bill_cycle, trigger_event, end_date_condition, and pricing. Returns: id, name, displayName, description, and 19 more. Required: product_key, name, start_date, end_date, active_currencies, charges.

zuora_commerce_plans_bulk_update

Update an existing product rate plan in Zuora, modifying core fields such as name, description, grade, and effective dates. Returns: id, name, description, productId, productRatePlanNumber, startDate, endDate, state, status, activeCurrencies, displayName, attributes, contextFilters, entitlements, externalIdSourceSystem, and 9 more. Required: id.

create_a_zuora_plans_query

Query details of a single Zuora product rate plan (PRP) by its key, optionally expanding associated product rate plan charges. Returns: accounting, attributes, billCycle, chargeFunction, chargeModel, chargeType, createdById, createdTime, customFields, deliverySchedule, discountOptions, drawdown, endDateCondition, upToPeriodsType, and 54 more

create_a_zuora_plans_list

Query product rate plans from the Zuora Product Catalog using filters such as plan ID, name, or product ID. Optionally expand related product rate plan charges in the response. Returns: values. Required: filters.

create_a_zuora_products_list

Query legacy products from the Zuora Product Catalog in V1 response format for migration compatibility. Returns: values. Default pageSize is 20, max is 40; results are ordered descending by updated_on.

zuora_commerce_tiers_bulk_update

Update a Zuora product rate plan charge tier's price and other editable attributes by providing the tier id in the request body. Returns: id, currency, price, startingUnit, endingUnit, tier, isOveragePrice, priceFormat, createdById, createdTime, updatedById, updatedTime. Required: id, price.

create_a_zuora_purchase_options_list

Query purchase options (product rate plans) in Zuora by PRP ID or product ID, with optional expansion of product rate plan charges. Returns: error, productRatePlans.

create_a_zuora_account

Create a customer account in Zuora with a payment method, bill-to contact, and optional sold-to and ship-to contacts. Optionally creates a subscription, invoices it, and collects payment through the default payment method in a single atomic transaction — if any part fails, the entire operation is rolled back. Returns: accountId, accountNumber, billToContactId, and 13 more. Required: billToContact, currency, name.

get_single_zuora_account_by_id

Get basic information about a Zuora customer account by id. Returns: basicInfo, billToContact, billingAndPayment, einvoiceProfile, eReportingProfile, gatewayRoutingEligible, metrics, metricsData, shipToContact, soldToContact, success, taxInfo. Required: id. This quick retrieval excludes subscriptions, invoices, payments, and usage details.

update_a_zuora_account_by_id

Update a Zuora customer account by id. Returns: processId, reasons, requestId, success. Required: id. Only fields to be changed should be specified; omitted fields are left unchanged, while submitting an empty field will clear the corresponding account value.

delete_a_zuora_account_by_id

Delete a Zuora account asynchronously by id. The system starts a backend job that removes all transactions under the account and sets its status to 'Cancelled'. Returns: id, jobId, jobStatus, and 2 more. Required: id. An account cannot be deleted if it is the invoice owner or subscription owner of a subscription whose two owners differ (unless force deletion is enabled), or if the account…

list_all_zuora_account_payment_methods

List payment methods for a Zuora account, grouped by type. Returns: defaultPaymentMethodId, paymentGateway, returnedPaymentMethodType, success, ach, creditcard, creditcardreferencetransaction, debitcard. Required: account_key.

get_single_zuora_account_payment_method_by_id

Get the default payment method of a Zuora account. Returns: accountHolderInfo, accountVerificationService, accountVerificationStatus, bankIdentificationNumber, createdBy, createdOn, cardNumber, creditCardType, deviceSessionId, existingMandate, id, ipAddress, isDefault, lastFailedSaleTransactionDate, lastTransaction, and 46 more. Required: id.

get_single_zuora_payment_methods_cascading_by_id

Retrieve the cascading payment method configuration for a Zuora account, including the cascading consent value and the ordered priority list of payment methods used for dynamic payment retries. Returns: consent, priorities, success. Required: id. The Cascading Payment Method feature must be enabled on the account.

zuora_payment_methods_cascadings_bulk_update

Configure cascading payment method settings for a Zuora account by setting the cascading consent value and defining the priority list of payment methods for dynamic payment retries. Returns: processId, reasons, requestId, success. Required: account_key. The Cascading Payment Method feature must be enabled on the account.

get_single_zuora_account_summary_by_id

Retrieve a Zuora account summary with detailed customer account information including subscriptions, invoices, payments, and usage data. Returns: basicInfo, billToContact, invoices, payments, and 6 more. Required: id. Only the six most recent subscriptions are returned, and array sizes for rate plans and rate plan charges are subject to…

create_a_zuora_contact

Create a contact for a specified Zuora account. Returns: accountId, accountNumber, address1, address2, asBillTo, asShipTo, asSoldTo, city, contactDescription, country, county, fax, firstName, homePhone, lastName, mobilePhone, nickname, otherPhone, otherPhoneType, and 8 more. A maximum of 2000 contacts can be…. Required: firstName, lastName.

get_single_zuora_contact_by_id

Retrieve a specific Zuora contact by id. Returns: accountId, accountNumber, address1, address2, asBillTo, asShipTo, asSoldTo, city, contactDescription, country, county, fax, firstName, homePhone, lastName, mobilePhone, nickname, otherPhone, otherPhoneType, personalEmail, state, success, taxRegion, workEmail, workPhone, zipCode, id. Required: id.

update_a_zuora_contact_by_id

Update a Zuora contact by id. Returns: accountId, accountNumber, address1, address2, asBillTo, asShipTo, asSoldTo, city, contactDescription, country, county, fax, firstName, homePhone, lastName, mobilePhone, nickname, otherPhone, otherPhoneType, personalEmail, state, and 6 more. Required: id. Contacts for cancelled accounts can also be updated.

delete_a_zuora_contact_by_id

Delete a Zuora contact by id. Returns: processId, reasons, requestId, success. Required: id.

zuora_contact_transfers_bulk_update

Transfer a Zuora contact within the Customer Hierarchy when removing an account. Returns: processId, reasons, requestId, success. Required: contact_id.

zuora_contact_scrubs_bulk_update

Scrub sensitive data of a specific Zuora contact, replacing all sensitive data in the contact and its related contact snapshot with dummy values stored in Zuora databases. Returns: processId, reasons, requestId, success. Required: contact_id. After scrubbing, it is good practice to delete the contact to avoid errors in subsequent operations.

get_single_zuora_contact_snapshot_by_id

Get a single contact snapshot in Zuora by id, retrieving detailed information about a bill-to or sold-to contact snapshot. Returns: address1, address2, asBillTo, asShipTo, asSoldTo, city, contactId, country, county, description, fax, firstName, homePhone, id, lastName, mobilePhone, nickname, otherPhone, otherPhoneType, and 7 more. Required: id.

create_a_zuora_sign_up

Sign up a new or existing customer in Zuora — create an account, payment method, subscription, invoice, and collect payment in a single call. Returns: accountId, accountNumber, creditMemoId, creditMemoNumber, invoiceId, invoiceNumber, orderNumber, paidAmount, paymentId, paymentNumber, processId, and 5 more. Requires a JSON request body. The Orders…

create_a_zuora_orders_preview

Preview a Zuora order to retrieve charge metrics and invoice items without creating an order. Returns: processId, reasons, requestId, success, previewResult. The request body is required. Up to 50 subscriptions and 50 order actions per call; cannot preview enhanced discounts or usage charges. Required: orderDate, previewOptions.

list_all_zuora_orders

List all Zuora orders in your tenant, optionally filtered by status and date range. Returns: nextPage, orders, success.

create_a_zuora_order

Create a Zuora order that starts or changes subscriptions and adds order line items in a single call. Returns: processId, reasons, requestId, success, accountId, accountNumber, commitments, creditMemoIds, creditMemoNumbers, invoiceIds, orderNumber, status, and 13 more. Required: orderDate. On a timeout the order is still created in the backend.

update_a_zuora_order_by_id

Update a draft or scheduled Zuora order by id (orderNumber); the full order payload must be resent or unspecified order actions are removed. Returns: processId, reasons, requestId, success, accountId, accountNumber, creditMemoIds, creditMemoNumbers, invoiceIds, invoiceNumbers, orderId, orderNumber, status, and 11 more. Required: id, orderDate.

delete_a_zuora_order_by_id

Delete a Zuora order by id (orderNumber); its order line items are removed and affected subscriptions roll back to the previous version. Returns: processId, reasons, requestId, success. Orders whose affected charges are invoiced cannot be deleted. Required: id.

get_single_zuora_order_by_id

Get a single Zuora order by id (orderNumber). Returns: processId, reasons, requestId, success, order. Required: id.

zuora_orders_activate

Activate a draft order in Zuora. Returns the activation result including orderNumber, accountNumber, status, invoiceNumbers, orderLineItems, and subscriptions. Required: order_id. Only draft orders can be activated.

zuora_orders_cancel

Cancel an order in Zuora. Returns: processId, reasons, requestId, success, accountNumber, cancelReason, orderNumber, status. Required: order_id.

create_a_zuora_async_order

Create an order asynchronously in Zuora when the synchronous Create an order call may time out. Returns: jobId, success. Requires an order request body. Up to 300 subscriptions and 300 order actions are allowed per call; auto-refund and invoice write-off during subscription cancellation are not supported. Required: orderDate.

zuora_async_orders_bulk_delete

Delete a Zuora order asynchronously by order number. All subscriptions changed by the order are rolled back to their previous version and all order line items created in the order are deleted. Returns: jobId, success. Required: order_number. Cannot delete an order if the affected charges are already invoiced.

get_single_zuora_async_job_by_id

Get the status and response of an asynchronous Zuora job by id. Currently supports jobs created by 'Create an order asynchronously' or 'Preview an order asynchronously'. Returns: errors, result, status, success. Required: id.

list_all_zuora_orders_subscription_owners

List all orders containing subscription changes for a specified subscription owner account in Zuora. Returns: processId, reasons, requestId, success, nextPage, orders. Draft and scheduled orders cannot be retrieved through this operation. Required: account_number.

list_all_zuora_orders_subscriptions

List Zuora orders for a specific subscription. Returns orders including orderNumber, status, orderDate, currency, subscriptions, and customFields. Required: subscription_number.

list_all_zuora_orders_invoice_owners

List Zuora orders for a specified invoice owner account. Returns each order's orderNumber, status, orderDate, currency, customFields, and subscriptions. Required: account_number.

zuora_order_custom_fields_bulk_update

Update the custom fields of a specified order in Zuora. Returns: processId, reasons, requestId, success. To update custom fields of an order line item, use the Update an order line item operation instead. Required: order_number.

zuora_subscription_custom_fields_bulk_update

Update the custom fields of a specified Zuora subscription. Returns: processId, reasons, requestId, success. Required: subscription_number. This operation requires the Orders feature to be enabled.

zuora_order_trigger_dates_bulk_update

Update the triggering dates for order actions (CreateSubscription, AddProduct, UpdateProduct, RemoveProduct, RenewSubscription, TermsAndConditions) on a pending Zuora order. Returns: processId, reasons, requestId, success, accountNumber, orderNumber, status, subscriptions. Required: order_number. Only available when the Orders feature is enabled.

get_single_zuora_pending_by_id

List all pending orders for a specified subscription in Zuora. Returns: nextPage, orders, success. Requires the Order Metrics feature. Required: id.

update_a_zuora_order_action_by_id

Update the change reason and custom fields for an order action in Zuora. Returns: processId, reasons, requestId, success. Required: id.

get_single_zuora_order_line_item_by_id

Get a single Zuora order line item by id. Returns the orderLineItem object containing id, itemName, itemState, itemType, amount, quantity, productCode, and billing details, plus a success flag. Required: id.

update_a_zuora_order_line_item_by_id

Update a specified order line item in Zuora. Returns: processId, reasons, requestId, success. The Order Line Items feature must be enabled. Required: id.

zuora_order_line_items_bulk_create

Bulk update multiple order line items in Zuora, with an option to generate an invoice for the updated items. Returns: processId, reasons, requestId, success, orderLineItem. Max 100 order line items per call.

create_a_zuora_fulfillment

Create one or multiple Zuora fulfillments with optional invoice or memo generation in the same call. Returns: processId, reasons, requestId, success, creditMemoNumbers, fulfillments, invoiceNumbers, paidAmount, paymentNumber.

get_single_zuora_fulfillment_by_id

Get a single Zuora fulfillment by id or fulfillment number. Returns the fulfillment object including id, fulfillmentNumber, state, fulfillmentType, quantity, carrier, trackingNumber, fulfillmentDate, billTargetDate, orderLineItemId, fulfillmentItems, and customFields. Required: id.

update_a_zuora_fulfillment_by_id

Update a Zuora fulfillment by id. The state field triggers state transitions; other fields can only be updated in the Executing state or Booked state with appropriate permissions. Returns: processId, reasons, requestId, success. Required: id.

delete_a_zuora_fulfillment_by_id

Delete a Zuora fulfillment by id. A fulfillment can only be deleted when it is in the Executing state. Returns: processId, reasons, requestId, success. Required: id.

create_a_zuora_fulfillment_item

Create one or multiple fulfillment items in Zuora. Returns: processId, reasons, requestId, success, fulfillmentItems.

get_single_zuora_fulfillment_item_by_id

Get a single fulfillment item in Zuora by id. Returns the fulfillmentItem object including id, fulfillmentId, itemIdentifier, description, and customFields, plus a success flag. Required: id.

update_a_zuora_fulfillment_item_by_id

Update a specified fulfillment item in Zuora by id. Returns: processId, reasons, requestId, success. Required: id.

delete_a_zuora_fulfillment_item_by_id

Delete a specified fulfillment item in Zuora by id. Returns: processId, reasons, requestId, success. Required: id.

list_all_zuora_ramps

Retrieve the latest definition of a specified ramp in Zuora by ramp number. Returns the ramp object including id, name, number, description, charges, intervals, and subscriptionNumber, plus a success flag. Required: ramp_number. The Ramps feature must be enabled (requires the Orders feature).

list_all_zuora_ramp_ramp_metrics

List all ramp metrics for a specified Zuora ramp, including TCB/TCV at ramp and interval levels, and per-charge MRR, quantity, and delta metrics within each interval. Returns: rampMetrics, processId, reasons, requestId, success. Required: ramp_number.

list_all_zuora_subscription_ramps

List ramp definitions associated with a specified Zuora subscription. Returns each ramp with its id, name, number, description, subscriptionNumber, charges, and intervals. Required: subscription_key.

list_all_zuora_subscription_ramp_metrics

List ramp metrics for a Zuora subscription by subscription key, including ramp-level and interval-level TCB/TCV, per-charge quantity and MRR breakdowns. Returns: rampMetrics, processId, reasons, requestId, success. Required: subscription_key. Only available if the Ramps feature is enabled.

list_all_zuora_order_ramp_metrics

List ramp metrics for a Zuora order by order number. Returns: rampMetrics, processId, reasons, requestId, success. Required: order_number. Only available when the Ramps feature is enabled.

create_a_zuora_subscriptions_preview

Preview a subscription in Zuora without creating an account or committing charges. Returns the preview result including success, contractedMrr, totalContractedValue, amount, amountWithoutTax, taxAmount, invoiceTargetDate, documentDate, and invoiceItems with charge details. Requires a request body describing the subscription to preview. Required: contractEffectiveDate, subscribeToRatePlans, termType.

zuora_subscriptions_preview

Preview an existing Zuora subscription by subscription key to view information about existing and future invoices or credit memos. Returns: processId, reasons, requestId, success, invoices, creditMemos. Required: subscription_id.

create_a_zuora_subscription

Create a new subscription for an existing customer account in Zuora. Returns: contractedMrr, creditMemoId, invoiceId, paidAmount, paymentId, subscriptionId, subscriptionNumber, success, totalContractedValue. Does not support creating pending subscriptions. Required: accountKey, contractEffectiveDate, renewalTerm, subscribeToRatePlans, termType.

get_single_zuora_subscription_by_id

Get detailed information about a specific Zuora subscription by subscription key. Returns: accountId, accountName, accountNumber, autoRenew, billToContact, cancelReason, contractEffectiveDate, contractedMrr, contractedNetMrr, asOfDayGrossMrr, asOfDayNetMrr, netTotalContractedValue, currency, currentTerm, and 62 more. Required: id.

update_a_zuora_subscription_by_id

Update a Zuora subscription by id to add notes, change terms and conditions, or add/remove/modify rate plans. Returns: invoice, invoiceId, subscriptionId, success, totalDeltaMrr, and 9 more. Required: id. Creates a new subscription version atomically; up to 9 combined rate plan changes and at most 1 terms & conditions change per request.

zuora_subscriptions_cancel

Cancel an active subscription in Zuora. Returns: cancelledDate, creditMemoId, invoiceId, paidAmount, paymentId, subscriptionId, success, totalDeltaMrr, totalDeltaTcv. The subscription must be in Active status. Required: subscription_id, cancellationPolicy.

zuora_subscriptions_resume

Resume a suspended Zuora subscription by subscription id. Returns: creditMemoId, invoiceId, paidAmount, paymentId, resumeDate, subscriptionId, success, termEndDate, totalDeltaTcv. The subscription must be in Suspended status. Required: subscription_id, resumePolicy.

get_single_zuora_subscriptions_account_by_id

Retrieve all Zuora subscriptions associated with a specific account by account key. Returns: nextPage, subscriptions, success. Only latest subscription versions are returned, ordered by updatedDate. Required: id.

list_all_zuora_subscription_versions

Retrieve a Zuora subscription by subscription key and version, including all rate plans and their charges. Returns: accountId, accountName, accountNumber, autoRenew, billToContact, cancelReason, contractEffectiveDate, contractedMrr, contractedNetMrr, asOfDayGrossMrr, asOfDayNetMrr, and 62 more. Required: subscription_key, version.

zuora_subscription_renews_bulk_update

Renew a termed Zuora subscription using existing renewal terms, extending the current term by creating a new term. Returns: creditMemoId, invoiceId, paidAmount, paymentId, success, termEndDate, termStartDate, totalDeltaMrr, totalDeltaTcv, subscriptionId. Required: subscription_key.

zuora_subscription_suspends_bulk_update

Suspend an active subscription in Zuora by subscription key. Returns: creditMemoId, invoiceId, paidAmount, paymentId, resumeDate, subscriptionId, success, suspendDate, termEndDate, totalDeltaTcv. The subscription status must be Active. Required: subscription_key, suspendPolicy.

zuora_subscription_deletes_bulk_update

Delete a Zuora subscription by its subscription number. Returns: success. Required: subscription_key.

zuora_version_custom_fields_bulk_update

Update the custom fields of a specified subscription version in Zuora. Returns: processId, reasons, requestId, success. Required: subscription_number, version.

list_all_zuora_subscriptions_subscription_metrics

List Zuora subscription metrics for subscriptions specified by subscription numbers. Returns: processId, reasons, requestId, success, subscriptionMetrics. Required: subscriptionNumbers[].

get_single_zuora_rateplan_by_id

Retrieve a Zuora subscription rate plan by id, including related amendment and order information when the Orders or Subscribe-and-Amend feature is enabled. Returns: processId, reasons, requestId, success, amendment, externallyManagedPlanId, id, lastChangeType, order, productId, productName, productRatePlanId, productSku, and 3 more. Required: id.

create_a_zuora_omni_channel_subscription

Create or update an omnichannel subscription for a customer account in Zuora. A new customer account can also be created and assigned to the subscription in the same call. Returns: processId, reasons, requestId, success, subscriptionId, subscriptionNumber, accountId, accountNumber. A JSON request body is required. Required: externalSubscriptionId.

get_single_zuora_omni_channel_subscription_by_id

Get a specific Zuora omnichannel subscription by id. Returns the subscription object including id, subscriptionNumber, accountId, state, currency, externalSourceSystem, externalProductId, autoRenew, and external purchase/renewal dates. Required: id.

delete_a_zuora_omni_channel_subscription_by_id

Delete a specified omnichannel subscription in Zuora by id. Returns: processId, reasons, requestId, success. Required: id.

create_a_zuora_ppdd_reverse_rollover

Reverse a fund rollover from a source validity period back to its destination validity period in Zuora. Returns: message, reverseRolloverFundCount, success. Requires a JSON request body specifying the rollover to reverse. This API will not work if the associated prepayment charge has rollover enabled. Required: destinationValidityPeriod, prepaymentUom, sourceValidityPeriod, subscriptionNumber.

create_a_zuora_ppdd_rollover

Manually trigger fund rollover for a Prepaid with Drawdown balance from a source validity period to a destination validity period in Zuora. Returns: message, rolloverFundCount, success. This API will not work if rollover is enabled in the associated prepayment charge. Required: destinationValidityPeriod, prepaymentUom, priority, sourceValidityPeriod, subscriptionNumber.

create_a_zuora_prepaid_balance_funds_deplete

Deplete prepaid balance funds in Zuora by expiring the remaining balance to zero so it can be recognized by revenue. Returns: processId, reasons, requestId, success, fundIds.

create_a_zuora_usage

Upload a usage file to import usage data for one or more accounts in Zuora. Returns: checkImportStatus, size, success. Required: file. File must be CSV with .csv extension, filename ≤ 50 characters, size ≤ 4MB; dynamic pricing usage charges are rejected.

get_single_zuora_invoice_item_usage_rate_detail_by_id

Get usage rate detail for a Zuora invoice item to understand how the total amount is calculated. Returns the data object with amountWithoutTax, chargeNumber, quantity, rateDetail, servicePeriod, uom, and more, plus a success flag. Required: id. Does not support Overage/Tiered-with-Overage/Multi-attribute Pricing charge models or Cancelled/Reversed invoice statuses.

create_a_zuora_object_usage

Create a usage record in Zuora by submitting usage data for a subscription charge. Returns: Id, Success. Requires a request body with usage record details including account, charge, quantity, and billing period information. Required: Quantity, StartDateTime, UOM.

get_single_zuora_object_usage_by_id

Retrieve a single Zuora usage record by id. Returns: AccountId, AccountNumber, ChargeId, CreatedById, CreatedDate, Description, EndDateTime, Id, ProductRatePlanChargeNumber, Quantity, RbeStatus, SourceType, StartDateTime, SubscriptionId, SubscriptionNumber, UOM, UpdatedById, UpdatedDate, ChargeNumber, SubmissionDateTime. Required: id.

update_a_zuora_object_usage_by_id

Update a usage record in Zuora by id. Returns: Id, Success. Required: id. Updating usage records associated with dynamic pricing usage charges is not supported through this endpoint; use Mediation-based flows instead.

delete_a_zuora_object_usage_by_id

Delete a Zuora usage record by id. Returns: id, success. Required: id. Usage records associated with a dynamic pricing usage charge cannot be deleted via this legacy Billing endpoint.

create_a_zuora_meters_run

Run a specific version of a meter in Zuora Mediation, optionally configuring a local file or event store source. Returns: success, data, previousPage, nextPage, error. Required: meter_id, version. For long-running meters that may time out, provide a uniqueKey in the request body to safely retry without creating duplicate runs.

create_a_zuora_meters_stop

Stop a specific version of a meter in Zuora Mediation. By default a graceful stop creates a savepoint and is asynchronous for streaming meters; force stop cancels immediately without a savepoint and may lose in-flight data. Returns: success, error. Required: meter_id, version. Force stop is not supported when a run is already in the STOPPING state.

create_a_zuora_meters_debug

Test a specific version of a meter in Zuora Mediation without executing a full run. Supports uploaded files, sample files, and manual test data for validating meter logic and transformations. Returns: id, sessionId, jobId, meterId, version, revision, runType, runTypeDescription, startTime, endTime, and 4 more. Required: meter_id, version.

create_a_zuora_meter_summary

Retrieve rolled-up summary data for a Zuora meter, grouped by Operator ID, Error Code, or Session ID with optional time, session, and operator filters. Returns: success, data, previousPage, nextPage, error. Required: meter_id.

list_all_zuora_run_status

Retrieve the current run status of a specific meter version in Zuora Mediation. Returns: success, data. Required: meter_id, version.

list_all_zuora_audit_trail_entries

List audit trail entries for a specific Zuora meter with record-level processing details including payload, error information, operator metadata, and trace IDs. Returns: errorTime, timestamp, errorCode, errorMessage, payload, eventId, traceId, operatorType, and 2 more. Required: meter_id, exportType, runType, queryFromTime, queryToTime.

get_single_zuora_audit_trail_export_by_id

List audit trail export jobs for a Zuora meter, optionally filtered by export type, session IDs, or request ID. Returns: success, data, previousPage, nextPage, error. Required: id.

create_a_zuora_audit_trail_export

Create a background audit trail export job for a Zuora meter. Returns: success, data, previousPage, nextPage, error. Required: meter_id, exportType, runType, queryFromTime, queryToTime. Only one export job is processed per tenant at a time, with a record limit of up to 5 million rows per report.

list_all_zuora_audit_trail_presigned_urls

Get a presigned URL to download a specific Zuora audit trail export file. The fileKey corresponds to one entry from the fileList array returned by the List API. Returns: success, data, previousPage, nextPage, error. Required: fileKey.

get_single_zuora_meters_export_by_id

Export the full definition of a specific Zuora Mediation meter, including metadata, all versions, event schemas, and operator configurations (source, processor, sink). Useful for reviewing, backing up, or replicating meter setups across environments. Returns: name, description, type, typeDefinition, latestVersion, versions, schemas. Required: id.

create_a_zuora_meters_import

Import a meter definition into Zuora Mediation by uploading a file exported from the Export Meter API. Returns: success, data. Required: file.

create_a_zuora_meters_file

Upload a file to Zuora Mediation for use in meter processing. Supported formats include CSV, Excel, and JSON, with optional metadata for headers, delimiters, sheets, and data ranges. Returns: id, name, resourceId, format, hasHeader, firstRow, delimiter, sheet, dataRange, lines, createdAt, updatedAt. Required: file.

create_a_zuora_usage_bulk

Ingest usage events directly into a Zuora Mediation meter via the Streaming API in real time. Send a single event or batch multiple events as a JSON array; each event must conform to the meter's event schema. Returns: success, message. Only supported for meters configured with Streaming API as their source. Required: bulk_id, CustomerId, UsageIdentifier, UsageDate, Quantity.

create_a_zuora_events_bulk_delete

Bulk delete events from a Zuora Mediation event store by uploading a file that lists the event IDs to remove. Returns: success, data. The request must be submitted as multipart/form-data. Required: file, storeId.

get_single_zuora_jobs_latest_by_id

Get the latest query job executed on a specific Zuora Mediation event store by id. Returns: success, data, id, objectId, objectType, operationType, status. Required: id.

create_a_zuora_store_truncate

Truncate (delete) all events from a specific event store in Zuora. This operation runs asynchronously and returns a query job identifier that can be used with the Event Store query job APIs to monitor truncation status. Returns: success, data, previousPage, nextPage. Required: event_store_id.

create_a_zuora_meters_event_store_query

Submit a SQL-style asynchronous query to the Zuora Event Store to retrieve and inspect metering events for validation, troubleshooting, and reconciliation. Returns: success, data, previousPage, nextPage, error. Required: query. Query execution is asynchronous; use the returned queryId with the get method to poll for paginated results.

get_single_zuora_meters_event_store_query_by_id

Retrieve paginated result rows and column metadata for a previously submitted Zuora Event Store query by id. Returns: success, data. Required: id. Query execution is asynchronous; the ready field indicates whether results are available.

get_single_zuora_meter_prefetch_audit_by_id

List prefetch audit records for a Zuora meter by processor ID, with date range and status filtering. Returns: jobId, operatorId, definitionId, duration, completedTime, startTime, dataFreshness, status, triggerType, error. startDate defaults to 7 days before today (UTC); endDate defaults to today (UTC). Required: id, operatorId.

list_all_zuora_commitments

List Zuora commitments for a customer account, optionally filtered by type. Returns commitments with id, commitmentNumber, name, type, status, currency, totalAmount, startDate, and endDate. Required: accountNumber. Max 100 per page.

get_single_zuora_commitment_by_id

Retrieve a single Zuora commitment by its ID or commitment number. Returns: id, status, version, startDate, endDate, totalAmount, currency, orderNumber, orderId, accountId, accountNumber, commitmentNumber, name, type, prepaymentType, description, priority, customFields, aceId, cancellationPolicy, amount, and 25 more. Required: id.

list_all_zuora_commitments_periods

List periods for a Zuora commitment. Returns each period's id, commitmentId, commitmentNumber, currency, type, startDate, endDate, amount, balance, and status. Date filters must be up to 5 years apart.

get_single_zuora_commitment_balancepreview_by_id

Preview the balance for a Zuora commitment for current and past periods. Returns: total, page, pageSize, periods. Required: id. Future periods are not covered; rejected for tenants configured to skip commitment evaluation.

list_all_zuora_commitment_schedules

List all schedules for a specific Zuora commitment. Returns each schedule with id, commitmentId, commitmentNumber, version, startDate, endDate, totalAmount, amount, amountBase, periodType, specificPeriodLength, status, and prepaymentDefinition details. Required: commitment_key.

zuora_prepayment_expires_bulk_update

Expire a commitment-linked prepayment in Zuora. After expiration the prepayment no longer participates in future drawdown. Returns: processId, reasons, requestId, success, id, prepaymentDefinitionId, commitmentId, commitmentNumber, commitmentScheduleId, commitmentPeriodId, amount, billedAmount, spendAmount, and 3 more. Required: prepayment_id.

list_all_zuora_commitment_commitment_changes

List the change history for a Zuora commitment, ordered by most recent first. Returns each change record with commitmentNumber, orderNumber, version, changeDate, changes (field-level old/new values), scheduleChanges with nested periodChanges, and associatedItemChanges/associatedAccountChanges. Required: commitment_key.

list_all_zuora_adjustments

List all delivery adjustments for a Zuora subscription by subscription number. Returns: processId, reasons, requestId, success, adjustments. Required: subscription-number.

create_a_zuora_adjustment

Create one or more delivery adjustments for a subscription in Zuora. Returns: processId, reasons, requestId, and 5 more. Supports partial success — when at least one eligible adjustment exists, success is true and both eligible and ineligible adjustments are returned; success is false only when no adjustment is eligible. The…. Required: endDate, startDate.

get_single_zuora_adjustment_by_id

Get a single delivery adjustment in Zuora by its adjustment ID or number. Returns: adjustmentId, adjustmentNumber, amount, billingDate, chargeNumber, creditMemoNumber, debitMemoNumber, deferredRevenueAccountingCode, deliveryDate, deliveryDay, reason, recognizedRevenueAccountingCode, revenueRecognitionRuleName, status, and 1 more. Required: id.

zuora_adjustments_cancel

Cancel an unbilled delivery adjustment in Zuora. Returns: processId, reasons, requestId, success, debitMemoNumber. Required: adjustment_id. The Delivery Adjustments feature is in the Early Adopter phase.

create_a_zuora_adjustments_preview

Preview delivery adjustments for a Zuora subscription before committing them. Returns: processId, reasons, requestId, and 5 more. A JSON request body describing the adjustment to preview is required. Supports partial success — success is true when at least one eligible adjustment exists, with ineligible adjustments returned…. Required: endDate, startDate.

list_all_zuora_billing_documents

List billing documents (invoices, credit memos, and debit memos) for a specified Zuora customer account. Returns: documents, nextPage, success. Credit and debit memos require the Invoice Settlement feature.

create_a_zuora_files_deletion_job

Create a job to hard delete billing document files. Returns: id, status, success.

get_single_zuora_files_deletion_job_by_id

Get a Zuora billing document file deletion job by id. Retrieves the status of an asynchronous job that permanently deletes billing document PDF files for specific accounts. Returns: id, status, success. Required: id.

create_a_zuora_billing_documents_generate

Generate draft or posted billing documents (invoices and credit memos) for a Zuora account by account key. Returns: creditMemos, invoices, success. Cannot generate billing documents for cancelled or suspended subscriptions; credit memos require the Invoice Settlement feature. Required: key, effectiveDate, targetDate.

create_a_zuora_invoice

Create a standalone invoice in Zuora for selling physical goods, services, or other items on a non-recurring basis to subscription customers. Returns the created invoice including id, invoiceNumber, accountId, amount, currency, status, balance, invoiceDate, dueDate, and tax fields. Required: invoiceDate.

zuora_invoices_bulk_update

Update multiple Zuora invoices in batches with a single call. Returns: processId, reasons, requestId, success. Maximum 50 invoices per call.

get_single_zuora_invoice_by_id

Retrieve a specific Zuora invoice by id or invoice number. Returns: accountId, adjustmentAmount, amount, amountWithoutTax, autoPay, balance, billRunId, billToContactId, billToContactSnapshotId, comments, createdById, createdDate, creditBalanceAdjustmentAmount, creditMemoAmount, currency, discount, dueDate, and 43 more. Required: id.

update_a_zuora_invoice_by_id

Update a specific Zuora invoice by id or invoice number. Returns: accountId, amount, autoPay, balance, cancelledById, cancelledOn, comment, createdById, createdDate, creditBalanceAdjustmentAmount, currency, discount, dueDate, id, invoiceDate, number, postedById, postedOn, status, success, targetDate, taxAmount, templateId, and 7 more. Required: id.

delete_a_zuora_invoice_by_id

Delete a specific Zuora invoice by id or invoice number. Returns: id, jobId, jobStatus, reasons, success. Deletion is synchronous for invoices with fewer than 100 items and asynchronous otherwise. Required: id.

zuora_invoices_cancel

Cancel a Zuora invoice synchronously or asynchronously based on its item count. Returns: id, jobId, jobStatus, success. Required: invoice_id. Invoices with 1,000+ items are cancelled asynchronously; check jobStatus for Pending vs Completed.

create_a_zuora_invoices_batch

Create standalone invoices. Returns: invoices, success.

create_a_zuora_invoices_bulk_post

Post invoices. Returns: invoices, success.

list_all_zuora_invoices_pdf_status

Retrieve the PDF generation statuses of a batch of invoices in Zuora. Returns the invoiceFiles array with each invoice's invoiceId, invoiceNumber, pdfGenerationStatus, createdOn, updatedOn, pdfFileUrl, errorCode, and errorMessage, plus a success flag. Required: invoiceKeys. A maximum of 50 invoice keys can be specified per request.

list_all_zuora_invoice_application_parts

List all application parts of an invoice in Zuora, retrieving information about the payments or credit memos applied to a specified invoice. Returns: applicationParts, nextPage, success. Required: invoice_key. Only available if Invoice Settlement is enabled.

create_a_zuora_invoice_email

Send a posted Zuora invoice to specified email addresses manually. If useEmailTemplateSetting is false and emailAddresses is omitted, the invoice is sent to the Bill To contact's work or personal email. Returns: processId, reasons, requestId, success. Required: invoice_key.

list_all_zuora_invoice_files

List all PDF files of a Zuora invoice by invoice key. Files are returned in reverse chronological order by versionNumber. Only PDFs that have already been generated are included; a file currently being generated will not appear. Returns: invoiceFiles, nextPage, success. Required: invoice_key.

create_a_zuora_invoice_file

Upload an externally generated PDF file for a Zuora invoice in Draft or Posted status. Returns: fileId, success. Only PDF format supported; max file size 4 MB; max 50 PDF files per invoice; duplicate filenames are not allowed. Required: invoice_key.

list_all_zuora_invoice_items

List all line items for a specified invoice in Zuora. Returns each item's id, chargeName, chargeType, chargeAmount, balance, quantity, productName, subscriptionId, serviceStartDate, serviceEndDate, and taxAmount. Required: invoice_key.

list_all_zuora_item_taxation_items

List all taxation items of a specific invoice item in Zuora. Returns: availableToCreditAmount, applicableTaxUnRounded, country, balance, creditAmount, exemptAmount, id, jurisdiction, locationCode, name, paymentAmount, taxAmount, taxCode, taxCodeDescription, taxDate, taxRate, taxRateDescription, taxRateType. Required: invoice_key, item_id.

zuora_invoice_reverses_bulk_update

Reverse a posted Zuora invoice by invoice key. Returns: creditMemo, creditMemos, debitMemo, id, jobId, jobStatus, success. Required: invoice_key. Only available with Invoice Settlement enabled; the invoice must be in Posted status with no applied payments or credit memos, and cannot exceed 50,000 items.

zuora_invoice_splits_bulk_update

Split a draft Zuora invoice into 2 to 20 invoices by specified amounts or percentages. Returns: success, id, jobId, and 2 more. Required: invoice_key. The source invoice must be in Draft status; split amounts must total the original invoice total and percentages must total exactly 100. The operation may process asynchronously — when jobStatus is Pending, poll the job status to confirm…

create_a_zuora_invoice_taxation_item

Create taxation items for a Zuora invoice identified by invoice key. Returns: success, taxationItems. Required: invoice_key.

create_a_zuora_invoice_write_off_async

Write off a posted Zuora invoice asynchronously, creating and applying a credit memo to it. Returns: processId, reasons, requestId, success, id, status, operationType, referenceId, and 3 more. Required: invoice_key. Only available with Invoice Settlement enabled; track the async job status via the Retrieve invoice write-off async job operation.

get_single_zuora_invoices_write_off_async_job_by_id

Retrieve a specific invoice write-off async job in Zuora. Returns: processId, reasons, requestId, success, id, status, operationType, referenceId, referenceType, error, creditMemo. Required: id. Only available when Invoice Settlement is enabled.

zuora_invoice_write_offs_bulk_update

Write off a posted Zuora invoice, creating and applying a credit memo to zero out the invoice balance. Returns: creditMemo, success. Required: invoice_key. Only available with Invoice Settlement enabled; invoices containing more than 2,000 items must use the async write-off endpoint instead.

zuora_invoice_unposts_bulk_update

Unpost a posted Zuora invoice and change its status to Draft. Returns: invoice, jobId, jobStatus, and 1 more. For invoices with many items the operation may run asynchronously — poll jobStatus via the operation-job endpoint until Completed. Required: invoice_key. The invoice must be in Posted status with no applied payments, adjustments, or non-cancelled memos.

list_all_zuora_credit_memos

List credit memos in Zuora with optional filtering on account, status, amount, date, and other fields. Returns: creditmemos, nextPage, success, id, number, accountId, accountNumber, amount, appliedAmount, autoApplyUponPosting, billToContactId, billToContactSnapshotId, cancelledById, cancelledOn, comment, createdById, createdDate, and 29 more

create_a_zuora_credit_memo

Create an ad-hoc credit memo from a product rate plan charge in Zuora. Returns the created credit memo object including id, number, accountId, currency, status, amount, creditMemoDate, unappliedAmount, and reasonCode. Requires Invoice Settlement enabled; discount charge models are not supported, and the amount is validated…

zuora_credit_memos_bulk_create

Create credit memos. Returns: memos, success. Required: sourceType.

zuora_credit_memos_bulk_update

Bulk update basic and finance information for up to 50 credit memos in Zuora. Returns: memos, success. Requires the credit memo update request body. Each memo is updated in a separate transaction so partial failures are possible; Invoice Settlement must be enabled.

get_single_zuora_credit_memo_by_id

Get a Zuora credit memo by its unique ID or number. Returns the full credit memo object including id, number, accountId, amount, status, currency, creditMemoDate, appliedAmount, unappliedAmount, and taxAmount. Required: id. Invoice Settlement must be enabled.

update_a_zuora_credit_memo_by_id

Update a credit memo's basic and finance information in Zuora. Returns the full credit memo object including id, number, accountId, currency, status, amount, taxAmount, unappliedAmount, and success. Required: id. Only available with Invoice Settlement enabled; tax-inclusive memo items cannot be updated.

delete_a_zuora_credit_memo_by_id

Delete a credit memo in Zuora. Only credit memos with the Cancelled status can be deleted; Invoice Settlement must be enabled. Returns: processId, reasons, requestId, success. Required: id.

zuora_credit_memos_cancel

Cancel a credit memo in Zuora. Only credit memos in Draft status can be cancelled; the Invoice Settlement feature must be enabled. Returns the full credit memo object including id, number, status, amount, accountId, and currency. Required: credit_memo_id.

list_all_zuora_credit_memos_pdf_status

Retrieve the PDF file generation status of a batch of credit memos in Zuora. Returns creditMemoFiles with each item containing creditMemoId, creditMemoNumber, pdfGenerationStatus, createdOn, updatedOn, and conditionally pdfFileUrl, errorCode, and errorMessage, plus a success flag. Required: creditMemoKeys. Maximum of 50 keys per request.

zuora_credit_memo_write_offs_bulk_update

Write off a credit memo. Returns: debitMemo, success. Required: credit_memo_id.

zuora_credit_memo_applies_bulk_update

Apply a posted Zuora credit memo to one or more invoices and debit memos. Returns the updated credit memo object including id, number, accountId, status, amount, appliedAmount, unappliedAmount, and success. Required: credit_memo_key. Requires Invoice Settlement enabled; total credit memo items plus target items must not exceed 15,000.

create_a_zuora_credit_memo_email

Send a posted Zuora credit memo to specified email addresses manually. Returns: processId, reasons, requestId, success. Required: credit_memo_key. Available only if Invoice Settlement is enabled; the 'Email Credit Memo | Manually email Credit Memo' notification must be activated beforehand.

list_all_zuora_credit_memo_files

List all PDF files of a credit memo in Zuora. Files are returned in reverse chronological order by versionNumber; only files that have already been generated are included. Returns: creditMemoFiles, nextPage, success. Required: credit_memo_key.

create_a_zuora_credit_memo_file

Upload an externally generated PDF file for a credit memo in Zuora. The credit memo must be in Draft or Posted status. Returns: fileId, success. Only PDF format is supported; maximum file size is 4 MB; a maximum of 50 PDF files can be uploaded per credit memo. Required: credit_memo_key.

list_all_zuora_credit_memo_items

List all line items of a credit memo in Zuora. Returns: items, nextPage, success, id, amount, amountWithoutTax, appliedAmount, appliedToItemId, comment, commitmentId, commitmentPeriodId, createdById, createdDate, creditFromItemId, creditFromItemSource, excludeItemBillingFromRevenueAccounting, and 23 more. Required: credit_memo_key.

get_single_zuora_credit_memo_item_by_id

Get a single credit memo item by id in Zuora. Returns: amount, amountWithoutTax, appliedAmount, appliedToItemId, commitmentId, commitmentPeriodId, createdById, createdDate, creditFromItemId, creditFromItemSource, description, excludeItemBillingFromRevenueAccounting, financeInformation, id, and 28 more. Required: id, credit_memo_key.

list_all_zuora_credit_memo_parts

List all parts of a Zuora credit memo, including both applied and unapplied portions. Returns: nextPage, parts, success. Required: credit_memo_key. This operation requires the Invoice Settlement feature to be enabled.

get_single_zuora_credit_memo_part_by_id

Get a single Zuora credit memo part by id. Returns: amount, createdById, createdDate, debitMemoId, id, invoiceId, organizationLabel, success, updatedById, updatedDate. Required: credit_memo_key, id. This operation requires the Invoice Settlement feature to be enabled.

create_a_zuora_credit_memo_pdf

Generate a PDF file for a specified credit memo in Zuora. The generated PDF can be downloaded from the Zuora UI. Returns: success. Required: credit_memo_key. Available only if Invoice Settlement is enabled.

zuora_credit_memo_posts_bulk_update

Post a credit memo in Zuora to activate it. Returns the full credit memo object including id, number, status, amount, accountId, currency, creditMemoDate, postedOn, and unappliedAmount. Required: credit_memo_key. Invoice Settlement must be enabled.

create_a_zuora_credit_memo_refund

Refund a full or partial posted credit memo in Zuora. Returns: accountId, amount, cancelledOn, comment, createdById, createdDate, creditMemoId, financeInformation, gatewayId, gatewayResponse, gatewayResponseCode, gatewayState, id, markedForSubmissionOn, methodType, number, and 28 more. Required: credit_memo_key, totalAmount, type.

zuora_credit_memo_reverses_bulk_update

Reverse a credit memo. Returns: creditMemo, debitMemo, success. Required: credit_memo_key.

create_a_zuora_credit_memo_taxation_item

Create taxation items for a credit memo in Zuora. Returns the created taxation items including id, memoItemId, taxAmount, taxRate, taxRateType, taxCode, taxDate, jurisdiction, and financeInformation. Required: credit_memo_key. Only available when Invoice Settlement is enabled.

zuora_credit_memo_unapplies_bulk_update

Unapply a credit memo from one or more invoices and debit memos in Zuora, transferring the full applied amount back into the credit memo's unapplied amount. Returns: accountId, accountNumber, amount, appliedAmount, autoApplyUponPosting, billToContactId, billToContactSnapshotId, cancelledById, cancelledOn, and 48 more. Required: credit_memo_key.

zuora_credit_memo_unposts_bulk_update

Unpost a credit memo in Zuora, changing its status from Posted to Draft. Returns the full credit memo object including id, number, status, amount, currency, appliedAmount, and unappliedAmount. Required: credit_memo_key. Only available with Invoice Settlement enabled; the credit memo must be in Posted status and cannot have been applied or refunded.

create_a_zuora_credit_memos_invoice

Create a credit memo from an invoice. Returns: accountId, accountNumber, amount, appliedAmount, autoApplyUponPosting, billToContactId, billToContactSnapshotId, cancelledById, cancelledOn, comment, createdById, createdDate, creditMemoDate, currency, einvoiceErrorCode, einvoiceErrorMessage, and 41 more. Required: invoice_id, invoiceId.

get_single_zuora_credit_memos_unapply_async_job_by_id

Retrieve an async unapply credit memo job by id in Zuora. Returns: processId, reasons, requestId, success, id, status, operationType, referenceId, referenceType, error. Required: id. Only available when the Invoice Settlement feature is enabled.

get_single_zuora_credit_memos_apply_async_job_by_id

Retrieve a specific async credit memo apply job in Zuora by its job id. Returns: processId, reasons, requestId, success, id, status, operationType, referenceId, referenceType, error. Required: id. Only available if Invoice Settlement is enabled.

zuora_credit_memo_apply_asyncs_bulk_update

Asynchronously apply a posted Zuora credit memo to one or more invoices. Returns: processId, reasons, requestId, success, id, status, operationType, referenceId, referenceType, error. Required: credit_memo_key. Invoice Settlement must be enabled; max 1,000 invoices per request and total credit memo items must be ≤ 300,000.

zuora_credit_memo_unapply_asyncs_bulk_update

Asynchronously unapply a Zuora credit memo from one or more invoices, transferring the full applied amount back into the credit memo's unapplied amount. Returns: processId, reasons, requestId, success, and 6 more. Required: credit_memo_key. Max 1,000 invoices per request; total credit memo items must not exceed 300,000; requires Invoice Settlement…

list_all_zuora_debit_memos

List all debit memos associated with all customer accounts in Zuora. Returns: debitmemos, nextPage, success, id, number, accountId, accountNumber, amount, autoPay, balance, beAppliedAmount, billToContactId, billToContactSnapshotId, cancelledById, cancelledOn, comment, createdById, createdDate, currency, debitMemoDate, dueDate, and 23 more

create_a_zuora_debit_memo

Create an ad-hoc debit memo from a product rate plan charge in Zuora. Returns: accountId, accountNumber, amount, autoPay, balance, beAppliedAmount, billToContactId, billToContactSnapshotId, cancelledById, cancelledOn, currency, comment, createdById, createdDate, debitMemoDate, dueDate, einvoiceErrorCode, einvoiceErrorMessage, and 32 more

zuora_debit_memos_bulk_create

Bulk create up to 50 debit memos in Zuora from invoices (sourceType Invoice) or product rate plan charges (sourceType Standalone). Returns a memos array where each item includes id, accountId, amount, balance, status, number, currency, and sourceType, plus a top-level success flag. Requires the Invoice Settlement feature enabled. Each memo is created in a separate database transaction, so partial…. Required: sourceType.

zuora_debit_memos_bulk_update

Bulk update basic and finance information for multiple debit memos in Zuora. Returns a memos array with each memo's id, status, amount, balance, currency, and per-item success flag, plus a top-level success boolean. Maximum 50 debit memos per request; each memo updated in a separate transaction so partial failures do not block other updates.

get_single_zuora_debit_memo_by_id

Get a specific debit memo in Zuora by id. Returns: accountId, accountNumber, amount, autoPay, balance, beAppliedAmount, billToContactId, billToContactSnapshotId, cancelledById, cancelledOn, currency, comment, createdById, createdDate, debitMemoDate, dueDate, einvoiceErrorCode, einvoiceErrorMessage, einvoiceFileId, and 31 more. Required: id.

delete_a_zuora_debit_memo_by_id

Delete a debit memo in Zuora by id. Only debit memos with Cancelled status can be deleted. Returns: processId, reasons, requestId, success. Required: id.

zuora_debit_memos_cancel

Cancel a debit memo in Zuora. Only debit memos with Draft status can be cancelled. Returns the debit memo object including id, number, status, amount, balance, and accountId. Required: debit_memo_id.

list_all_zuora_debit_memos_pdf_status

Retrieve the PDF generation status of a batch of debit memos in Zuora. Returns: debitMemoFiles, success. Required: debitMemoKeys. A maximum of 50 debit memo keys can be provided per request.

list_all_zuora_debit_memo_application_parts

List all application parts of a debit memo in Zuora, retrieving the payments or credit memos applied to it. Returns: applicationParts, nextPage, success. Required: debit_memo_id. Available only with Invoice Settlement enabled; on Zuora version 341.0+ only processed payments are returned.

create_a_zuora_debit_memo_collect

Collect a posted debit memo in Zuora by applying unapplied credit memos and payments, then processing any remaining open balance. Returns: appliedCreditMemos, appliedPayments, debitMemo, and 3 more. Required: debit_memo_key. Requires Invoice Settlement enabled; requests are rejected if the debit memo has more than 10 items, or if applicationOrder uses CreditMemo…

create_a_zuora_debit_memo_email

Email a debit memo. Returns: processId, reasons, requestId, success. Required: debit_memo_key.

list_all_zuora_debit_memo_files

List all PDF files of a specified debit memo in Zuora. Files are returned in reverse chronological order by versionNumber; only already-generated PDFs are included. Returns: debitMemoFiles, nextPage, success. Required: debit_memo_key.

create_a_zuora_debit_memo_file

Upload an externally generated PDF file for a debit memo in Zuora. The debit memo must be in Draft or Posted status. Returns: fileId, success. Only PDF format is supported; maximum file size is 4 MB and a maximum of 50 PDF files can be uploaded per debit memo. Required: debit_memo_key.

list_all_zuora_debit_memo_items

List all line items of a specific debit memo in Zuora. Returns: items, nextPage, success. Required: debit_memo_key.

get_single_zuora_debit_memo_item_by_id

Get a single debit memo item by its ID in Zuora. Returns: amount, amountWithoutTax, appliedToItemId, balance, beAppliedAmount, createdById, createdDate, description, excludeItemBillingFromRevenueAccounting, financeInformation, id, processingType, quantity, reflectDiscountInNetAmount, serviceEndDate, and 17 more. Required: id, debit_memo_key.

create_a_zuora_debit_memo_pdf

Generate a PDF file for a specified debit memo in Zuora. The generated PDF can be accessed via the View PDF button on the debit memo detail page in the Zuora UI. Returns: success. Required: debit_memo_key. Only available if Invoice Settlement is enabled.

zuora_debit_memo_posts_bulk_update

Post (activate) a debit memo in Zuora by its debit memo key. Returns the full posted debit memo object including id, number, status, amount, balance, accountId, and currency. Required: debit_memo_key. Only available with Invoice Settlement enabled.

create_a_zuora_debit_memo_taxation_item

Create taxation items for a debit memo in Zuora. Returns the created taxation items including id, memoItemId, taxAmount, taxCode, taxRate, jurisdiction, name, and financeInformation, plus a success flag. Required: debit_memo_key. Requires the Invoice Settlement feature to be enabled.

zuora_debit_memo_unposts_bulk_update

Unpost a posted debit memo in Zuora, changing its status back to Draft. Returns the full debit memo object including id, number, status, amount, balance, currency, and accountId. Required: debit_memo_key. Only available with Invoice Settlement enabled; cannot unpost if any credit memo or payment has been applied to the debit memo.

create_a_zuora_debit_memos_invoice

Create an ad-hoc debit memo from an invoice in Zuora. Returns the created debit memo including id, number, accountId, status, amount, currency, balance, dueDate, and reasonCode. Only available when Invoice Settlement is enabled. Required: invoice_id, invoiceId.

zuora_debit_memo_write_offs_bulk_update

Write off a debit memo in Zuora, which automatically creates and applies a credit memo to the debit memo. Returns: creditMemo, success. Required: debit_memo_key. Requires Invoice Settlement enabled and the enhanced write-off permission for your tenant.

list_all_zuora_einvoice_service_providers

List e-invoicing service providers in Zuora. Returns: serviceProviders, success, id, name, provider, serviceProviderNumber, test, companyIdentifier.

create_a_zuora_einvoice_service_provider

Create an e-invoicing service provider in Zuora. Returns: companyIdentifier, id, name, provider, serviceProviderNumber, test, apiKey, use_certificate, clientCertificate, clientCertificateType. Required: name, provider.

get_single_zuora_einvoice_service_provider_by_id

Get a single e-invoicing service provider in Zuora by id. Returns: companyIdentifier, id, name, provider, serviceProviderNumber, test, apiKey, use_certificate, clientCertificate, clientCertificateType. Required: id.

update_a_zuora_einvoice_service_provider_by_id

Update an e-invoicing service provider in Zuora by id. Returns: companyIdentifier, id, name, provider, serviceProviderNumber, test, apiKey, use_certificate, clientCertificate, clientCertificateType. Required: id.

delete_a_zuora_einvoice_service_provider_by_id

Delete an e-invoicing service provider in Zuora by id. Returns: processId, reasons, requestId, success. Required: id.

list_all_zuora_einvoice_business_regions

List Zuora e-invoicing business regions. Returns regions with each region's id, country, businessName, businessRegionNumber, serviceProviderId, and fileFormat, plus success. Requires the E-Invoicing feature.

create_a_zuora_einvoice_business_region

Create a Zuora e-invoicing business region to store seller business details. Returns: id, country, businessName, businessNumber, businessNumberSchemaId, tradeName, endpointId, endpointSchemeId, taxRegisterNumber, serviceProviderId, businessRegionNumber, fileFormat, and 21 more. Required: businessName, country. Requires the E-Invoicing feature.

get_single_zuora_einvoice_business_region_by_id

Get a Zuora e-invoicing business region by id (its unique ID or number). Returns: id, country, businessName, businessNumber, businessNumberSchemaId, tradeName, endpointId, endpointSchemeId, taxRegisterNumber, state, city, postalCode, addressLine1, businessRegionNumber, fileFormat, and 19 more. Requires the E-Invoicing feature. Required: id.

update_a_zuora_einvoice_business_region_by_id

Update a Zuora e-invoicing business region by id (its unique ID or number). Returns: id, country, businessName, businessNumber, businessNumberSchemaId, tradeName, endpointId, endpointSchemeId, taxRegisterNumber, state, city, postalCode, addressLine1, businessRegionNumber, fileFormat, and 18 more. Requires the E-Invoicing feature. Required: id.

delete_a_zuora_einvoice_business_region_by_id

Delete a Zuora e-invoicing business region by id — the region's unique ID or number. Returns: processId, reasons, requestId, success. Requires the E-Invoicing feature. Required: id.

list_all_zuora_e_invoice_mandates

List Zuora e-invoice mandates for downloading files, filtered by country code, process type, and service provider. Returns: countryCode, fileFormats, category, processType, defaultFileFormats.

get_single_zuora_e_invoice_mandate_by_id

Get a Zuora e-invoice mandate for a specific invoice by id. Returns: success, error, countryCode, fileFormats, category, defaultFileFormats, processType. Required: id.

get_single_zuora_e_invoice_download_by_id

Download a Zuora e-invoice in a specified file format (XML, PDF, ZIP, or UBL XML). Returns: success, error, processId, reasons, requestId. Required: id. The fileFormat parameter is only applicable for documents submitted via the Avalara E-Invoice integration; Sovos or PEPPOL documents download in their default format.

zuora_e_invoice_cancels_bulk_update

Cancel the e-invoice file for a billing document in Zuora by invoice key. Returns: processId, reasons, requestId, success. Required: invoice_key.

list_all_zuora_einvoice_templates

List Zuora e-invoice file templates filtered by country, document type, and provider. Returns: success, templates. Required: country, documentType, provider.

create_a_zuora_einvoice_template

Create an e-invoice file template in Zuora for invoices, credit memos, or debit memos. Returns: content, country, documentType, id, name, provider, templateNumber, success. Required: content, country, documentType, name, provider.

get_single_zuora_einvoice_template_by_id

Get a Zuora e-invoice file template by id. Returns: content, country, documentType, id, name, provider, templateNumber, success. Required: id.

update_a_zuora_einvoice_template_by_id

Update a Zuora e-invoice file template by id. Returns: content, country, documentType, id, name, provider, templateNumber, success. Required: id.

delete_a_zuora_einvoice_template_by_id

Delete a Zuora e-invoice file template by id. The key can be the unique ID or template number. Returns: processId, reasons, requestId, success. Required: id.

zuora_e_invoice_sync_status_bulk_update

Sync the e-Invoice status of a Zuora invoice by triggering a background poll for the latest notification from the configured e-Invoicing provider. Returns: processId, reasons, requestId, success. Required: invoice_key. Only valid when the current e-Invoice status is Processing, ApprovedByAuthority, RetrieveTimeout, or Failed.

zuora_einvoice_generates_bulk_update

Generate (or regenerate) an e-invoice file for a Zuora invoice by invoice key. If the previous e-invoice generation failed, triggering this action resubmits the document to the e-invoicing service provider and updates its status to Processing. Returns: processId, reasons, requestId, success. Required: invoice_key.

zuora_e_invoice_generates_bulk_update

Generate or regenerate an e-invoice file for a credit memo in Zuora. If the credit memo's e-invoice generation previously failed, this action resubmits the document to the e-invoicing service provider and updates its status to Processing. Returns: processId, reasons, requestId, success. Required: credit_memo_key.

create_a_zuora_lifecycle_status_update

Create a seller-initiated e-invoice lifecycle status update in Zuora to notify the tax authority of business status changes such as payment collection, cancellation, or completion. Returns: id, sourceObjectId, sourceObjectType, requestedStatus, status, createdOn, success. Required: sourceObjectId, sourceObjectType, requestedStatus.

list_all_zuora_lifecycle_status_updates

List e-invoice business lifecycle status update audit records in Zuora, optionally filtered by document, status, and requested action. Returns: processId, reasons, requestId, success, statusUpdates, page, pageSize, total.

get_single_zuora_lifecycle_status_update_by_id

Get a single e-invoice business lifecycle status update audit record in Zuora by its unique identifier. Returns: processId, reasons, requestId, success, statusUpdates, page, pageSize, total. Required: id.

create_a_zuora_e_compliance_reconcile

Reconcile an e-compliance request for a supplied source object in Zuora. Returns: processId, reasons, requestId, success, eReportingRequest, lifecycleStatusUpdate. Required: complianceType, sourceObjectKey, sourceObjectType.

list_all_zuora_e_reporting_templates

List all e-reporting templates in Zuora. Returns each template with id, name, ereportingSupplierId, sourceObjectType, businessCategory, and status.

create_a_zuora_e_reporting_template

Create an e-reporting template in Zuora. Returns the created template including id, name, status, content, templateNumber, createdOn, and updatedOn. Required: name, ereportingSupplierId, sourceObjectType, businessCategory, status, content.

get_single_zuora_e_reporting_template_by_id

Get a single e-reporting template in Zuora by id. Returns: processId, reasons, requestId, success, id, name, ereportingSupplierId, sourceObjectType, businessCategory, status, content, templateNumber, createdOn, updatedOn. Required: id.

update_a_zuora_e_reporting_template_by_id

Update an e-reporting template in Zuora by id. Returns the updated template including id, name, ereportingSupplierId, sourceObjectType, businessCategory, status, content, templateNumber, createdOn, updatedOn, and success. Required: id.

delete_a_zuora_e_reporting_template_by_id

Delete an e-reporting template in Zuora by id. Returns: processId, reasons, requestId, success. Required: id.

list_all_zuora_e_reporting_business_regions

List e-reporting business regions in Zuora. Returns: reasons, success, id, country, state, city, postalCode, addressLine1, addressLine2, businessName, businessNumber, businessNumberSchemeId, tradeName, endpointId, endpointSchemeId, taxRegisterNumber, contactName, phoneNumber, email, engineId, reportingScheme, mode, natureKey, and 26 more.

create_a_zuora_e_reporting_business_region

Create a new e-reporting business region in Zuora. Returns the created region including id, businessName, country, reportingScheme, mode, invoiceEnabled, engineId, and success. Required: country, reportingScheme, engineId, businessName.

get_single_zuora_e_reporting_business_region_by_id

Get a single e-reporting business region in Zuora by id. Returns: processId, reasons, requestId, success, regions, businessName, businessNumber, businessNumberSchemeId, tradeName, endpointId, endpointSchemeId, taxRegisterNumber, country, state, city, postalCode, addressLine1, addressLine2, contactName, phoneNumber, email, and 7 more. Required: id.

update_a_zuora_e_reporting_business_region_by_id

Update an e-reporting business region in Zuora by id. Returns the updated region including id, businessName, country, reportingScheme, mode, invoiceEnabled, engineId, and success. Required: id.

delete_a_zuora_e_reporting_business_region_by_id

Delete an e-reporting business region in Zuora by id. Returns: processId, reasons, requestId, success. Required: id.

list_all_zuora_e_reporting_requests

List Zuora e-reporting requests, optionally filtered by source object and status. Returns: processId, reasons, requestId, success, requests, page, pageSize, total, request, 4XX. Max 100 per page.

get_single_zuora_e_reporting_request_by_id

Get a single Zuora e-reporting request by id. Returns: processId, reasons, requestId, success, requests, page, pageSize, total, request. Required: id.

list_all_zuora_e_compliance_files

Download the provider-certified e-compliance file for a specific source object in Zuora. Returns the binary compliance document content with a Content-Type that depends on the provider (e.g. application/xml or application/pdf). Required: compliance_type, source_object_type, source_object_id.

list_all_zuora_e_compliance_snapshots

Download the provider-certified e-compliance snapshot for a source object in Zuora. Returns an array of snapshot objects with id and provider-specific attributes containing the raw payload submitted to the compliance provider. Required: compliance_type, source_object_type, source_object_id.

create_a_zuora_e_compliance_trigger

Trigger an e-compliance request. Returns: processId, reasons, requestId, success, eReportingRequest, lifecycleStatusUpdate. Required: complianceType, sourceObjectKey, sourceObjectType, supplierId.

create_a_zuora_e_compliance_regenerate

Regenerate a failed or rejected e-compliance request in Zuora by supplying the id of the existing e-reporting request. Returns: processId, reasons, requestId, success, eReportingRequest, lifecycleStatusUpdate. Required: complianceType, requestId.

create_a_zuora_invoice_schedule

Create an invoice schedule in Zuora. Returns: accountId, actualAmount, additionalSubscriptionsToBill, billedAmount, currency, id, invoiceSeparately, nextRunDate, notes, number, orders, scheduleItems, specificSubscriptions, status, totalAmount, unbilledAmount, success, and 1 more. Max 50 schedule items, 10 orders, and 300 subscriptions per request.

get_single_zuora_invoice_schedule_by_id

Retrieve a specific Zuora invoice schedule by its id or number. Returns: accountId, actualAmount, additionalSubscriptionsToBill, billedAmount, currency, id, invoiceSeparately, nextRunDate, notes, number, orders, scheduleItems, specificSubscriptions, status, totalAmount, unbilledAmount, organizationLabel, success. Required: id.

update_a_zuora_invoice_schedule_by_id

Update a pending Zuora invoice schedule's notes, schedule items, orders, and specific subscriptions. Returns: accountId, actualAmount, additionalSubscriptionsToBill, billedAmount, currency, id, invoiceSeparately, notes, number, orders, status, success, and 6 more. Required: id. Omitted schedule items and orders are deleted from the schedule.

delete_a_zuora_invoice_schedule_by_id

Delete a Zuora invoice schedule that is in Pending status. Returns: processId, reasons, requestId, success. Required: id. Only schedules in Pending status can be deleted.

zuora_invoice_schedules_execute

Execute an invoice schedule immediately in Zuora, triggering a bill run that generates an invoice or credit memo asynchronously. Returns the created bill run object including id, billRunNumber, status, targetDate, success, createdDate, and updatedDate. Required: schedule_key. Paused invoice schedules cannot be executed through this operation.

zuora_invoice_schedules_pause

Pause a Zuora invoice schedule immediately so it can no longer be automatically executed by Zuora Scheduler. Returns the full invoice schedule object including id, number, status, scheduleItems, totalAmount, and success. Required: invoice_schedule_id.

zuora_invoice_schedules_resume

Resume a paused Zuora invoice schedule immediately, restoring automatic execution by Zuora Scheduler. Returns the full invoice schedule object including id, number, status, scheduleItems, totalAmount, and success. Required: invoice_schedule_id.

zuora_invoice_schedules_detach

Detach charges from a Zuora invoice schedule so they are no longer billed by the schedule. The invoice schedule must be in Fully Processed or Partially Processed status. Returns: processId, reasons, requestId, success. Required: invoice_schedule_id.

zuora_invoice_schedules_attach

Attach previously-detached charges to a Zuora invoice schedule. Returns: processId, reasons, requestId, success. The schedule must be in Fully Processed or Partially Processed status; only charges previously detached from the same schedule can be re-attached. Required: invoice_schedule_id.

create_a_zuora_object_taxation_item

Create a Taxation Item object in Zuora via the CRUD proxy object API. Returns: Id, Success. Additional accepted fields include MemoItemId, Name, TaxCode, TaxCodeDescription, TaxDate, TaxRate, TaxRateDescription, TaxRateType, TaxMode, ExemptAmount, Jurisdiction, LocationCode, SourceTaxItemId, TaxableAmount,…. Required: InvoiceItemId, Jurisdiction, Name, TaxAmount, TaxDate, TaxRate, TaxRateType.

get_single_zuora_taxation_item_by_id

Get a specific Zuora taxation item by id. Returns the full taxation item including id, name, taxAmount, taxRate, taxRateType, taxCode, taxDate, jurisdiction, financeInformation, and audit fields. Required: id.

update_a_zuora_taxation_item_by_id

Update a specific Zuora taxation item by id with revised tax details. Returns the updated taxation item including id, name, taxAmount, taxRate, taxRateType, taxCode, jurisdiction, financeInformation, createdDate, updatedDate. Required: id.

delete_a_zuora_taxation_item_by_id

Delete a specific Zuora taxation item by id. Returns: processId, reasons, requestId, success. Required: id.

list_all_zuora_sequence_sets

List Zuora sequence sets configured for billing documents, payments, and refunds. Returns each record with id, name, and prefix/start-number configurations for creditMemo, debitMemo, invoice, payment, and refund. Optional filter: name.

create_a_zuora_sequence_set

Create Zuora sequence sets with custom prefixes and starting numbers for billing documents, payments, and refunds. Returns the created sequenceSets array (each with id, name, and document configurations) and a success flag. Maximum 100 sequence sets per request.

get_single_zuora_sequence_set_by_id

Get a single Zuora sequence set by id. Returns: creditMemo, debitMemo, id, invoice, name, payment, refund, success. Required: id.

update_a_zuora_sequence_set_by_id

Update a Zuora sequence set by id, modifying prefixes and starting numbers for billing documents, payments, and refunds. Returns: success. Required: id.

delete_a_zuora_sequence_set_by_id

Delete a Zuora sequence set by id. Returns: processId, reasons, requestId, success. Required: id.

create_a_zuora_operations_billing_preview

Generate a billing preview. Returns: accountId, creditMemoItems, invoiceItems, success. Required: targetDate.

create_a_zuora_operations_invoice_collect

Generate and post invoices and credit memos, and collect payments for a Zuora account using its default payment method. Returns: amountCollected, creditMemos, invoices, paymentId, success. The operation is atomic; leave invoiceId empty to generate new invoices or specify it to collect on an existing invoice. Required: accountKey.

get_single_zuora_operations_job_by_id

Get a specific Zuora operation job by id, currently limited to retrieving status information about invoice deletion and reversal operation jobs. Returns: id, objectId, objectType, operationType, reasons, status, success. Required: id.

create_a_zuora_operations_bulk_pdf

Create a bulk PDF export job in Zuora that compresses billing document PDFs into ZIP files. Returns: processId, reasons, requestId, success, jobId, invalidIds, skippedDocuments, jobName, status, stepStatus, and 3 more. Do not include multiple objectIds with the same PDF file names in a single request. Required: documents, fileName, indexFileFormat.

get_single_zuora_operations_bulk_pdf_by_id

Get information about a Zuora bulk PDF file generation job by id, including its status and downloadable ZIP file URLs. Returns: jobId, jobName, status, stepStatus, fileUrls, failedDocuments, createdOn, createdBy, success. Required: id.

create_a_zuora_bill_run

Create an ad-hoc or scheduled Zuora bill run by batch, account, subscription, or custom filter. Returns: autoEmail, autoPost, autoRenewal, batches, billCycleDay, billRunNumber, createdDate, id, status, targetDate, and 19 more. Requires either batches (batch-based runs) or billRunFilters (account, subscription, or custom-filter runs).

get_single_zuora_bill_run_by_id

Get a Zuora bill run by id. Returns: autoEmail, autoPost, autoRenewal, batches, billCycleDay, billRunFilters, billRunNumber, chargeTypeToExclude, createdById, createdDate, includeSubscriptions, includeOrderLineItems, id, invoiceDate, invoiceDateOffset, invoiceDateMonthOffset, status, targetDate, updatedDate, and 10 more. Required: id.

delete_a_zuora_bill_run_by_id

Delete a Zuora bill run by id; only bill runs in Canceled or Error status can be deleted. Returns: autoEmail, autoPost, autoRenewal, batches, billCycleDay, billRunFilters, billRunNumber, chargeTypeToExclude, createdById, createdDate, includeSubscriptions, includeOrderLineItems, id, invoiceDate, status, updatedDate, and 13 more. Required: id.

zuora_bill_runs_cancel

Cancel a Zuora bill run by id; only bill runs in Draft status can be cancelled, and cancelOnce controls whether future recurring scheduled runs are cancelled too. Returns: autoEmail, autoPost, autoRenewal, batches, billCycleDay, billRunFilters, billRunNumber, createdDate, id, status, updatedDate, and 19 more. Required: bill_run_id.

zuora_bill_run_posts_bulk_update

Post a bill run in Zuora; posting runs asynchronously (status moves from PostInProgress to Posted). Returns: autoEmail, autoPost, autoRenewal, batches, billRunNumber, id, invoiceDate, name, and 21 more. The bill run must be in Completed status, and invoiceDate cannot fall in a closed accounting period. Required: bill_run_id, invoiceDate.

create_a_zuora_bill_run_email

Email all billing documents (invoices and credit memos) generated from a specified bill run to customers in Zuora. Returns: processId, reasons, requestId, success. Required: bill_run_key. Only posted billing documents can be emailed; the request body must be an empty JSON object {}.

create_a_zuora_billing_preview_run

Create a billing preview run. Returns: billingPreviewRunId, success. Required: targetDate.

get_single_zuora_billing_preview_run_by_id

Get a Zuora billing preview run by id. Returns: assumeRenewal, batches, chargeTypeToExclude, createdById, createdDate, endDate, errorMessage, includingDraftItems, includingEvergreenSubscription, organizationLabels, resultFileUrl, runNumber, startDate, status, storageOption, succeededAccounts, success, targetDate, and 3 more. Required: id.

create_a_zuora_payment_method

Create a new payment method in Zuora, either associated with a customer account or as an orphan. Returns: processId, reasons, requestId, success, id. Required: type. Supported types include CreditCard, ACH, SEPA, PayPal, Apple Pay, Google Pay, Amazon Pay, and others.

get_single_zuora_payment_method_by_id

Get detailed information about a specific electronic payment method in Zuora by id. Returns: accountHolderInfo, accountVerificationService, accountVerificationStatus, bankIdentificationNumber, createdBy, createdOn, creditCardMaskNumber, id, status, type, accountNumber, email, createdDate, success, updatedDate, and 47 more. Required: id.

update_a_zuora_payment_method_by_id

Update an existing payment method in Zuora by id. Updatable fields include accountHolderInfo, expirationMonth, expirationYear, securityCode, mandateInfo, authGateway, gatewayOptions, ipAddress, maxConsecutivePaymentFailures, paymentRetryWindow, and useDefaultRetryRule. Returns: id, success. Required: id.

delete_a_zuora_payment_method_by_id

Delete a credit card payment method in Zuora by id. The request will fail if the payment method is the account's default. Returns: processId, reasons, requestId, success. Required: id.

zuora_payment_methods_update_verify

Verify a payment method in Zuora by sending an authorization request to the payment gateway. Supports credit cards and PayPal. Returns: paymentMethodId, success. Required: payment_method_id.

create_a_zuora_payment_methods_decryption

Create an Apple Pay payment method in Zuora by decrypting the Apple Pay payment token, creating a credit card payment method from the decrypted information, and optionally creating a stored credential profile and processing payment on a specified invoice — all in one atomic call. Returns: amount, paymentId, paymentMethodId, and 1 more. Required: integrationType, merchantID, paymentToken.

zuora_payment_method_scrubs_bulk_update

Scrub sensitive data from a Zuora payment method, replacing all sensitive values in the payment method, its snapshot table, and related log tables with dummy values. Returns: processId, reasons, requestId, success. Required: payment_method_id. The Scrub Sensitive Data of Specific Payment Method payments permission must be enabled in your user role.

get_single_zuora_payment_method_balance_by_id

Retrieve the real-time balance of a bank account payment method in Zuora via Plaid Balance. Returns: success, currency, availableBalance, currentBalance. Required: id. Only ACH payment methods are supported, and Plaid Auth and Balance support must be enabled beforehand.

list_all_zuora_payment_method_profiles

List stored credential profiles for a Zuora payment method. By default only profiles with Agreed or Active status are returned; set includeAll to true to retrieve all profiles. Returns: profiles, success. Required: payment_method_id.

create_a_zuora_payment_method_profile

Create a stored credential profile within a Zuora payment method. The profile represents a consent agreement established with a customer for recurring or unscheduled transactions. Returns: number, paymentMethodId, success. Required: payment_method_id, consentAgreementSrc, status, type.

zuora_payment_method_profiles_cancel

Cancel a stored credential profile within a Zuora payment method, indicating that the stored credentials are no longer valid per a customer request. Returns: number, paymentMethodId, success. Required: payment_method_id, profile_number. A cancelled stored credential profile cannot be reactivated.

create_a_zuora_profile_expire

Expire a stored credential profile within a Zuora payment method, marking its stored credentials as no longer valid per the stored credential transaction framework. Returns: number, paymentMethodId, success. Required: payment_method_id, profile_number. The stored credential profile cannot be reactivated after expiration.

list_all_zuora_wallet_domains

List registered wallet domains in Zuora, optionally filtered by domain name. Returns each domain's id, domainName, domainIdentifier, domainVerified, walletType, createdBy, createdOn, updatedBy, and updatedOn. Required: walletType.

create_a_zuora_wallet_domain

Register a wallet domain with Apple Pay in Zuora for domains that will show the Apple Pay button. Returns: domainName, domainVerified, id, domainIdentifier, walletType, success. Required: domainName, walletType.

delete_a_zuora_wallet_domain_by_id

Unregister a wallet domain in Zuora by id. Returns: success. Required: id.

create_a_zuora_web_payments_session

Create a payment session in Zuora on the server side. Returns: token. The processPayment, storePaymentMethod, amount, and invoices fields define the payment flow mode — create-and-save a payment method, process a one-time payment, or process a payment and save the method for recurring use. Required: amount, currency, processPayment.

get_single_zuora_object_payment_method_snapshot_by_id

Get a single payment method snapshot in Zuora by id. A Payment Method Snapshot is a copy of the payment method used in a transaction and retains its data even after the original payment method is deleted. Returns: AccountId, BankIdentificationNumber, CompanyName, CreditCardAddress1, CreditCardCity, CreditCardCountry, and 66 more. Required: id.

get_single_zuora_object_payment_method_transaction_log_by_id

Get a single Zuora payment method transaction log by id. Returns the full transaction log object including Id, GatewayTransactionType, TransactionDate, PaymentMethodId, and gateway response details. Required: id.

list_all_zuora_payment_method_updaters

List all Payment Method Updater (PMU) instances on your Zuora tenant, excluding American Express (AMEX). Returns: success, updaters, id, payments.

create_a_zuora_payment_method_updaters_batch

Create a Payment Method Updater (PMU) batch asynchronously in Zuora. Returns: success. PMU for American Express (AMEX) is not supported. Required: billingCycleDay, updaterAccountId.

create_a_zuora_rsa_signature

Generate an RSA digital signature and token for a Zuora Payment Pages 2.0 form. Returns: key, signature, success, and 2 more. Requires a request body specifying the Payment Pages 2.0 form parameters to be signed. If signature returns null but token is returned, the request may exceed the RSA algorithm's maximum supported length — reduce the number of fields in the request. Required: method, pageId, uri.

create_a_zuora_rsa_signatures_decrypt

Decrypt an RSA signature in Zuora to validate the signature and key for Payment Pages 2.0. Returns: decryptedSignature, publicKey, signature, success. Intended for Payment Pages 2.0 implementations only. Required: method, publicKey, signature.

list_all_zuora_hostedpages

List Zuora Payment Pages (hosted pages) configuration metadata, including page ID, page version, and payment method type for each page. Returns: hostedpages, success. Specifying versionNumber as 2 requires the Payment Pages 2.0 tenant setting to be enabled or the request will error.

create_a_zuora_open_payment_method_type

Create a draft custom payment method type in Zuora. Revision number 1 is automatically assigned to the new draft version, which must be published through a separate operation before going live. Returns: paymentMethodType, publishDate, revision, status. Required: fields, internalName, label, methodReferenceIdField, tenantId.

zuora_open_payment_method_types_bulk_update

Update a custom payment method type. Returns: paymentMethodType, publishDate, revision, status. Required: payment_method_type_name, fields, internalName, label, methodReferenceIdField, tenantId.

zuora_open_payment_method_types_publishes_bulk_update

Publish the latest draft revision of a custom payment method type in Zuora. Returns: entityId, fields, internalName, label, methodReferenceIdField, revision, status, subTypeField, tenantId, userReferenceIdField, version. Required: payment_method_type_name.

list_all_zuora_open_payment_method_type_drafts

Retrieve a specific draft revision of a custom payment method type in Zuora. Returns: entityId, fields, internalName, label, methodReferenceIdField, revision, status, subTypeField, tenantId, userReferenceIdField, version. Required: payment_method_type_name, revision_number.

list_all_zuora_open_payment_method_type_publisheds

Retrieve a published custom payment method type in Zuora by its API name. Returns: entityId, fields, internalName, label, methodReferenceIdField, revision, status, subTypeField, tenantId, userReferenceIdField, version. Required: payment_method_type_name.

create_a_zuora_payment_method_authorize

Create authorization. Returns: currency, gatewayOrderId, paymentGatewayResponse, processId, reasons, requestId, resultCode, resultMessage, success, transactionId. Required: payment_method_id, amount, gatewayOrderId.

create_a_zuora_payment_method_void_authorize

Cancel (void) a payment authorization in Zuora for gateway integrations that support delayed capture. Returns: gatewayOrderId, resultCode, resultMessage, success, transactionId, paymentMethodId, gatewayResponse, gatewayResponseCode. Required: payment_method_id, gatewayOrderId, transactionId.

list_all_zuora_paymentgateways

List all payment gateways in Zuora. Retrieves basic information about every configured payment gateway. Returns: paymentgateways, success, id, isActive, isDefault, name, type.

create_a_zuora_payment_gateways_pre_debit_notification

Trigger a pre-debit notification to the payment gateway for a posted invoice that meets recurring UPI payment requirements through Adyen Integration v2.0. Returns: success, paymentMethodId, gatewayId, and 7 more. Requires a JSON request body identifying the target invoice. UPI transaction support on Adyen must be enabled before use. Required: invoiceKey.

create_a_zuora_payment_chargeback

Reverse (chargeback) a Zuora payment by setting its gateway state to Settled and creating an external refund for the amount specified in the request body. Returns the Refund object including id, number, status, amount, reasonCode, gatewayState, and success. Required: payment_key, amount.

zuora_gateway_settlement_payments_reject

Reject a Zuora payment by setting its Gateway State to FailedToSettle and creating a refund for the payment amount. Returns the Refund object including id, number, status, amount, reasonCode, and success. Required: payment_key.

create_a_zuora_payment_settle

Settle a Zuora payment by setting its Gateway State to `Settled` (and Payment Status to `Processed` for ACH/Bank Transfer payments when the Asynchronous Payment Statuses feature is enabled). Returns the full Payment object including id, number, status, amount, currency, gatewayState, settledOn, and financeInformation. Required: payment_key.

create_a_zuora_refund_reconcile

Reconcile a refund in Zuora when receiving a gateway reconciliation request or event. Returns the reconciled refund object including id, number, status, gatewayReconciliationStatus, gatewayReconciliationReason, and success. Required: refund_key.

list_all_zuora_payments

List Zuora payments across all customer accounts. Returns payments with id, number, status, amount, currency, and effectiveDate. Filterable by status, type, accountId, and more; requires Invoice Settlement enabled.

create_a_zuora_payment

Create a Zuora payment on invoices or debit memos, or as an unapplied or standalone payment. Returns: accountId, accountNumber, amount, appliedAmount, authTransactionId, bankIdentificationNumber, currency, id, number, status, and 41 more. Required: amount, currency, type. A payment can apply to at most 15,000 invoice and debit memo items.

get_single_zuora_payment_by_id

Retrieve a single Zuora payment by id — the payment ID or payment number (e.g. P-00000001). Returns: accountId, accountNumber, amount, appliedAmount, authTransactionId, bankIdentificationNumber, cancelledOn, comment, createdById, createdDate, currency, effectiveDate, id, number, and 36 more. Requires Invoice Settlement enabled. Required: id.

update_a_zuora_payment_by_id

Update a Zuora payment by id — the payment ID or payment number. Returns the updated payment with id, number, status, amount, and unappliedAmount. Requires Invoice Settlement enabled. Required: id.

delete_a_zuora_payment_by_id

Delete a Zuora payment by id — the payment ID or payment number. Returns: processId, reasons, requestId, success. Only payments with the Cancelled status can be deleted, and overpayments applied to credit balance cannot be. Required: id.

zuora_payments_update_cancel

Cancel an unapplied payment in Zuora by its id or number. Returns the cancelled payment object including id, number, status, amount, and unappliedAmount. Only available with Invoice Settlement enabled; overpayments applied to credit balance cannot be cancelled. Required: payment_id.

zuora_payment_applies_bulk_update

Apply a payment. Returns: accountId, accountNumber, amount, appliedAmount, authTransactionId, bankIdentificationNumber, cancelledOn, comment, createdById, createdDate, creditBalanceAmount, currency, effectiveDate, financeInformation, gatewayId, gatewayOrderId, gatewayReconciliationReason, and 33 more. Required: payment_key.

list_all_zuora_payment_parts

List all parts of a Zuora payment, including applied and unapplied portions. Returns: nextPage, parts, success. Required: payment_key. Only available with Invoice Settlement enabled; a fully refunded payment contains no parts.

get_single_zuora_payment_part_by_id

Get a specific part of a Zuora payment by id. Returns: amount, createdById, createdDate, debitMemoId, id, invoiceId, organizationLabel, success, updatedById, updatedDate. Required: payment_key, id. Only available with Invoice Settlement enabled.

list_all_zuora_part_item_parts

List all payment part items for a specific payment part in Zuora. Returns each item's id, amount, debitMemoItemId, invoiceItemId, taxItemId, createdDate, and updatedDate. Required: payment_key, partid. Requires the Invoice Item Settlement feature to be enabled.

get_single_zuora_part_item_part_by_id

Get a specific payment part item by id in Zuora. Returns: amount, createdById, createdDate, debitMemoItemId, id, invoiceItemId, organizationLabel, success, taxItemId, updatedById, updatedDate. Required: payment_key, partid, id. Requires the Invoice Item Settlement feature to be enabled.

create_a_zuora_payment_refund

Refund a full or partial unapplied payment in Zuora. Returns the refund object including id, number, status, amount, refundDate, methodType, and gateway response details. Only available when Invoice Settlement is enabled. Required: payment_key, totalAmount, type.

create_a_zuora_refunds_unapply

Refund a payment with auto-unapplying. Returns: accountId, amount, cancelledOn, comment, createdById, createdDate, creditMemoId, financeInformation, gatewayId, gatewayReconciliationReason, gatewayReconciliationStatus, gatewayResponse, gatewayResponseCode, gatewayState, id, markedForSubmissionOn, methodType, and 28 more. Required: payment_key, type.

zuora_payment_transfers_bulk_update

Transfer an unapplied payment in Zuora. Returns the updated payment object including id, accountId, amount, currency, status, unappliedAmount, and success. Required: payment_key. Only available with Invoice Settlement enabled.

zuora_payment_unapplies_bulk_update

Unapply an applied Zuora payment from invoices and debit memos. Returns the updated payment object including id, number, status, type, accountId, amount, appliedAmount, unappliedAmount, currency, and success. Required: payment_key. Requires Invoice Settlement enabled; total invoice and debit memo items to unapply from must be ≤ 15,000.

get_single_zuora_object_payment_transaction_log_by_id

Get a specific Zuora payment transaction log by id. Returns: AVSResponseCode, BatchId, CVVResponseCode, Gateway, GatewayReasonCode, GatewayReasonCodeDescription, GatewayState, GatewayTransactionType, Id, PaymentId, RequestString, ResponseString, TransactionDate, TransactionId. Required: id.

list_all_zuora_payment_runs

List Zuora payment runs with optional filtering by status, target date, created/updated date, and created/updated by ID. Returns each run's id, number, status, targetDate, collectPayment, consolidatedPayment, applyCreditBalance, createdDate, and updatedDate. Supports sorting by up to two sortable fields; defaults to descending order by payment run number.

create_a_zuora_payment_run

Create a Zuora payment run for immediate or scheduled execution. Filter payments using accountId/batch/billCycleDay/currency/paymentGatewayId/billingRunId OR the data field — not both. If no filter criteria are specified, collects payments for all accounts. Returns: accountId, batch, createdById, createdDate, currency, id, number, and 19 more.

get_single_zuora_payment_run_by_id

Get a specific Zuora payment run by id (payment run ID or number). Returns: accountId, applyCreditBalance, autoApplyCreditMemo, autoApplyUnappliedPayment, batch, billCycleDay, billingRunId, collectPayment, completedOn, consolidatedPayment, createdById, createdDate, currency, executedOn, id, number, organizationLabels, and 9 more. Required: id.

update_a_zuora_payment_run_by_id

Update an unexecuted Zuora payment run by id. Only pending payment runs can be updated. If none of the filter fields (accountId, batch, billCycleDay, currency, paymentGatewayId, billingRunId) are specified, the payment run collects payments for all accounts. Returns: accountId, applyCreditBalance, autoApplyCreditMemo, and 23 more. Required: id.

delete_a_zuora_payment_run_by_id

Delete a Zuora payment run by id. Only payment runs with Canceled or Error status can be deleted. Returns: processId, reasons, requestId, success. Required: id.

get_single_zuora_payment_run_datum_by_id

Retrieve payment run data and processing results for a Zuora payment run by id. Returns: accountId, accountNumber, amount, amountCollected, amountToCollect, comment, currency, documentId, documentNumber, documentType, errorCode, errorMessage, paymentGatewayId, paymentMethodId, result, and 4 more. Required: id. Data is only available if the `data`…

get_single_zuora_payment_run_summary_by_id

Get a summary of a Zuora payment run by id, including counts of processed payments, invoices, credit memos, debit memos, errors, and aggregated monetary totals. Returns: numberOfCreditBalanceAdjustments, numberOfCreditMemos, numberOfDebitMemos, numberOfErrorInputData, numberOfErrors, numberOfInputData, numberOfInvoices, and 9 more. Required: id.

create_a_zuora_payment_schedule_items_retry_payment

Retry failed Zuora payment schedule items, optionally updating the payment method and payment gateway before retrying. Returns: items, success. Items must be in Error or Pending status to retry; Invoice Settlement must be enabled.

zuora_payment_schedule_items_update_cancel

Cancel a payment schedule item in Zuora by ID. Returns: accountId, amount, balance, billingDocument, cancellationReason, createdById, createdDate, currency, description, errorMessage, id, number, paymentGatewayId, paymentMethodId, paymentOption, paymentScheduleId, paymentScheduleNumber, psiPayments, runHour, and 7 more. Required: item_id.

get_single_zuora_payment_schedule_item_by_id

Get a Zuora payment schedule item by id. Returns: accountId, amount, balance, billingDocument, cancellationReason, cancelledById, createdById, createdDate, currency, description, id, number, standalone, status, success, updatedById, updatedDate, and 10 more. Required: id. The Payment Schedules feature requires Invoice Settlement to be enabled.

update_a_zuora_payment_schedule_item_by_id

Update a payment schedule item in Zuora by id. Returns the updated item including id, number, amount, balance, currency, status, scheduledDate, paymentMethodId, paymentScheduleId, billingDocument, createdDate, and updatedDate. Required: id. Requires Invoice Settlement enabled; the Payment Schedules feature is in Early Adopter phase; a maximum of 10 payments can be linked to a single item.

delete_a_zuora_payment_schedule_item_by_id

Delete a Zuora payment schedule item by id. Only items with the Canceled status can be deleted, and Invoice Settlement must be enabled on the tenant. Returns: processId, reasons, requestId, success. Required: id.

create_a_zuora_payment_schedule_item

Add payment schedule items to a custom payment schedule in Zuora. Returns the updated payment schedule including id, paymentScheduleNumber, accountId, accountNumber, status, totalAmount, occurrences, startDate, items, and success. Required: payment_schedule_key. Only applies to custom payment schedules; requires Invoice Settlement enabled.

zuora_payment_schedule_item_skips_bulk_update

Skip a payment schedule item in Zuora by its item ID. The skipped item transitions to canceled status and a replacement item is scheduled on the next recurring date after the last existing scheduled date. Returns the updated payment schedule item including id, status, amount, currency, scheduledDate, success, and paymentScheduleNumber. Required: item_id. Only recurring payment schedule items in…

list_all_zuora_payment_schedules

List Zuora payment schedules by customer account. Returns: accountId, accountNumber, billingDocument, billingDocuments, createdById, createdDate, description, id, isCustom, items, nextPaymentDate, occurrences, paymentOption, paymentScheduleNumber, period, prepayment, recentPaymentDate, runHour, standalone, startDate, status, totalAmount, and 9 more

create_a_zuora_payment_schedule

Create a recurring or custom payment schedule in Zuora. Returns: accountId, accountNumber, billingDocument, billingDocuments, createdById, createdDate, description, id, isCustom, items, nextPaymentDate, occurrences, paymentOption, paymentScheduleNumber, period, prepayment, recentPaymentDate, runHour, standalone, startDate, status, and 10 more

get_single_zuora_payment_schedule_by_id

Get a single Zuora payment schedule by id or payment schedule number. Returns: accountId, accountNumber, billingDocument, billingDocuments, createdById, createdDate, cancellationReason, cancelledById, cancelledOn, cancelDate, description, id, isCustom, items, nextPaymentDate, occurrences, paymentOption, and 14 more. Required: id.

update_a_zuora_payment_schedule_by_id

Update a Zuora payment schedule by id. For custom payment schedules, only custom fields can be updated; use the update payment schedule item operation for item-level changes. Returns: accountId, accountNumber, billingDocument, billingDocuments, createdById, createdDate, cancellationReason, cancelledById, cancelledOn, and 22 more. Required: id.

delete_a_zuora_payment_schedule_by_id

Delete a Zuora payment schedule by id. Only payment schedules with Canceled status can be deleted. Returns: processId, reasons, requestId, success. Required: id.

zuora_payment_schedules_cancel

Cancel a payment schedule in Zuora. All pending payment schedule items are canceled effective from the specified cancel date. Returns: accountId, accountNumber, billingDocument, billingDocuments, createdById, createdDate, cancellationReason, cancelledById, cancelledOn, cancelDate, description, and 25 more. Required: payment_schedule_id, cancelDate.

zuora_payment_schedules_preview

Preview the result of a payment schedule update in Zuora without persisting any changes to the database. Returns: accountId, accountNumber, billingDocument, billingDocuments, createdById, createdDate, cancellationReason, cancelledById, cancelledOn, cancelDate, description, id, isCustom, items, and 17 more. Required: payment_schedule_id.

create_a_zuora_payment_schedules_batch

Create multiple payment schedules at once in Zuora, supporting both recurring and custom payment schedules in a single request. Returns: paymentSchedules, success. Max 50 payment schedules per request; max 1000 items per schedule. Requires Invoice Settlement enabled.

list_all_zuora_payment_schedules_statistics

Retrieve Zuora payment schedule statistics for a specific date. Returns: date, paymentRuns, paymentScheduleItems, success. Required: yyyy_mm_dd.

list_all_zuora_refunds

List Zuora refunds with optional filtering by account, amount, status, type, method, date, and other fields. Returns: nextPage, refunds, success, id, number, accountId, amount, cancelledOn, comment, createdById, createdDate, creditMemoId, financeInformation, gatewayId, gatewayReconciliationReason, gatewayReconciliationStatus, and 22 more

get_single_zuora_refund_by_id

Get a single Zuora refund by id. The id can be either the refund's unique ID or its refund number. Returns: accountId, amount, cancelledOn, comment, createdById, createdDate, creditMemoId, financeInformation, gatewayId, gatewayReconciliationReason, gatewayReconciliationStatus, gatewayResponse, gatewayResponseCode, and 29 more. Required: id.

update_a_zuora_refund_by_id

Update the basic and finance information about a Zuora refund. Returns: accountId, amount, cancelledOn, comment, createdById, createdDate, creditMemoId, financeInformation, gatewayId, gatewayReconciliationReason, gatewayReconciliationStatus, gatewayResponse, gatewayResponseCode, gatewayState, id, markedForSubmissionOn, and 28 more. Required: id.

delete_a_zuora_refund_by_id

Delete a Zuora refund by id. Only refunds with Canceled status can be deleted; refunds applied to credit balance cannot be deleted. Returns: processId, reasons, requestId, success. Required: id. Requires Invoice Settlement to be enabled.

zuora_refunds_update_cancel

Cancel a Zuora refund by refund id. Refunds applied to credit balance cannot be cancelled. Returns: accountId, amount, cancelledOn, comment, createdById, createdDate, creditMemoId, financeInformation, gatewayId, gatewayReconciliationReason, gatewayReconciliationStatus, gatewayResponse, gatewayResponseCode, and 29 more. Required: refund_id.

list_all_zuora_refund_parts

List all parts of a refund in Zuora. Returns each refund part's id, amount, paymentId, creditMemoId, createdDate, updatedDate, createdById, and updatedById. Required: refund_key. Only available with Invoice Settlement enabled.

get_single_zuora_refund_part_by_id

Get a specific refund part by id in Zuora. Returns: amount, createdById, createdDate, creditMemoId, id, organizationLabel, paymentId, success, updatedById, updatedDate. Required: refund_key, id. Only available with Invoice Settlement enabled.

zuora_payment_profiles_bulk_update

Bulk create or update Zuora payment profiles in a single call, creating new profiles or updating existing ones. Returns: success. Maximum 50 payment profiles per call.

get_single_zuora_payments_active_invoice_cycle_information_by_id

Get active Configurable Payment Retry cycles that have not been completed for a Zuora invoice by id. Returns the active retry cycle information object including a success indicator. The full response shape is defined by the GETActiveInvoiceCycleResponse schema upstream; see the Zuora API reference for field-level details. Required: id.

get_payments_active_debit_memo_cycle_information_by_id

Get active retry cycles for a debit memo in Zuora Configurable Payment Retry. Returns information about retry cycles that have not been completed for the debit memo, including the success status. Required: id.

get_single_zuora_payments_active_account_cycle_information_by_id

Get active retry cycle information for a Zuora account in Configurable Payment Retry, listing retry cycles that have not been completed. Returns: cycles. Required: id.

get_single_zuora_payments_invoice_cycle_history_by_id

Get the retry cycle history for a specific invoice in Zuora Configurable Payment Retry, returning information about all completed retry cycles for that invoice. Returns: cycles. Required: id.

get_single_zuora_payments_debit_memo_cycle_history_by_id

List the retry cycle history for a debit memo. Returns: cycles. Required: id.

get_single_zuora_payments_account_cycle_history_by_id

Get the retry cycle history for an account in Zuora Configurable Payment Retry. Returns: cycles. Required: id.

update_a_zuora_payments_execute_invoice_payment_by_id

Execute an invoice payment in Zuora, scheduling the next payment retry attempt for all active retry cycles associated with an invoice to occur in the next hourly payment processor run. Returns: success, message. Required: id.

update_a_zuora_payments_execute_debit_memo_payment_by_id

Execute a debit memo payment in Zuora, scheduling the next payment retry attempt for all active retry cycles associated with the debit memo in the next hourly payment processor run. Returns: success, message. Required: id.

update_a_zuora_payments_execute_account_payment_by_id

Execute payment retry attempts for a Zuora account, scheduling the next retry for all active retry cycles to occur in the next hourly payment processor run. Returns: success, message. Required: id.

create_a_zuora_payments_execute_payment

Execute payment retry attempts in Zuora by scheduling the next hourly processor run for all active retry cycles associated with the provided invoice, debit memo, and/or account IDs. Returns: success, message.

update_a_zuora_payments_remove_invoice_from_retry_cycle_by_id

Remove an invoice from the Configurable Payment Retry cycle in Zuora, stopping any active retry cycles associated with the invoice. Returns: success, message. Required: id.

update_a_zuora_payments_remove_debit_memo_from_retry_cycle_by_id

Remove a debit memo from the retry cycle in Zuora, stopping any active retry cycles associated with the specified debit memo. Returns: success, message. Required: id.

update_a_zuora_payments_remove_account_from_retry_cycle_by_id

Remove a Zuora account from any active payment retry cycles, stopping all ongoing retry attempts for that account. Returns: success, message. Required: id.

create_a_zuora_payments_submit_failed_payment

Submit a failed payment to the Configurable Payment Retry (CPR) retry cycle in Zuora. Adds the failed payment to an existing CPR retry cycle, or creates a new one if none exists. Returns: success, message.

list_all_zuora_metrics_baselines

List baseline metrics for Zuora Configurable Payment Retry, including Retry Success Rate and trend, Document Success Rate and trend, and Average Days Outstanding and trend. Returns: retry_success_rate, retry_success_rate_trend, document_success_rate, document_success_rate_trend, average_days_outstanding, average_days_outstanding_trend, success.

list_all_zuora_metrics_amount_recovereds

List Zuora Configurable Payment Retry amount recovered metrics. Returns the total amount recovered and the amount recovered over the last 30 days broken down by currency.

list_all_zuora_metrics_customer_group_over_times

List Document Success Rate timeseries metrics by customer group in Zuora. Returns the Document Success Rate timeseries for each customer group over the past 6 months. Current month data is excluded; only completed months are shown.

list_all_zuora_metrics_customer_groups

List Zuora Configurable Payment Retry metrics for each customer group in active status. Returns: customer_groups, success. No required parameters.

create_a_zuora_summary_statement_run

Create a summary statement run in Zuora to initiate the generation of summary statements for customer accounts. Specify the run type, target account category, and date range. Returns: id, statementRunNumber, runType, targetAccountCategory, accountKey, batchName, billCycleDay, and 11 more. Required: runType, targetAccountCategory, dateRangeType.

delete_a_zuora_summary_statement_by_id

Delete a summary statement in Zuora by id. Returns: processId, reasons, requestId, success. Required: id. Both the summary statement and its parent summary statement run must be in terminal states before deletion is allowed (Completed, Canceled, Error, or Previewing for the statement; Completed, Error, or Terminated for the parent run).

list_all_zuora_accounting_codes

List all accounting codes in your Zuora chart of accounts. Returns: accountingCodes, nextPage, success, category, createdBy, createdOn, glAccountName, glAccountNumber, id, name, notes, status, type, updatedBy, updatedOn, basicInfo, billToContact, billingAndPayment, einvoiceProfile, metrics, metricsData, soldToContact.

create_a_zuora_accounting_code

Create a new accounting code in Zuora. The code becomes active immediately upon creation. Returns: id, success. Required: name, type.

get_single_zuora_accounting_code_by_id

Get a single Zuora accounting code by id. Returns: category, createdBy, createdOn, glAccountName, glAccountNumber, id, name, notes, status, success, type, updatedBy, updatedOn, segmentConstantValues. Required: id.

update_a_zuora_accounting_code_by_id

Update an existing accounting code in Zuora. Returns: processId, reasons, requestId, success. Required: id. You can only update accounting codes that are not already associated with any transactions.

delete_a_zuora_accounting_code_by_id

Delete an accounting code in Zuora by id. Returns: processId, reasons, requestId, success. Required: id. The accounting code must be deactivated before deletion and must have never been associated with any transactions.

zuora_accounting_codes_activate

Activate a Zuora accounting code by setting its status to active. Returns: processId, reasons, requestId, success. Required: accounting_code_id.

zuora_accounting_codes_deactivate

Deactivate a Zuora accounting code. Returns: processId, reasons, requestId, success. Required: accounting_code_id. Only accounting codes not associated with any transactions can be deactivated; codes of type AccountsReceivable cannot be disabled.

list_all_zuora_accounting_periods

List all accounting periods in Zuora. Returns each period with its id, name, startDate, endDate, fiscalYear, status, runTrialBalanceStatus, and associated file IDs.

create_a_zuora_accounting_period

Create a new accounting period in Zuora. Returns: id, success. Required: startDate, endDate, fiscalYear, name. Start and end dates must be contiguous with adjacent periods; for the first period the start date must predate the earliest transaction.

get_single_zuora_accounting_period_by_id

Get a single Zuora accounting period by id. Returns the accounting period object including its id, name, startDate, endDate, status, fiscalYear, fileIds, runTrialBalanceStatus, and audit metadata. Required: id.

update_a_zuora_accounting_period_by_id

Update a Zuora accounting period by id. Returns: processId, reasons, requestId, success. Required: id. Start and end dates must be contiguous; only the earliest period's start date can be changed, and dates cannot be updated if revenue has been distributed or active journal entries exist.

delete_a_zuora_accounting_period_by_id

Delete a Zuora accounting period by id. Returns: processId, reasons, requestId, success. Required: id. The period must be the most recent open period with no distributed revenue, no active journal entries, and not currently running a trial balance.

zuora_accounting_period_closes_bulk_update

Close a Zuora accounting period by accounting period ID. Returns: processId, reasons, requestId, success. Required: ap_id. The period cannot already be closed or running a trial balance, all earlier periods must be closed, and no required action items can remain. A trial balance is automatically run when closing.

zuora_accounting_period_pending_closes_bulk_update

Set a Zuora accounting period to pending close, which automatically runs a trial balance for that period. Returns: processId, reasons, requestId, success. Required: ap_id. The accounting period cannot already be closed or pending close, cannot be running a trial balance, and all earlier accounting periods must be closed.

zuora_accounting_period_reopens_bulk_update

Reopen a closed or pending-close accounting period in Zuora. Returns: processId, reasons, requestId, success. Required: ap_id. The accounting period must be immediately previous to an open period, and Zuora Finance must be enabled on the tenant with Manage Close Process and Run Trial Balance permissions.

zuora_accounting_period_run_trial_balances_bulk_update

Run the trial balance for a Zuora accounting period. Returns: processId, reasons, requestId, success. Required: ap_id. Processing is asynchronous — a success response indicates the trial balance has started, not completed. The accounting period must be open and not already running a trial balance.

create_a_zuora_journal_entry

Create a summary journal entry in Zuora. Returns: journalEntryNumber, success. The sum of debits must equal the sum of credits in the entry; if foreign currency aggregation is enabled, currency must match the tenant's home currency. Required: accountingPeriodName, currency, journalEntryDate, journalEntryItems.

list_all_zuora_journal_entries

Get a Zuora summary journal entry by its journal entry number. Returns: accountingPeriodName, aggregateCurrency, currency, homeCurrency, journalEntryDate, journalEntryItems, notes, number, organizationLabel, segments, status, success, timePeriodEnd, timePeriodStart, transactionType, transferDateTime, transferredBy, and 1 more. Required: je_number.

zuora_journal_entries_cancel

Cancel a summary journal entry in Zuora by journal entry number. Returns: processId, reasons, requestId, success. Required: je_number. The journal entry cannot be canceled if its Transferred to Accounting status is 'Yes' or 'Processing'.

zuora_journal_entries_bulk_delete

Delete a summary journal entry in Zuora by journal entry number. Returns: processId, reasons, requestId, success. Required: je_number. The journal entry must be canceled before it can be deleted.

list_all_zuora_journal_entries_journal_runs

List all summary journal entries in a Zuora journal run. Returns each entry's number, status, journalEntryDate, currency, journalEntryItems, segments, and accountingPeriodName. Required: jr_number.

zuora_journal_entrie_basic_informations_bulk_update

Update the basic information of a summary journal entry in Zuora by journal entry number. Returns: processId, reasons, requestId, success. Required: je_number.

create_a_zuora_journal_run

Create a journal run in Zuora. Returns: journalRunNumber, success. Required: journalEntryDate, transactionTypes.

list_all_zuora_journal_runs

Get a specific Zuora journal run by its journal run number. Returns: aggregateCurrency, executedOn, journalEntryDate, number, organizationLabels, segmentationRuleName, status, success, targetEndDate, targetStartDate, totalJournalEntryCount, transactionTypes. Required: jr_number.

zuora_journal_runs_cancel

Cancel a journal run in Zuora by its journal run number. Only runs with status Pending, Error, or Completed can be canceled; entries are canceled asynchronously so success indicates eligibility, not completion. Returns: processId, reasons, requestId, success. Required: jr_number.

zuora_journal_runs_bulk_delete

Delete a canceled journal run in Zuora by its journal run number. Only journal runs that have already been canceled can be deleted. Returns: processId, reasons, requestId, success. Required: jr_number.

create_a_zuora_bulk

Perform a mass action in Zuora by uploading a .csv file with mass-action data. Zuora returns a bulkKey and processes the action asynchronously. Returns: bulkKey, success. Max file size 4 MB. Required: file, params.

get_single_zuora_bulk_by_id

Get the result of a Zuora mass action by its bulk-key. Returns: actionType, endedOn, errorCount, inputSize, outputSize, outputType, outputURL, processedCount, startedOn, status, success, successCount, totalCount, uploadedBy, uploadedOn. Required: id.

zuora_bulks_stop

Stop a Zuora mass action by its bulk-key. You can stop a mass action when its status is Pending or Processing; records already processed are not rolled back. Returns: processId, reasons, requestId, success. Required: bulk_id.

list_all_zuora_object_query_accounts

List Zuora accounts with filtering, sorting, and field expansion. Returns each account with id, accountNumber, name, status, balance, currency, createdDate, updatedDate, and additional billing fields including autoPay, batch, billCycleDay, billToId, soldToId, paymentTerm, mrr, creditBalance, totalInvoiceBalance, totalDebitMemoBalance, unappliedBalance, and tax-related fields. Max 99 results per…

get_single_zuora_object_query_account_by_id

Get a single Zuora account by id (accepts Object ID or Account Number). Returns: id, createdById, createdDate, updatedById, updatedDate, accountNumber, additionalEmailAddresses, allowInvoiceEdit, autoPay, balance, batch, bcdSettingOption, billCycleDay, billToId, communicationProfileId, creditBalance, crmId, currency, and 51 more. Required: id.

list_all_zuora_object_query_amendments

List Zuora amendments with support for filtering, sorting, and field selection. Returns: id, createdById, createdDate, updatedById, updatedDate, autoRenew, code, contractEffectiveDate, currentTerm, currentTermPeriodType, customerAcceptanceDate, description, effectiveDate, effectivePolicy, name, newRatePlanId, removedRatePlanId, and 14 more

get_single_zuora_object_query_amendment_by_id

Get a single Zuora amendment by its Object ID or Number. Returns: id, createdById, createdDate, updatedById, updatedDate, autoRenew, code, contractEffectiveDate, currentTerm, currentTermPeriodType, customerAcceptanceDate, description, effectiveDate, effectivePolicy, name, newRatePlanId, removedRatePlanId, renewalSetting, and 13 more. Required: id.

list_all_zuora_object_query_billing_runs

List bill runs in Zuora with support for filtering, sorting, and field selection. Returns: id, createdById, createdDate, updatedById, updatedDate, billingRunNumber, billingRunType, endDate, errorMessage, executedDate, name, status, accountId, batches, billCycleDay, and 28 more. The Bill Run object does not support expanding related objects.

get_single_zuora_object_query_billing_run_by_id

Get a single bill run in Zuora by id. Returns: id, createdById, createdDate, updatedById, updatedDate, billingRunNumber, billingRunType, endDate, errorMessage, executedDate, invoiceDate, name, numberOfAccounts, numberOfInvoices, numberOfCreditMemos, postedDate, startDate, status, accountId, batches, billCycleDay, and 22 more. Required: id.

list_all_zuora_object_query_contacts

List Zuora contacts with support for filtering, sorting, and field selection. Returns each contact's id, accountId, firstName, lastName, workEmail, address1, city, state, country, createdById, createdDate, updatedById, updatedDate. Max 99 per page.

get_single_zuora_object_query_contact_by_id

Get a single Zuora contact by id. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, address1, address2, asBillTo, asShipTo, asSoldTo, city, country, county, fax, description, firstName, homePhone, lastName, mobilePhone, nickname, otherPhone, otherPhoneType, personalEmail, state, postalCode, and 3 more. Required: id.

list_all_zuora_object_query_credit_memos

List Zuora credit memos with filtering, sorting, and field selection. Returns the full credit memo object including id, accountId, status, totalAmount, currency, memoNumber, memoDate, balance, appliedAmount, and tax details.

get_single_zuora_object_query_credit_memo_by_id

Get a single Zuora credit memo by id. Returns the full credit memo object including id, accountId, status, totalAmount, currency, memoNumber, memoDate, balance, appliedAmount, and tax details. Required: id.

list_all_zuora_object_query_credit_memo_applications

List Zuora credit memo applications with support for filtering, sorting, field selection, and related-object expansion. Returns: id, createdById, createdDate, updatedById, updatedDate, amount, effectiveDate, creditMemoId, accountId, applicationGroupId, debitMemoId, invoiceId, creditMemo.

get_single_zuora_object_query_credit_memo_application_by_id

Get a single Zuora credit memo application by id. Returns: id, createdById, createdDate, updatedById, updatedDate, amount, effectiveDate, creditMemoId, accountId, applicationGroupId, debitMemoId, invoiceId, creditMemo. Required: id.

list_all_zuora_object_query_credit_memo_items

List credit memo items in Zuora with support for filtering, sorting, expanding related objects, and selecting specific fields. Returns: id, createdById, createdDate, updatedById, updatedDate, amount, description, quantity, sku, subscriptionId, chargeNumber, subscriptionNumber, revenueRecognitionRuleName, subscription, and 49 more. Max 99 per page.

get_single_zuora_object_query_credit_memo_item_by_id

Get a single credit memo item in Zuora by id. Returns: id, createdById, createdDate, updatedById, updatedDate, amount, amountWithoutTax, appliedToItemId, appliedToOthersAmount, beAppliedByOthersAmount, description, quantity, sku, subscriptionId, chargeNumber, subscriptionNumber, revenueRecognitionRuleName, subscription, and 45 more. Required: id.

list_all_zuora_object_query_daily_consumption_summaries

List daily consumption summaries in Zuora. Returns each summary with id, dailyConsumptionAmount, dailyTotalQuantity, transactionDate, usageChargeNumber, chargeSegmentNumber, and related identifiers. Supports filtering and sorting on id and updateddate.

get_single_zuora_object_query_daily_consumption_summary_by_id

Get a single daily consumption summary in Zuora by id. Returns: id, originChargeId, chargeSegmentNumber, fundId, dailyConsumptionAmount, dailyTotalQuantity, transactionDate, ratingResultId, dailyGroupSummaryId, createdById, createdDate, updatedById, updatedDate, drawdownOriginChargeId, drawdownChargeSegmentNumber, and 4 more. Required: id.

list_all_zuora_object_query_debit_memos

List debit memos in Zuora with support for filtering, expanding, and sorting results. Returns each debit memo with id, accountId, balance, totalAmount, status, memoNumber, currency, memoDate, dueDate, and tax fields. Max 99 results per page.

get_single_zuora_object_query_debit_memo_by_id

Get a single Zuora debit memo by its Object ID or Number. Returns: id, createdById, createdDate, updatedById, updatedDate, autoPay, creditMemoId, balance, billToContactId, billToContactSnapshotId, cancelledById, cancelledOn, comments, currency, discountAmount, dueDate, source, sourceType, status, accountId, account, and 30 more. Required: id.

list_all_zuora_object_query_debit_memo_items

List Zuora debit memo items with filtering, sorting, field selection, and response expansion. Returns each item with id, amount, balance, debitMemoId, chargeName, sku, quantity, unitPrice, serviceStartDate, serviceEndDate, taxAmount, and accounting code fields. Max 99 per page.

get_single_zuora_object_query_debit_memo_item_by_id

Get a single Zuora debit memo item by id. Returns: id, createdById, createdDate, updatedById, updatedDate, amount, amountWithoutTax, appliedToItemId, appliedToOthersAmount, beAppliedByOthersAmount, chargeDate, description, quantity, sku, chargeNumber, subscriptionId, subscriptionNumber, balance, subscription, and 31 more. Required: id.

list_all_zuora_object_query_delivery_adjustments

List Zuora delivery adjustments with filtering, sorting, field selection, and expansion of related objects. Returns: id, createdById, createdDate, updatedById, updatedDate, adjustmentNumber, creditMemoNumber, debitMemoNumber, creditMemoId, segmentId, chargeId, chargeNumber, subscriptionId, subscriptionNumber, originalSubId, status, and 14 more

get_single_zuora_object_query_delivery_adjustment_by_id

Get a single Zuora delivery adjustment by id (accepts ID or adjustment number). Returns: id, createdById, createdDate, updatedById, updatedDate, adjustmentNumber, creditMemoNumber, debitMemoNumber, creditMemoId, segmentId, chargeId, chargeNumber, subscriptionId, subscriptionNumber, originalSubId, status, and 24 more. Required: id.

list_all_zuora_object_query_fulfillments

List Zuora fulfillment objects with support for filtering, sorting, field selection, and response expansion. Returns: id, createdById, createdDate, updatedById, updatedDate, orderLineItemId, fulfillmentNumber, fulfillmentType, fulfillmentDate, quantity, state, trackingNumber, billTargetDate, description, carrier, fulfillmentLocation, and 4 more

get_single_zuora_object_query_fulfillment_by_id

Retrieve a single Zuora fulfillment by its ID or fulfillment number. Returns: id, createdById, createdDate, updatedById, updatedDate, orderLineItemId, fulfillmentNumber, fulfillmentType, fulfillmentDate, quantity, state, trackingNumber, billTargetDate, description, carrier, fulfillmentLocation, fulfillmentSystem, and 3 more. Required: id.

list_all_zuora_object_query_invoices

List Zuora invoices with support for filtering, sorting, expanding related objects, and selecting specific fields. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, adjustmentAmount, amount, amountWithoutTax, autoPay, balance, billToContactId, billToContactSnapshotId, comments, creditBalanceAdjustmentAmount, and 46 more

get_single_zuora_object_query_invoice_by_id

Get a single Zuora invoice by id (accepts Object ID or invoice number). Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, adjustmentAmount, amount, amountWithoutTax, autoPay, balance, billToContactId, billToContactSnapshotId, comments, creditBalanceAdjustmentAmount, creditMemoAmount, currency, and 42 more. Required: id.

list_all_zuora_object_query_invoice_items

List Zuora invoice items with filtering, sorting, and field selection. Returns each item with id, chargeAmount, chargeNumber, invoiceId, subscriptionId, unitPrice, quantity, serviceStartDate, serviceEndDate, balance, and additional billing/accounting fields. Required: filter[]. You must specify at least one filter[] condition; without it Zuora returns an error.

get_single_zuora_object_query_invoice_item_by_id

Get a single Zuora invoice item by id. Returns the full invoice item object including id, chargeAmount, chargeNumber, invoiceId, subscriptionId, unitPrice, quantity, serviceStartDate, serviceEndDate, balance, and additional billing/accounting fields. Required: id.

list_all_zuora_object_query_invoice_schedules

List invoice schedules in Zuora with support for filtering, sorting, field selection, and expansion of related objects. Returns: id, createdById, createdDate, updatedById, updatedDate, totalAmount, actualAmount, billedAmount, unbilledAmount, nextRunDate, number, notes, accountId, status, additionalSubscriptionsToBill, currency, and 3 more. Max…

get_single_zuora_object_query_invoice_schedule_by_id

Retrieve a specific invoice schedule in Zuora by its object ID or number. Returns: id, createdById, createdDate, updatedById, updatedDate, totalAmount, actualAmount, billedAmount, unbilledAmount, nextRunDate, number, notes, accountId, status, additionalSubscriptionsToBill, currency, invoiceScheduleItems, and 2 more. Required: id.

list_all_zuora_object_query_order_actions

List Zuora order actions with support for filtering, sorting, field selection, and response expansion. Returns: id, createdById, createdDate, updatedById, updatedDate, contractEffectiveDate, customerAcceptanceDate, type, sequence, subscriptionVersionAmendmentId, subscriptionId, subscriptionNumber, subscription, order, and 30 more. Max 99 per page.

get_single_zuora_object_query_order_action_by_id

Get a single Zuora order action by id. Returns: id, createdById, createdDate, updatedById, updatedDate, contractEffectiveDate, customerAcceptanceDate, type, sequence, subscriptionVersionAmendmentId, orderId, subscriptionId, subscriptionNumber, serviceActivationDate, autoRenew, renewSetting, subscription, order, and 26 more. Required: id.

list_all_zuora_object_query_order_line_items

List Zuora order line items with filtering, sorting, field selection, and optional expansion of related objects. Returns each item's id, amount, currency, quantity, itemName, itemState, itemType, orderId, orderNumber, createdDate, updatedDate, and additional billing, revenue, and fulfillment fields. Max 99 results per page.

get_single_zuora_object_query_order_line_item_by_id

Get a single Zuora order line item by its object ID or number. Returns: id, createdById, createdDate, updatedById, updatedDate, accountingCode, billTargetDate, amountPerUnit, description, amount, amountWithoutTax, itemName, itemNumber, itemState, itemType, listPricePerUnit, listPrice, quantity, uOM, discount, currency, and 50 more. Required: id.

list_all_zuora_object_query_orders

List Zuora orders with support for filtering, expanding related objects, and sorting. Returns: id, createdById, createdDate, updatedById, updatedDate, description, orderDate, orderNumber, accountId, status, state, createdByMigration, category, invoiceScheduleId, scheduledDate, scheduledDatePolicy, errorCode, errorMessage, response, and 14 more

get_single_zuora_object_query_order_by_id

Get a single Zuora order by its object ID or order number. Returns: id, createdById, createdDate, updatedById, updatedDate, description, orderDate, orderNumber, accountId, status, state, createdByMigration, category, invoiceScheduleId, scheduledDate, scheduledDatePolicy, errorCode, errorMessage, response, account, and 3 more. Required: id.

list_all_zuora_object_query_payments

List Zuora payments with support for filtering, sorting, expanding related objects, and selecting specific fields. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, accountingCode, amount, appliedAmount, authTransactionId, appliedCreditBalanceAmount, bankIdentificationNumber, cancelledOn, comment, currency, and 36 more

get_single_zuora_object_query_payment_by_id

Get a single Zuora payment by id (Object ID or Number). Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, accountingCode, amount, appliedAmount, authTransactionId, appliedCreditBalanceAmount, bankIdentificationNumber, cancelledOn, comment, currency, effectiveDate, gatewayOrderId, and 34 more. Required: id.

list_all_zuora_object_query_payment_applications

List Zuora payment applications with support for filtering, sorting, field selection, and expansion. Returns: id, createdById, createdDate, updatedById, updatedDate, applyAmount, effectiveDate, paymentApplicationStatus, accountId, paymentId, invoiceId, applicationGroupId, debitMemoId, billingDocumentOwnerId, payment, and 4 more. Max 99 per page.

get_single_zuora_object_query_payment_application_by_id

Get a single Zuora payment application by id. Returns the full payment application object including id, accountId, paymentId, invoiceId, applyAmount, paymentApplicationStatus, effectiveDate, createdDate, and updatedDate. Required: id.

list_all_zuora_object_query_payment_methods

List payment methods in Zuora with support for filtering, sorting, and field selection. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, achAbaCode, achAccountName, achAccountNumberMask, achAccountType, achAddress1, achAddress2, achBankName, active, city, country, email, name, phone, state, type, account, and 75 more.

get_single_zuora_object_query_payment_method_by_id

Get a single Zuora payment method by id. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, achAbaCode, achAccountName, achAccountNumberMask, achAccountType, achAddress1, achAddress2, achBankName, achCity, achCountry, achPostalCode, active, city, country, email, name, phone, state, type, account, and 72 more. Required: id.

list_all_zuora_object_query_payment_method_snapshots

List payment method snapshots in Zuora, with support for filtering, sorting, and field selection. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, active, city, country, email, name, phone, state, type, and 76 more. Required: filter[]. A filter[] query parameter must be specified to query payment method snapshots.

get_single_zuora_object_query_payment_method_snapshot_by_id

Get a specific payment method snapshot by id in Zuora. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, achAbaCode, achAccountName, achAccountNumberMask, achAccountType, achAddress1, achAddress2, achBankName, achCity, achCountry, active, city, country, email, name, phone, state, type, and 67 more. Required: id.

list_all_zuora_object_query_payment_runs

List Zuora payment runs with support for filtering, sorting, and field selection. Returns: id, createdById, createdDate, updatedById, updatedDate, endDate, executedDate, numberOfCreditBalanceAdjustments, numberOfErrors, numberOfInvoices, numberOfPayments, numberOfUnprocessed, status, accountId, batch, currency, and 26 more. Max 99 results per page.

get_single_zuora_object_query_payment_run_by_id

Retrieve a single Zuora payment run by its Object ID or Number. Returns: id, createdById, createdDate, updatedById, updatedDate, endDate, executedDate, numberOfCreditBalanceAdjustments, numberOfErrors, numberOfInvoices, numberOfPayments, numberOfUnprocessed, paymentRunNumber, status, accountId, batch, currency, and 25 more. Required: id.

list_all_zuora_object_query_payment_schedules

List payment schedules in Zuora with filtering, sorting, and field selection. Returns: id, createdById, createdDate, updatedById, updatedDate, number, accountId, invoiceId, debitmemoId, paymentOptionId, startDate, runHour, period, prepayment, occurrences, status, description, nextPaymentDate, recentPaymentDate, and 3 more. Max 99 per page.

get_single_zuora_object_query_payment_schedule_by_id

Retrieve a single Zuora payment schedule by its object ID or number. Returns: id, createdById, createdDate, updatedById, updatedDate, number, accountId, invoiceId, debitmemoId, paymentOptionId, startDate, runHour, period, prepayment, occurrences, status, description, nextPaymentDate, recentPaymentDate, and 3 more. Required: id.

list_all_zuora_object_query_payment_schedule_items

List Zuora payment schedule items with filtering, sorting, and field selection. Returns: id, createdById, createdDate, updatedById, updatedDate, number, accountId, invoiceId, debitmemoId, paymentOptionId, prepayment, scheduledDate, runHour, paymentMethodId, paymentGatewayId, amount, balance, currency, status, errorMessage, and 4 more. Max 99 per…

get_single_zuora_object_query_payment_schedule_item_by_id

Get a single Zuora payment schedule item by id or number. Returns the full payment schedule item object including id, accountId, amount, balance, currency, status, scheduledDate, paymentScheduleId, number, invoiceId, debitmemoId, paymentId, prepayment, runHour, description, cancellationReason, createdById, createdDate, updatedById, and updatedDate. Required: id.

list_all_zuora_object_query_prepaid_balances

List Zuora prepaid balances with filtering, sorting, expanding related objects, and field selection. Returns: id, createdById, createdDate, updatedById, updatedDate, name, totalFund, balance, endDate, startDate, accountId, origSubscriptionId, uOM, prepaidBalanceState, prepaidType, account, origSubscription. Max 99 per page.

get_single_zuora_object_query_prepaid_balance_by_id

Retrieve a single Zuora prepaid balance by id. Returns: id, createdById, createdDate, updatedById, updatedDate, name, totalFund, balance, endDate, startDate, accountId, origSubscriptionId, uOM, prepaidBalanceState, prepaidType, account, origSubscription. Required: id.

list_all_zuora_object_query_prepaid_balance_funds

List Zuora prepaid balance funds with support for filtering, sorting, field selection, and expansion of related objects. Returns each fund with id, accountId, balance, fundSourceType, fundedBalance, fundingPrice, prepaidBalanceId, priority, rolloverApplyOption, startDate, endDate, and vpSummaryId. Max 99 per page.

get_single_zuora_object_query_prepaid_balance_fund_by_id

Get a single Zuora prepaid balance fund by id. Returns the fund object including id, accountId, balance, fundSourceType, fundedBalance, fundingPrice, prepaidBalanceId, priority, rolloverApplyOption, startDate, endDate, and vpSummaryId. Required: id.

list_all_zuora_object_query_prepaid_balance_transactions

List Zuora prepaid balance transactions with support for filtering, expanding, and sorting. Returns each transaction with id, accountId, prepaidBalanceId, fundId, sourceId, amount, balance, transactionDate, transactionSourceType, prepaidBalanceTransactionType, createdById, createdDate, updatedById, and updatedDate. Max 99 per page.

get_single_zuora_object_query_prepaid_balance_transaction_by_id

Get a single Zuora prepaid balance transaction by id. Returns the transaction object including id, accountId, prepaidBalanceId, fundId, sourceId, amount, balance, transactionDate, transactionSourceType, prepaidBalanceTransactionType, createdById, createdDate, updatedById, and updatedDate. Required: id.

list_all_zuora_object_query_processed_usages

List processed usage records in Zuora with filtering, sorting, and field expansion. Returns: id, createdById, createdDate, updatedById, updatedDate, usageId, amount, billingPeriodEndDate, billingPeriodStartDate, invoiceItemId, creditMemoItemId, ratePlanChargeId, usage, invoiceItem, creditMemoItem. Max 99 results per page.

get_single_zuora_object_query_processed_usage_by_id

Get a single processed usage record in Zuora by id. Returns: id, createdById, createdDate, updatedById, updatedDate, usageId, amount, billingPeriodEndDate, billingPeriodStartDate, invoiceItemId, creditMemoItemId, ratePlanChargeId, usage, invoiceItem, creditMemoItem. Required: id.

list_all_zuora_object_query_products

List Zuora products with optional filtering, sorting, field selection, and expansion of related objects such as rate plans and charges. Returns each product's id, name, sKU, productNumber, effectiveStartDate, effectiveEndDate, description, allowFeatureChanges, createdById, createdDate, updatedById, and updatedDate.

get_single_zuora_object_query_product_by_id

Retrieve a single Zuora product by its ID or SKU. Returns: id, createdById, createdDate, updatedById, updatedDate, allowFeatureChanges, description, name, effectiveEndDate, effectiveStartDate, sKU, productNumber, category, productRatePlans. Required: id.

list_all_zuora_object_query_product_rate_plans

List Zuora product rate plans with support for filtering, sorting, field selection, and expanding related objects. Returns: id, createdById, createdDate, updatedById, updatedDate, productId, name, description, effectiveStartDate, effectiveEndDate, grade, productRatePlanNumber, product, productRatePlanCharges. Max 99 results per page.

get_single_zuora_object_query_product_rate_plan_by_id

Get a single Zuora product rate plan by id. Returns: id, createdById, createdDate, updatedById, updatedDate, productId, name, description, effectiveStartDate, effectiveEndDate, grade, productRatePlanNumber, product, productRatePlanCharges. Required: id.

list_all_zuora_object_query_product_rate_plan_charges

List Zuora product rate plan charges with support for filtering, expanding, and sorting. Returns each charge with id, name, chargeModel, chargeType, productRatePlanChargeNumber, productRatePlanId, createdDate, updatedDate, defaultQuantity, accountingCode, taxable, triggerEvent, uOM. Max 99 per page.

get_single_zuora_object_query_product_rate_plan_charge_by_id

Get a single Zuora product rate plan charge by id. Returns: id, createdById, createdDate, updatedById, updatedDate, accountingCode, applyDiscountTo, chargeFunction, isAllocationEligible, isUnbilled, applyToBillingPeriodPartially, billCycleDay, billCycleType, billingPeriod, billingPeriodAlignment, billingTiming, and 72 more. Required: id.

list_all_zuora_object_query_product_rate_plan_charge_tiers

List Zuora product rate plan charge tiers with filtering, sorting, and field selection. Returns each tier with id, currency, price, priceFormat, tier, active, isDefault, startingUnit, endingUnit, productRatePlanChargeId, createdDate, and updatedDate. Max 99 per page.

get_object_query_product_rate_plan_charge_tier_by_id

Get a single Zuora product rate plan charge tier by id. Returns the tier object including id, currency, price, priceFormat, tier, active, isDefault, startingUnit, endingUnit, productRatePlanChargeId, createdDate, updatedDate, createdById, and updatedById. Required: id.

list_all_zuora_object_query_ramps

List Ramp objects in Zuora with filtering, expansion, and sorting. Returns each ramp's id, number, grossTcb, grossTcv, netTcb, netTcv, metricsProcessingStatus, orderId, chargeNumbers, and subscriptionNumbers. Max 99 per page.

get_single_zuora_object_query_ramp_by_id

Get a single Ramp object in Zuora by its ID or number. Returns: id, createdById, createdDate, updatedById, updatedDate, name, number, description, subscriptionNumbers, chargeNumbers, orderId, grossTcb, grossTcv, netTcb, netTcv, discountTcb, discountTcv, metricsProcessingStatus. Required: id.

list_all_zuora_object_query_rate_plans

List Zuora rate plans with optional filtering, sorting, and field selection. Returns: id, createdById, createdDate, updatedById, updatedDate, productId, amendmentId, amendmentType, name, productRatePlanId, subscriptionId, subscriptionOwnerId, invoiceOwnerId, reverted, externallyManagedPlanId, originalRatePlanId, subscriptionOfferId, and 4 more

get_single_zuora_object_query_rate_plan_by_id

Get a single Zuora rate plan by id. Returns: id, createdById, createdDate, updatedById, updatedDate, productId, amendmentId, amendmentType, name, productRatePlanId, subscriptionId, subscriptionOwnerId, invoiceOwnerId, reverted, externallyManagedPlanId, originalRatePlanId, subscriptionOfferId, subscriptionRatePlanNumber, and 3 more. Required: id.

list_all_zuora_object_query_rate_plan_charges

List Zuora rate plan charges with filtering, sorting, field selection, and expansion of related objects. Returns per charge: id, name, chargeNumber, chargeModel, chargeType, ratePlanId, productRatePlanChargeId, billingPeriod, effectiveStartDate, effectiveEndDate, mRR, tCV, dMRC, dTCV, createdDate, updatedDate. Required: filter[]. A filter[] query parameter is mandatory.

get_single_zuora_object_query_rate_plan_charge_by_id

Get a single Zuora rate plan charge by id. Returns: id, createdById, createdDate, updatedById, updatedDate, ratePlanId, productRatePlanChargeId, accountingCode, applyDiscountTo, billCycleDay, billCycleType, billingPeriod, billingPeriodAlignment, billingTiming, chargedThroughDate, chargeModel, chargeNumber, chargeType, and 77 more. Required: id.

list_all_zuora_object_query_rate_plan_charge_tiers

List Zuora rate plan charge tiers with filter, sort, expand, and field selection. Returns: currency, discountAmount, discountPercentage, endingUnit, includedUnits, overagePrice, price, priceFormat, startingUnit, tier, id, createdById, createdDate, updatedById, updatedDate, ratePlanChargeId, ratePlanCharge. Required: filter[].

get_single_zuora_object_query_rate_plan_charge_tier_by_id

Get a specific Zuora rate plan charge tier by id. Returns: currency, discountAmount, discountPercentage, endingUnit, includedUnits, overagePrice, price, priceFormat, startingUnit, tier, id, createdById, createdDate, updatedById, updatedDate, ratePlanChargeId, ratePlanCharge. Required: id, filter[].

list_all_zuora_object_query_rating_results

List Zuora rating results with support for filtering, sorting, and field selection. Returns: id, createdByID, createdDate, updatedByID, updatedDate, accountId, subscriptionId, ratePlanChargeId, quantity, amount, serviceStartDate, serviceEndDate, status, isPartial, chargeSegmentNumber, invoiceItemId, actualPeriodStartDate, and 6 more

get_single_zuora_object_query_rating_result_by_id

Get a single Zuora rating result by id. Returns: id, createdByID, createdDate, updatedByID, updatedDate, accountId, subscriptionId, ratePlanChargeId, quantity, amount, serviceStartDate, serviceEndDate, status, isPartial, chargeSegmentNumber, invoiceItemId, actualPeriodStartDate, actualPeriodEndDate, billingCycleDay, and 4 more. Required: id.

list_all_zuora_object_query_refunds

List Zuora refunds with support for filtering, sorting, field selection, and expansion of related objects. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, amount, cancelledOn, comment, paymentMethodSnapshotId, accountingCode, currency, gatewayReconciliationReason, gatewayReconciliationStatus, gatewayResponse, and 25 more

get_single_zuora_object_query_refund_by_id

Get a single Zuora refund by id. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, amount, cancelledOn, comment, paymentMethodSnapshotId, accountingCode, currency, gatewayReconciliationReason, gatewayReconciliationStatus, gatewayResponse, gatewayResponseCode, gatewayState, markedForSubmissionOn, and 22 more. Required: id.

list_all_zuora_object_query_refund_applications

List Zuora refund applications with support for filtering, expanding related objects, and sorting. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, applicationGroupId, applyAmount, creditMemoId, effectiveDate, invoiceId, paymentId, refundId, refund, payment, and 6 more. Max 99 results per page.

get_single_zuora_object_query_refund_application_by_id

Get a single Zuora refund application by id. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, applicationGroupId, applyAmount, creditMemoId, effectiveDate, invoiceId, paymentId, refundId, accountReceivableAccountingCodeId, onAccountAccountingCodeId, refund, payment, and 4 more. Required: id.

list_all_zuora_object_query_refund_application_items

List Zuora refund application items with support for filtering, sorting, field selection, and expanding related refund application objects. Returns: id, createdById, createdDate, updatedById, updatedDate, amount, effectiveDate, applicationGroupId, refundApplicationId, accountReceivableAccountingCodeId, and 7 more. Max 99 per page.

get_single_zuora_object_query_refund_application_item_by_id

Retrieve a refund application item. Returns: id, createdById, createdDate, updatedById, updatedDate, amount, effectiveDate, applicationGroupId, refundApplicationId, accountReceivableAccountingCodeId, onAccountAccountingCodeId, unappliedPaymentAccountingCodeId, cashAccountingCodeId, journalEntryId, creditTaxationItemId, and 2 more. Required: id.

list_all_zuora_object_query_summarystatementruns

List Zuora summary statement runs with support for filtering, sorting, field selection, and null-field inclusion. Returns each run with id, accountId, status, statementNumber, statementRunId, emailStatus, startDate, endDate, statementDate, createdDate, updatedDate, and success.

get_single_zuora_object_query_summarystatementrun_by_id

Get a single Zuora summary statement run by its statement run ID or number. Returns: accountId, autoEmailEnabled, batchName, billCycleDay, createdDate, updatedDate, createdById, updatedById, dateRangeType, deleted, description, endDate, id, numberOfAccounts, runType, startDate, statementRunNumber, status, and 8 more. Required: id.

list_all_zuora_object_query_summarystatements

List Zuora summary statements with optional filtering, sorting, field selection, and related-object expansion. Returns: accountId, autoEmailEnabled, description, batchName, billCycleDay, dateRangeType, runType, createdById, endDate, id, startDate, emailStatus, statementDate, statementNumber, status, success, and 10 more. Max 99 per page.

get_single_zuora_object_query_summarystatement_by_id

Retrieve a Zuora summary statement by id or statement number. Returns: accountId, autoEmailEnabled, description, batchName, billCycleDay, dateRangeType, runType, createdById, createdDate, deleted, endDate, fileId, id, startDate, emailStatus, statementDate, statementNumber, statementRunNumber, status, success, and 6 more. Required: id.

list_all_zuora_object_query_subscriptions

List Zuora subscriptions with options to filter, expand related objects, sort, and select returned fields. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, autoRenew, cancelledDate, contractAcceptanceDate, contractEffectiveDate, name, renewalSetting, status, termEndDate, termStartDate, version, cMRR, and 50 more.

get_single_zuora_object_query_subscription_by_id

Get a single Zuora subscription by id, accepting either the subscription Object ID or Number. Returns the subscription record including id, accountId, name, status, termStartDate, termEndDate, and version. Required: id.

list_all_zuora_object_query_taxation_items

List Zuora taxation items with optional filtering, sorting, and field selection. Returns: id, createdById, createdDate, updatedById, updatedDate, creditAmount, accountingCode, exemptAmount, invoiceItemId, jurisdiction, name, taxAmount, taxMode, taxDate, taxRateType, balance, periodEndDate, periodStartDate, and 20 more. Max 99 results per page.

get_single_zuora_object_query_taxation_item_by_id

Get a single Zuora taxation item by its object ID or number. Returns: id, createdById, createdDate, updatedById, updatedDate, creditAmount, accountingCode, exemptAmount, invoiceItemId, jurisdiction, locationCode, name, paymentAmount, taxAmount, taxMode, taxDate, taxRateType, balance, periodEndDate, periodStartDate, and 16 more. Required: id.

list_all_zuora_object_query_usages

List Zuora usage records with support for filtering, sorting, and field selection. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, accountNumber, ratePlanChargeId, endDateTime, productRatePlanChargeId, quantity, rbeStatus, sourceType, startDateTime, subscriptionId, submissionDateTime, uOM, and 6 more. Max 99 per page.

get_single_zuora_object_query_usage_by_id

Get a single Zuora usage record by id. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, accountNumber, ratePlanChargeId, endDateTime, productRatePlanChargeId, quantity, rbeStatus, sourceType, startDateTime, subscriptionId, submissionDateTime, uOM, description, importId, uniqueKey, fileId, fileName, account. Required: id.

list_all_zuora_object_query_validity_period_summaries

List Zuora validity period summaries with support for filtering, sorting, field selection, and expanding related objects. Returns: id, createdById, createdDate, updatedById, updatedDate, prepaidBalanceId, startDate, endDate, totalBalance, remainingBalance, totalBilledAmount, billedBalanceAmount, subscriptionNumber, uom, accountNumber, and 6 more

get_single_zuora_object_query_validity_period_summary_by_id

Get a single Zuora validity period summary by id. Returns: id, createdById, createdDate, updatedById, updatedDate, prepaidBalanceId, startDate, endDate, totalBalance, remainingBalance, totalBilledAmount, billedBalanceAmount, subscriptionNumber, uom, accountNumber, accountId, and 5 more. Use expand[] to include related account…. Required: id.

list_all_zuora_object_queries

List Zuora custom object records for a given custom object type. Returns records with id, createdById, createdDate, updatedById, updatedDate, plus any custom fields defined on the object type. Required: custom_object_name. Sorting by ID is not supported.

get_single_zuora_object_query_by_id

Get a single Zuora custom object record by id. Returns: id, createdById, createdDate, updatedById, updatedDate, CreatedById, CreatedDate, Description, EffectiveEndDate, EffectiveStartDate, Id, Name, SKU, UpdatedById, UpdatedDate. Required: custom_object_name, id.

list_all_zuora_object_query_contact_snapshots

List Zuora contact snapshots with support for filtering, sorting, field selection, and expansion of related objects. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, contactId, firstName, lastName, nickName, address1, address2, city, state, postalCode, county, country, taxRegion, description, homePhone, and 7 more

get_single_zuora_object_query_contact_snapshot_by_id

Get a single Zuora contact snapshot by id. Returns: id, createdById, createdDate, updatedById, updatedDate, accountId, contactId, firstName, lastName, nickName, address1, address2, city, state, postalCode, county, country, taxRegion, description, homePhone, otherPhone, otherPhoneType, fax, personalEmail, workEmail, and 2 more. Required: id.

list_all_zuora_object_query_rating_details

List Zuora rating details with optional filtering and sorting. Returns: id, invoiceItemId, creditMemoItemId, chargeType, chargeModel, formula, calculation, calculatedAmount, currency, unitOfMeasure, quantity, billedQuantity, listPriceBase, billingPeriod, validityPeriodType, billingPeriodAlignment, creditOption, and 43 more. Max 99 per page.

get_single_zuora_object_query_rating_detail_by_id

Get a single Zuora rating detail by id. Returns: id, invoiceItemId, creditMemoItemId, chargeType, chargeModel, formula, calculation, calculatedAmount, currency, unitOfMeasure, quantity, billedQuantity, billedAmount, isProration, listPriceBase, billingPeriod, validityPeriodType, billingPeriodAlignment, creditOption, and 41 more. Required: id.

list_all_zuora_test_environments

List all Zuora test environments. Returns: result, size.

get_single_zuora_test_environment_by_id

Get a single Zuora test environment by its unique identifier. Returns: id, status, created_at, updated_at. Required: id.

list_all_zuora_test_environment_jobs

List all jobs for a Zuora test environment. Returns: result, size. Required: test_environment_id.

create_a_zuora_test_environment_job

Create a new refresh job for a Zuora test environment. Returns the created job including id, objectId, objectType, operationType, status, and success. Required: test_environment_id. Only one refresh can be performed during a set period.

get_single_zuora_test_environment_job_by_id

Get a specific Zuora test environment job by id. Returns: id, status, objectId, objectType, operationType, success. Required: id.

create_a_zuora_job_action

Perform a specified action on a Zuora test environment job. Returns a JobResponse reflecting the updated job state including id, status, operation, createdDate, and updatedDate. Required: test_environment_id, job_id, and a JobActionRequest body.

list_all_zuora_test_environment_notifications

List all email notifications for a Zuora test environment. Returns each notification with id, name, active, description, eventTypeName, emailSubject, emailBody, createdBy, createdOn, updatedBy, updatedOn. Required: test_environment_id.

create_a_zuora_test_environment_notification

Create a new email notification for a Zuora test environment. Returns: address, id, name, testEnvironmentId, active, description, eventTypeName, eventCategory, emailSubject, emailBody, emailHeaders, encodingType, isHtml, fromName, fromEmailType, fromEmailAddress, replyToEmailType, toEmailType, toEmailAddress, ccEmailAddress, ccEmailType, and 5 more

update_a_zuora_test_environment_notification_by_id

Update an existing email notification for a Zuora test environment. Returns the updated notification object including id, name, active, eventTypeName, emailSubject, emailBody, createdBy, createdOn, updatedBy, updatedOn. Required: id.

delete_a_zuora_test_environment_notification_by_id

Delete a specific notification from a Zuora test environment. Returns the deleted notification object including id, name, active, eventTypeName, createdBy, createdOn, updatedBy, updatedOn. Required: id. Returns a 404 error if the notification does not exist.

get_single_zuora_test_environment_notification_by_id

Get a specific Zuora test environment notification by id. Returns the notification object including id, name, active, description, eventTypeName, emailSubject, emailBody, createdBy, createdOn, updatedBy, updatedOn. Required: id. Returns a 404 error if the notification does not exist.

zuora_audit_global_logins_search

Search global login events in Zuora with date-range and optional filter conditions. Returns: count, firstPageToken, lastPageToken, nextToken, previousToken, totalPages, and 2 more. The request body must include a dateRange object with startDate and endDate; filter, sort, and pagination are optional. No filter is required for global login queries.

zuora_audit_global_settings_search

Search Zuora global setting change events within a date range. Returns: count, firstPageToken, lastPageToken, nextToken, previousToken, totalPages, totalElements, events. Required: dateRange. No filter is required for global setting queries.

zuora_audit_tenant_logins_search

Search tenant login audit events in Zuora with date range and filter conditions. Returns events including eventId, timestamp, username, status, and action, with totalElements and count. Required: filter (must include a tenantId condition in filter.must).

zuora_audit_tenant_settings_search

Search Zuora tenant setting change events by date range and filter conditions. Returns: count, firstPageToken, lastPageToken, nextToken, previousToken, totalPages, totalElements, events. Required: filter with tenantId in filter.must.

zuora_audit_tenant_objects_search

Search tenant-level object change events in Zuora with page-number based pagination. Requires a `tenantId` filter condition in the `filter.must` array of the request body. Returns events with fields including eventId, timestamp, username, userId, action, actionDetails, objectType, objectId, objectname, tenantId, namespace, changetype, itemtype, itemid, and transactionid, along with pagination…

list_all_zuora_data_global_users

List global users in Zuora with pagination. Returns a data array of user records including userId, userName, firstName, lastName, status, workEmail, ssoEnabled, oneIdRole, createdOn, userGroups, and lastLogin, plus totalElements and hasNext pagination metadata. Supports optional filtering by status and sorting.

list_all_zuora_data_global_roles

List Zuora global roles at the organization level. Returns each role with roleSetId, roleName, description, appType, status, roleType, organizationId, permissionGroupIds, globalRoleIds, createdOn, and updatedOn. Supports sorting by field and direction.

list_all_zuora_data_tenant_roles

List tenant-specific roles in Zuora filtered by tenant entity ID. Returns: roleSetId, roleName, description, appType, entityId, organizationId, status, roleType, sourceType, permissionGroupIds, globalRoleIds, createdOn, updatedOn, createdByUsername, example. Required: entityId.

list_all_zuora_data_tenant_roles_permissions

List tenant-specific roles with full permission details in Zuora. Returns: roleSetId, roleName, description, appType, entityId, status, roleType, createdOn, updatedOn, permissions, example. Required: entityId.

list_all_zuora_events_event_triggers

List event triggers in Zuora, optionally filtered by base object, event type name, or active status. Returns: active, baseObject, condition, description, eventType, id. Default 10 records per page.

create_a_zuora_events_event_trigger

Create an event trigger in Zuora by specifying a base object and a JEXL trigger condition. Returns: active, baseObject, condition, description, eventType, id. Required: baseObject, condition, eventType.

get_single_zuora_events_event_trigger_by_id

Get a single Zuora event trigger by id. Returns: active, baseObject, condition, description, eventType, id. Required: id.

update_a_zuora_events_event_trigger_by_id

Update a Zuora event trigger by id. Returns: active, baseObject, condition, description, eventType, id. Required: id, baseObject.

delete_a_zuora_events_event_trigger_by_id

Delete a Zuora event trigger by id. Returns an empty 204 response on success. Required: id.

list_all_zuora_events_scheduled_events

List all scheduled events in Zuora, filterable by event type name, base object, base field, and active status. Returns: active, apiField, apiObject, condition, cronExpression, description, displayName, id, name, namespace, eventTypeName.

create_a_zuora_events_scheduled_event

Create a custom scheduled event in Zuora. You must specify the base object, the base field, and the scheduled time in the request body. Returns the created scheduled event including its id, eventTypeName, and active status. Required: base object, base field, and scheduled time.

get_single_zuora_events_scheduled_event_by_id

Retrieve a scheduled event by ID. Returns: active, apiField, apiObject, condition, cronExpression, description, displayName, id, name, namespace. Required: id.

update_a_zuora_events_scheduled_event_by_id

Update a scheduled event in Zuora by id. Returns the updated scheduled event object including its id, baseObject, baseField, scheduledTime, active, description, condition, and eventType. Required: id.

delete_a_zuora_events_scheduled_event_by_id

Delete a Zuora scheduled event by id. Returns an empty 204 response on success. Required: id.

list_all_zuora_notifications_notification_definitions

List Zuora notification definitions with optional filters by profile, event category, event type name, or email template. Returns each definition's id, name, active, eventTypeName, emailActive, emailTemplateId, communicationProfileId, createdBy, createdOn. eventCategory and eventTypeName are mutually exclusive filters. Max 100 results per page.

create_a_zuora_notifications_notification_definition

Create a notification definition in Zuora for standard or custom events. Returns the created definition including id, name, active, eventTypeName, emailActive, emailTemplateId, communicationProfileId, filterRule, createdBy, createdOn. Required: name. eventCategory and eventTypeName are mutually exclusive; exactly one must be specified.

get_single_zuora_notifications_notification_definition_by_id

Retrieve a notification definition. Returns: active, associatedAccount, callout, calloutActive, calloutTemplateIds, communicationProfileId, communicationProfileIds, createdBy, createdOn, description, emailActive, emailTemplateId, eventCategory, eventId, eventTypeName, eventTypeNamespace, filterRule, filterRuleParams, id, and 3 more. Required: id.

update_a_zuora_notifications_notification_definition_by_id

Update a notification definition. Returns: active, associatedAccount, callout, calloutActive, calloutTemplateIds, communicationProfileId, communicationProfileIds, createdBy, createdOn, description, emailActive, emailTemplateId, eventCategory, eventId, eventTypeName, eventTypeNamespace, filterRule, filterRuleParams, id, and 3 more. Required: id.

delete_a_zuora_notifications_notification_definition_by_id

Delete a Zuora notification definition by id. Returns an empty 204 response on success. Required: id.

create_a_zuora_email_templates_import

Create or update Zuora email templates for standard or custom events; templates without an id are created, while those with a valid id are updated. Returns a JSON success response. Required: emailTemplates. Max 1,000 email templates per call.

list_all_zuora_notifications_email_templates

List email templates in Zuora. Returns: id, created_at, updated_at.

create_a_zuora_notifications_email_template

Create an email template in Zuora. Returns: id, created_at, updated_at.

get_single_zuora_notifications_email_template_by_id

Get an email template by id in Zuora. Returns: id, created_at, updated_at. Required: id.

update_a_zuora_notifications_email_template_by_id

Update an email template by id in Zuora. Returns: id, created_at, updated_at. Required: id.

delete_a_zuora_notifications_email_template_by_id

Delete an email template by id in Zuora. Returns an empty 204 response on success. Required: id.

create_a_zuora_callout_templates_import

Create or update callout templates. Returns: reasons.

list_all_zuora_notifications_callout_templates

List Zuora callout templates with optional filtering by event category, event type name, or template name. Returns: active, calloutAuth, calloutBaseurl, calloutHeaders, calloutParams, calloutRetry, certificate, confirmSuccessFromResponseContent, contentType, createdBy, createdOn, customRequestBody, description, eventCategory, and 17 more

create_a_zuora_notifications_callout_template

Create a Zuora callout template for a standard or custom event. Returns the created template including id, name, eventTypeName, calloutBaseurl, httpMethod, active, and contentType. Required: name, calloutBaseurl, httpMethod, and either eventCategory or eventTypeName (but not both).

get_single_zuora_notifications_callout_template_by_id

Get a single Zuora callout template by id. Returns the full template object including id, name, eventTypeName, calloutBaseurl, httpMethod, active, calloutRetry, and HMAC configuration fields. Required: id.

update_a_zuora_notifications_callout_template_by_id

Update a Zuora callout template by id. Returns the updated template including id, name, calloutBaseurl, httpMethod, active, and contentType. Required: id, name, calloutBaseurl, httpMethod.

delete_a_zuora_notifications_callout_template_by_id

Delete a Zuora callout template by id. Returns an empty 204 response on success. Required: id.

create_a_zuora_reusable_blocks_import

Create or update reusable blocks. Returns: reasons.

list_all_zuora_notifications_reusable_blocks

List Zuora notification reusable blocks, optionally filtered by category, name, active status, and tags. Returns: active, category, content, createdBy, createdOn, id, name, number, tags, updatedBy, updatedOn. Max 5000 results per page.

create_a_zuora_notifications_reusable_block

Create a reusable block for Zuora email notification templates, such as headers or footers. Returns: active, category, content, createdBy, createdOn, id, name, number, tags, updatedBy, updatedOn. Required: name, category, content.

get_single_zuora_notifications_reusable_block_by_id

Get a single Zuora notification reusable block by its ID or name. Returns: active, category, content, createdBy, createdOn, id, name, number, tags, updatedBy, updatedOn. Required: id.

update_a_zuora_notifications_reusable_block_by_id

Update a Zuora notification reusable block by its ID or name. Returns: active, category, content, createdBy, createdOn, id, name, number, tags, updatedBy, updatedOn. Required: id.

delete_a_zuora_notifications_reusable_block_by_id

Delete a Zuora notification reusable block by its ID or name. Returns an empty 204 response on success. Required: id.

zuora_notifications_histories_bulk_delete

Delete all notification histories (email and callout) for a given account in Zuora. The operation is asynchronous and returns a deletion task object including id, status, tenantId, createdBy, createdOn, and accountId. Required: accountId.

get_single_zuora_history_task_by_id

Get a notification history deletion task in Zuora by id. Returns: id, status. Required: id.

create_a_zuora_callout_histories_resend

Resend callout notifications.

create_a_zuora_email_histories_resend

Resend email notifications in Zuora for customers who did not receive previous notifications. Returns an empty 202 response when all notifications succeed; if any fail, returns error details (code, message) per failed email history ID. Required: request body specifying the email histories to resend.

list_all_zuora_notification_history_callouts

List callout notification histories in Zuora, filtered by date range, object ID, event category, and failure status. Returns: calloutHistories, nextPage, success. Defaults to returning only failed records within a one-day window ending at the current time.

list_all_zuora_notification_history_emails

List email notification histories in Zuora, with optional filtering by account, date range, event category, object, and failure status. Returns emailHistories containing records with accountId, fromEmail, toEmail, subject, notification, result, sendTime, and success. The maximum date range between startTime and endTime is three days.

list_all_zuora_scim_groups

List groups in Zuora SCIM (One-ID). Returns: id, displayName, members. Ten groups per page by default; max 100 per page.

create_a_zuora_scim_group

Create a group in Zuora SCIM (One-ID). Returns: id, displayName, members. Required: displayName. Users can be added at creation by supplying their user IDs in members.

zuora_scim_groups_bulk_create

Create multiple groups in one request in Zuora SCIM (One-ID). Returns: id, displayName, members. Required: displayName for each group; users can be added by supplying user IDs in members.

zuora_scim_groups_bulk_update

Bulk-update group membership in Zuora SCIM (One-ID): add or remove users from a group in a single operation. Returns: id, displayName, members. Set a member's operation to delete to remove that user.

get_single_zuora_scim_group_by_id

Get a single group in Zuora SCIM (One-ID) by id. Returns: id, displayName, members. Required: id.

update_a_zuora_scim_group_by_id

Update a Zuora SCIM group with PUT, overwriting all of its values. Returns: id, displayName, members. Required: id, displayName. Omitted or empty attributes are cleared and the members array replaces the group's entire membership.

delete_a_zuora_scim_group_by_id

Delete a Zuora SCIM group permanently by id; group members are not deleted, only the group. Returns an empty 204 response on success. Required: id.

zuora_scim_groups_partial_update

Partially update a Zuora SCIM group with PATCH, adding or removing users from the group in a single operation. Returns: id, displayName, members. Required: group_id.

create_a_zuora_groups_delete

Bulk delete SCIM groups from a Zuora organization, permanently removing the specified groups (members are not deleted, only the groups). Returns a SCIM ListResponse with totalResults, resources (each containing id, displayName, and GroupExtension attributes), startIndex, and itemsPerPage. Required: schemas, operations.

list_all_zuora_scim_resource_types

List all SCIM resource types managed by Zuora OneId, such as User or Group, including their endpoint paths and schema definitions. Returns: schemas, totalResults, resources, startIndex, itemsPerPage, id, name, description, endpoint, schema, schemaExtensions, meta.

get_single_zuora_scim_resource_type_by_id

Get a single SCIM resource type by id in Zuora OneId, including its endpoint path, schema URN, and any schema extensions. Returns: schemas, id, name, description, endpoint, schema, schemaExtensions, meta. Required: id.

list_all_zuora_scim_schemas

List all SCIM schemas for supported Zuora resources. Returns a SCIM ListResponse containing schemas, totalResults, and a resources array whose entries include id, name, description, and attributes describing each resource's attribute definitions including type, mutability, and returnability.

get_single_zuora_scim_schema_by_id

Get a specific SCIM resource schema by its URN id in Zuora. Returns the schema object including id, name, description, attributes with type and mutability metadata, and meta. Required: id.

list_all_zuora_scim_service_provider_configs

Retrieve Zuora's SCIM service provider configuration. Returns: schemas, patch, bulk, filter, changePassword, sort, etag, authenticationSchemes, meta, CreatedById, CreatedDate, Description, EffectiveEndDate, EffectiveStartDate, Id, Name, SKU, UpdatedById, UpdatedDate.

list_all_zuora_scim_users

List Zuora SCIM users with optional SCIM filter expressions (e.g., userName eq "testuser", status eq "PENDING_ACTIVATION"). Returns: schemas, totalResults, resources, startIndex, itemsPerPage, id, externalId, meta. Each resource includes id, userName, name, emails, roles, and Zuora user extension attributes.

create_a_zuora_scim_user

Create a Zuora SCIM user. Returns: schemas, id, externalId, meta, userName, name, displayName, preferredLanguage, locale, active, emails, and 2 more. Required: schemas, name, active, emails, roles, externalId, userName, preferredLanguage, locale, urn:zuora:scim:schemas:1.0:UserExtension. Users are created as SSO users by default and a federated…

zuora_scim_users_bulk_create

Bulk create multiple Zuora SCIM users within an organization. Returns: schemas, id, externalId, totalResults, resources, startIndex, itemsPerPage, meta. Each resource includes id, userName, name, emails, roles, and UserExtension attributes.

zuora_scim_users_bulk_update

Bulk update multiple Zuora SCIM users, overwriting values for specified attributes. Returns: itemsPerPage, startIndex, schemas, id, externalId, meta, totalResults, resources. Each resource includes id, userName, name, emails, roles, and UserExtension attributes.

get_single_zuora_scim_user_by_id

Get a single Zuora SCIM user by id. Returns: schemas, id, meta, userName, name, displayName, preferredLanguage, locale, active, emails, groups, roles, urn:zuora:scim:schemas:1.0:UserExtension, externalId. Required: id.

update_a_zuora_scim_user_by_id

Update an existing Zuora SCIM user by id, overwriting all attribute values even if an attribute is empty or not provided. Returns the updated user object including id, userName, displayName, active, emails, roles, and the Zuora user extension. Required: id.

delete_a_zuora_scim_user_by_id

Delete (deactivate) a Zuora SCIM user by id. Returns an empty 204 response on success. Required: id.

zuora_scim_users_partial_update

Partially update a Zuora SCIM user by id using SCIM PatchOp operations. Attributes not provided remain unchanged. Returns the updated user object including id, userName, displayName, active, emails, roles, and the Zuora user extension. Required: id.

delete_a_zuora_users_delete_by_id

Deactivate multiple Zuora users by submitting an array of user ID UUIDs. Returns a SCIM ListResponse containing the deactivated user objects within resources, along with totalResults, startIndex, and itemsPerPage. Each resource includes id, userName, displayName, active, emails, roles, and the urn:zuora:scim:schemas:1.0:UserExtension with status set to INACTIVE.

list_all_zuora_objects_definitions

List all custom object definitions for a Zuora tenant. Returns each definition including label, object, description, type, fields, and auditing settings. The select parameter can limit the response to only the type of each object.

create_a_zuora_objects_definition

Create custom object definitions in Zuora by posting a map keyed by object API name. Returns: count, definitions, description. Required: label, object. Max 64 chars for object and label; max 50 fields per object.

get_single_zuora_objects_definition_by_id

Retrieve a single custom object definition by its API name in Zuora. Returns: CreatedById, CreatedDate, Id, UpdatedById, UpdatedDate, type, label, object, description, fields, enableCreateRecordAuditing, enableDeleteRecordAuditing. Required: id (the object's API name, e.g. Account).

zuora_objects_definitions_bulk_delete

Delete a custom object definition by its API name in Zuora. A definition can only be deleted if no records of that custom object type exist. Returns the URI of the deleted custom object definition. Required: object.

update_a_zuora_objects_migration_by_id

Update custom object definitions or custom field definitions for standard and custom objects in Zuora. The system processes requests asynchronously and returns a jobId for tracking job completion via the Retrieve a custom object bulk job operation. Returns: actions. Required: actions. Only one action is allowed per request; required fields can only be added to custom objects with no records, and…

list_all_zuora_objects_records

List Zuora custom object records of a given type. Returns: count, records, cursor, startCursor, Id. Required: object. Custom objects are eventually consistent — recently created records may not appear immediately.

create_a_zuora_objects_record

Create custom object records in Zuora for a given object type. Returns: error, records, unprocessedRecords. Required: object. Maximum 1,000 records per call; empty strings not supported.

update_a_zuora_objects_record_by_id

Update a Zuora custom object record by type and id. Returns: Id, type. Required: object, id. Empty strings not supported.

delete_a_zuora_objects_record_by_id

Delete a Zuora custom object record by type and id. Returns the URI of the deleted record. Required: object, id. A 200 response is returned whether or not the record was found.

zuora_objects_records_partial_update

Partially update a Zuora custom object record by type and id using JSON Merge Patch. Returns: CreatedById, CreatedDate, Id, UpdatedById, UpdatedDate, type, namespace, object, operation, processingTime, recordsProcessed, status. Required: object, id. Empty strings not supported.

create_a_zuora_objects_batch

Batch update or delete Zuora custom object records by object type. Returns a batch operation result whose fields depend on the custom object schema; when allowPartialSuccess is true, error details for failed records may be included in the body. Required: object, action. Max 1,000 records per call for update or delete.

list_all_zuora_objects_jobs

List all custom object bulk jobs submitted by your tenant in Zuora. Returns: count, cursor, jobs. Optional status filter accepts pending, accepted, in_progress, completed, failed, or cancelled. Max 100 per page.

create_a_zuora_objects_job

Submit a custom object bulk job in Zuora for a bulk create, update, or delete operation on custom object records. Returns the created job including Id, status, operation, namespace, object, processingTime, and recordsProcessed. Required: namespace, object, operation. The concurrent bulk job limit per tenant is 5 and execution order is not guaranteed.

get_single_zuora_objects_job_by_id

Retrieve a custom object bulk job in Zuora by its job ID. Returns: CreatedById, CreatedDate, Id, UpdatedById, UpdatedDate, error, namespace, object, operation, processingTime, recordsProcessed, status. Required: id.

zuora_objects_jobs_cancel

Cancel a custom object bulk job in Zuora. A job can only be cancelled if its status is `accepted` or `pending`. Returns: CreatedById, CreatedDate, Id, UpdatedById, UpdatedDate, error, namespace, object, operation, processingTime, recordsProcessed, status. Required: job_id.

create_a_zuora_job_file

Upload a CSV file to a Zuora custom object bulk job to create or update custom object records. Returns the updated job object including Id, status, operation, namespace, object, recordsProcessed, and processingTime. Required: job_id. The job must be in pending status, only one file is allowed per job, and the file size limit is 15 MB.

list_all_zuora_api_requests_volume_summaries

List API request volume summary records for your Zuora tenant within a specified time range, optionally filtered by API path name and HTTP method. Returns: api, error, httpMethod, success, total, path. Required: startTime, endTime.

list_all_zuora_api_requests_failures

List Zuora API request failure records within a specified time range. Returns each failure record including request_id, http_method, http_status, zuora_response_code, latency, api, timestamp, status, request_path, response_body, user_id, ip, user_agent, track_id, tracing_identifier, and request_body. Required: startTime, endTime.

list_all_zuora_api_requests_details

List API usage detail records generated by your Zuora tenant within a specified time range. Returns per-record fields including request_id, http_method, http_status, latency, status, timestamp, zuora_response_code, and request_path. Records can be filtered by API path, HTTP method, response code, request ID, and track ID. Required: startTime, endTime.

list_all_zuora_billing_documents_volume_summaries

List Zuora billing document volume summary records for a specified time range, covering invoices, credit memos, and failed account counts. Returns: totalFailedAccounts, totalGeneratedCreditMemos, totalGeneratedInvoices. Required: startTime, endTime. Both timestamps must use the same timezone.

list_all_zuora_payments_volume_summaries

List payment volume summary records in Zuora, summarizing electronic payments handled by your tenant within a specified time range. Returns: error, paymentGatewayType, paymentMethodType, success, total. Required: startTime, endTime. startTime and endTime must use the same timezone.

list_all_zuora_payments_details

List Zuora system health electronic payment records generated by your tenant within a specified time range. Returns: payment_method_type, amount, payment_status, source_type, payment_gateway_response_code, payment_gateway_response_msg, request_duration, payment_number, payment_id, and 5 more. Required: startTime, endTime. Filters…

list_all_zuora_tax_details

List Zuora tax system health records generated within a specified time range. Returns: error_message, document_number, vendor_name, event_source, error_category, account_id, event_type, total_duration, zuora_request_id, account_name, and 4 more. Required: startTime, endTime. Filterable by vendorName, eventType, and status; sortable by timestamp,…

delete_a_zuora_workflows_version_by_id

Delete a workflow version in Zuora by version id. Returns: id, success. Required: id. The active version of a workflow cannot be deleted.

list_all_zuora_workflows

List Zuora workflow definitions with optional filters by trigger type, name, and CRON schedule. Returns: active_version, calloutTrigger, createdAt, description, id, interval, latest_inactive_verisons, name, ondemandTrigger, scheduledTrigger, status, timezone, updatedAt, priority. Max 50 per page.

get_single_zuora_workflow_by_id

Get a single Zuora workflow definition by id. Returns: active_version, calloutTrigger, createdAt, description, id, interval, name, ondemandTrigger, scheduledTrigger, status, timezone, updatedAt, priority, latest_inactive_verisons. Required: id.

update_a_zuora_workflow_by_id

Update a Zuora workflow definition by id — set its name, description, status, or active version. Returns the updated workflow with id, name, description, status, calloutTrigger, ondemandTrigger, scheduledTrigger, createdAt, updatedAt, active_version. Required: id.

delete_a_zuora_workflow_by_id

Delete a Zuora workflow definition by id. Returns: id, success. Required: id.

create_a_zuora_workflows_import

Import a workflow in Zuora by creating a new workflow definition and its first version from an exported JSON document of an existing workflow version. Returns: calloutTrigger, createdAt, description, id, interval, name, ondemandTrigger, scheduledTrigger, timezone, type, updatedAt, version.

list_all_zuora_workflows_metrics

List Zuora workflow task usage metrics sorted by day within a specified time frame. Returns: metrics. Required: startDate, endDate, metrics. Currently, only the taskCount metric is supported.

list_all_zuora_workflows_tasks

List workflow tasks in your Zuora tenant with optional filters by name, action_type, workflow_id, tags, and more. Returns each task with id, name, action_type, call_type, status, start_time, end_time, workflow_id, data, and parameters. Max 100 per page.

get_single_zuora_workflows_task_by_id

Get a single Zuora workflow task by id. Returns: action_type, call_type, concurrent_limit, data, end_time, error, error_class, error_details, id, instance, name, object, object_id, original_task_id, original_workflow_id, start_time, status, tags, task_id, workflow_id. Required: id.

zuora_tasks_batch_updates_bulk_update

Batch update a group of Zuora workflow tasks. Returns: action_type, call_type, concurrent_limit, data, end_time, error, error_class, error_details, id, instance, name, object, object_id, original_task_id, original_workflow_id, start_time, status, and 4 more. Required: a JSON array of task objects each containing an id. Maximum 50 tasks per request.

create_a_zuora_task_rerun

Rerun a specific Zuora workflow task by its task ID. Returns the task object including id, status, action_type, call_type, name, start_time, end_time, workflow_id, original_task_id, original_workflow_id, and detailed execution data. Required: task_id.

get_single_zuora_workflows_workflow_run_by_id

Get a Zuora workflow run by id. Returns: cpuTime, createdAt, finishedAt, id, messages, name, originalWorkflowId, runTime, status, tasks, type, updatedAt. Required: id.

zuora_workflows_workflow_runs_stop

Stop a specific Zuora workflow run. Returns: success. Required: workflow_run_id.

get_single_zuora_workflow_export_by_id

Export a Zuora workflow version as a JSON file that can be used to create a copy of the workflow. Returns the workflow definition object with its id, name, type, and version, along with linkages and tasks arrays. Required: id. The optional version parameter accepts a version number or 'latest'; defaults to the active version.

create_a_zuora_workflow_run

Run a Zuora workflow definition by workflow_id, passing optional parameters in the request body for the workflow's tasks to consume. Returns the created workflow instance including id, name, status, type, originalWorkflowId, createdAt, and updatedAt. Required: workflow_id. Do not use reserved words (controller, action, id, user_email, user_token, format) as body parameter keys.

list_all_zuora_workflow_versions

List all versions of a Zuora workflow definition. Returns: calloutTrigger, createdAt, description, id, interval, name, ondemandTrigger, scheduledTrigger, timezone, type, updatedAt, version. Required: workflow_id.

create_a_zuora_versions_import

Import a new workflow version into a Zuora workflow definition from an exported workflow JSON document. Returns: active_version, calloutTrigger, createdAt, description, id, interval, name, ondemandTrigger, scheduledTrigger, status, and 2 more. Required: workflow_id, version. The version number must be greater than any existing version numbers.

list_all_zuora_query_jobs

List Zuora data query jobs, optionally filtered by status. Returns: createdBy, id, query, remainingRetries, sourceData, updatedOn, useIndexJoin, dataFile, outputRows, processingTime, queryStatus. Administrators can retrieve all tenant jobs; non-admins see only their own.

create_a_zuora_query_job

Submit a data query to Zuora, creating a new query job for asynchronous execution. Returns the created job object including id, query, queryStatus, sourceData, and createdOn. Poll the retrieve query job endpoint to monitor status and access results once complete. Required: query.

get_single_zuora_query_job_by_id

Get a Zuora data query job by id to track its status and obtain the URL of the query results. Returns: data. Required: id.

delete_a_zuora_query_job_by_id

Cancel a Zuora data query job by id, preventing the query from executing. Only applicable when the job status is accepted or in_progress. Returns: data. Required: id.

create_a_zuora_batch_query

Submit an AQuA batch query job in Zuora with an aggregated list of ZOQL and Export ZOQL queries. Returns: batches, encrypted, format, id, incrementalTime, name, notifyUrl, offset, partner, project, sourceData, status, useLastCompletedJobQueries, version. Required: batches.

list_all_zuora_projects

Retrieve the last completed aggregate query (AQuA) job in Zuora for a given partner and project. Returns: batches, encrypted, format, id, name, partner, project, sourceData, startTime, status, version. Required: partner, project. Completed AQuA jobs older than 180 days are permanently deleted and cannot be queried.

list_all_zuora_batch_query_jobs

Retrieve a Zuora aggregate query (AQuA) batch job by its job ID. Returns the job's id, name, status, batches (each with batchId, batchType, fileId, query, recordCount, and status), format, encrypted, partner, project, sourceData, startTime, and version. Required: jobid. Completed AQuA jobs are permanently deleted after 180 days and can no longer be queried.

zuora_batch_query_jobs_bulk_delete

Cancel a running Zuora aggregate query (AQuA) batch job by its job ID. Only jobs that are not yet complete can be cancelled; cancelling a completed job throws an error. Returns the cancelled job's id, name, status, batches, format, encrypted, sourceData, and version. Required: jobid.

list_all_zuora_deployment_manager_deployment_artifacts

Download a deployment template for migration in the Zuora Deployment Manager from the source tenant to the target tenant. Returns the downloaded template object including its id and attributes containing template-specific fields. Required: deployment_template_id.

create_a_zuora_deployment_artifacts_compare

Compare Zuora configuration settings between a source and target tenant by uploading a migration template. Returns comparison results across customFields, customObjects, settings, notifications, workflows, productCatalog, and dataAccessControl, each with per-component response items containing id, key, result, payload, and segregationKey. Required: tenant, template.

create_a_zuora_deployment_artifacts_deploy

Deploy and migrate selected tenant configuration from a source tenant to a target tenant in Zuora Deployment Manager using a template from the compare screen. Returns: emailIds, environment, id, migratedBy, migrationDescription, migrationEnd, migrationName, migrationStart, and 5 more. Required: tenant, and a request body containing migration…

list_all_zuora_deployment_artifacts_retrieve_settings

Retrieve all Zuora source component details and metadata from Deployment Manager, including custom fields, custom objects, data access controls, notifications, product catalog, settings, and workflows. Returns: customFields, customObjects, dataAccessControl, dataQuery, multiOrg, notifications, organizationHierarchy, productCatalog, and 2 more.

list_all_zuora_deployment_manager_deployment_templates

List all deployment templates in Zuora. Returns each template's id, name, status, active, environment, createdBy, createdOn, content, and tenantName.

create_a_zuora_deployment_manager_deployment_template

Create a deployment template in Zuora by specifying components to migrate. Returns the created template including id, name, status, active, environment, createdBy, createdOn, content, and tenantName.

get_single_zuora_deployment_manager_deployment_template_by_id

Get detailed information about a specific deployment template in Zuora by id, including its content with component configurations. Returns: active, content, createdBy, createdOn, description, entityName, environment, errors, id, name, status, tenantName. Required: id.

delete_a_zuora_deployment_manager_deployment_template_by_id

Delete a deployment template in Zuora by id. Returns an empty 204 response on success. Required: id.

create_a_zuora_deployment_templates_sync

Synchronize an existing deployment template in Zuora Deployment Manager with the latest configuration changes from the source tenant. Returns a sync operation result with an upstream-defined payload shape.

create_a_zuora_deployments_tenant

Compare and deploy a source Zuora tenant to a target tenant, selecting which modules to include in the deployment process. Returns: id, status. Required: name, description, sourceTenantId, sendEmail, settings, notifications, workflows, customFields, productCatalog, userRoles, reporting.

create_a_zuora_deployments_template

Compare and deploy a template to a Zuora tenant. Returns: id, status. Required: name, description, sendEmail, and template.

zuora_deployment_manager_deployments_revert

Revert a Zuora Deployment Manager deployment by migration id. Returns the migration process object including id, name, status, sourceTenantName, startTime, endTime, migratedBy, and productCatalog. Required: migration_id.

get_single_zuora_deployment_manager_deployment_by_id

Retrieve a Zuora Deployment Manager deployment log by id. Returns the deployment log including id, name, description, status, targetTenant, deploymentDate, runBy, succeeded, failed, and skipped component arrays. Required: id.

create_a_zuora_tenant_product_catalog

Compare and deploy the product catalog of a Zuora tenant to a target tenant. Returns: id, status. Required: name, description, sendEmail, inActiveProducts, activeProducts, activeRatePlans, inActiveRatePlans, compareField, sourceTenantId.

create_a_zuora_template_product_catalog

Compare and deploy a product catalog template to a Zuora tenant. Returns: id, status, name, description, type. Required: name, description, sendEmail, template, activeProducts, inActiveProducts, activeRatePlans, inActiveRatePlans, compareField.

create_a_zuora_bulk_data_bulk_job

Create a bulk job in Zuora with a job type of Import, Delete, Update, or Cancel. Returns: id, status. The job must be submitted separately after the file upload to begin processing.

create_a_zuora_bulk_job_submission

Submit a previously created Zuora bulk job for processing. Must be called after uploading the data file to S3 using the uploadFileInfo details from the create job response. Returns: id, status. Required: bulk_job_id.

get_single_zuora_bulk_job_summary_by_id

Get the summary of a specific Zuora bulk job by its id. Returns: id, name, description, createdAt, createdBy, status, rowCount, rowsSucceeded, rowsFailed, lastUpdatedAt, failureReason, objectType, jobType, isCustomObject, customObjectNamespace, dataSourceType, systemType, fileType. Required: id (UUID, 64 characters).

create_a_zuora_bulk_job_cancellation

Cancel an existing Zuora bulk job. Returns: id, status. Required: bulk_job_id. Cancellation is only allowed before the job reaches the In Progress status; once in progress, it can only be aborted.

delete_a_zuora_bulk_job_abort_by_id

Abort an existing bulk job in Zuora by id. When a job is aborted, no more records are processed for that job. Returns: id, status. Required: id.

list_all_zuora_bulk_job_downloads

List download links for a completed Zuora bulk job, including URLs for the source file, success rows, and error rows. Returns: jobId, status, sourceFile, errorRowsFile, successRowsFile, delimiter. Required: bulk_job_id.

list_all_zuora_bulk_jobs_summaries

List Zuora bulk job summaries with optional status filtering. Returns: id, name, status, description, createdAt, createdBy, submittedAt, submittedBy, rowCount, rowsSucceeded, rowsFailed, lastUpdatedAt, failureReason, objectType, jobType, isCustomObject, customObjectNamespace, dataSourceType, systemType, fileType.

list_all_zuora_bulk_job_mappings

List mappings for a Zuora bulk job that define how source file columns correspond to object type template fields. Returns: mappings. Required: bulk_job_id.

create_a_zuora_multi_organizations_data_labeling_job

Submit an asynchronous data labeling job in Zuora to label existing datasets with organizational labels. Returns: success, process_id, request_id, reasons. Accepts ids, org_ids, orgs, object_type, and query in the request body; the job runs in the background, so track its status with the get method.

get_single_zuora_multi_organizations_data_labeling_job_by_id

Retrieve a Zuora data labeling job by id to track the status of the labeling job. Returns: progress, process_id, request_id, reasons, success. Required: id.

create_a_zuora_uno_regenerate_booking_transaction

Regenerate booking transactions in Zuora to synchronize data backfill or fixes from Billing to Revenue. Returns: idList, reasons, success. Requires a RegenerateBookingRequest body. If onlyReSend is true, reMigrate cannot also be true.

create_a_zuora_uno_regenerate_billing_transaction

Regenerate billing transactions in Zuora to synchronize data changes from Billing to Revenue, useful during customer onboarding data backfill or sandbox experimentation. Returns: idList, reasons, success. A request body is required. The onlyReSend and reMigrate query parameters are mutually exclusive — both cannot be true simultaneously.

create_a_zuora_uno_regenerate_rev_rec_event

Regenerate Delivery Schedule based revenue recognition events transactions in Zuora. Returns: reasons, success. The generation mode defaults to Incremental and can be set to Full.

create_a_zuora_rev_rec_events_daily_consumption

Regenerate Daily Consumption based revenue recognition events transactions in Zuora when the Prepaid with Drawdown feature is enabled. Returns: reasons, success. Requires a request body.

list_all_zuora_bookingdate_jobs

List all booking date backfill jobs in Zuora. Returns each job with its id, status, type, createdOn, updatedOn, batchSentCount, batchFinishedCount, errorCount, and progress.

create_a_zuora_bookingdate_job

Create a booking date backfill job in Zuora to update booking dates with the original charge created-on date. Returns: processId, reasons, requestId, success, jobId. The generated jobId can be used to retrieve the job result.

get_single_zuora_bookingdate_job_by_id

Get a specific booking date backfill job in Zuora by id. Returns the job including id, status, type, createdOn, updatedOn, batchSentCount, batchFinishedCount, errorCount, and progress. Required: id.

update_a_zuora_bookingdate_job_by_id

Stop a booking date backfill job in Zuora by id. Returns: processId, reasons, requestId, success. Required: id, status. The only accepted status value is Stopping.

create_a_zuora_data_backfill_job

Create a Zuora data backfill job by uploading a CSV file for a specific backfill action type (e.g. ProductRatePlanCharge, RatePlanCharge, InvoiceItem). Returns: processId, reasons, requestId, success, jobId. Required: type, file. Maximum file size is 4 MB.

get_single_zuora_data_backfill_job_by_id

Retrieve a single Zuora data backfill job by id. Returns: processId, reasons, requestId, success, job. Required: id.

update_a_zuora_data_backfill_job_by_id

Stop a Zuora data backfill job by id. Returns: processId, reasons, requestId, success. Required: id, status (must be 'Stopping').

list_all_zuora_data_backfill_listjobs

List all data backfill jobs in Zuora. Returns each job with its id, type, status, uploadedBy, uploadedOn, totalCount, failedCount, processedCount, successCount, completedPercentage, resultFileUrl, and failureMessage.

list_all_zuora_job_templates

Download a Zuora data backfill template file for a specific job type. Returns the CSV template file content as a string. Required: type.

list_all_zuora_propagation_jobs

List all Zuora auto backfill propagation jobs. Returns each job's id, status, type, progress, batchSentCount, batchFinishedCount, errorCount, createdOn, updatedOn, updatedByUsername, createdOnReadable, and updatedOnReadable.

create_a_zuora_propagation_job

Create a Zuora auto backfill propagation job to update rate plan charges or order line items with product rate plan charges. Returns: processId, reasons, requestId, success, jobId. Required: type.

get_single_zuora_propagation_job_by_id

Get a single Zuora auto backfill propagation job by id. Returns: processId, reasons, requestId, success, job. Required: id.

update_a_zuora_propagation_job_by_id

Stop a Zuora auto backfill propagation job by id. Returns: processId, reasons, requestId, success. Required: id, status.

create_a_zuora_action_create

Create one or more Zuora objects of a single type via the Actions API. The request body is a bare JSON array of zObjects whose fields match the corresponding CRUD create operation for the target object type. Returns an array of SaveResults with Id and Success for each created object. Required: the request body array of zObjects. Maximum 50 objects per call; all objects must be the same type; the…

create_a_zuora_action_delete

Delete one or more Zuora objects of the same type. Returns an array of results, each containing id and success. Required: type. Up to 50 objects per call; all objects in a call must be the same type; null IDs are not allowed.

create_a_zuora_action_query

Execute a Zuora Object Query Language (ZOQL) query against a specified object, returning matching records and their requested fields. Returns: done, queryLocator, records, size. Required: queryString. Limited to 2000 records per call; all ZOQL keywords must be in lower case; fields with NULL values are not returned.

create_a_zuora_action_query_more

Request additional results from a previous Zuora query call when more than 2,000 records were returned. Returns: done, queryLocator, records, size. Required: queryLocator. Zuora expires queryMore cursors after 15 minutes of activity and stores results for up to 5 days.

create_a_zuora_action_update

Update one or more Zuora objects of the same type by passing an array of zObjects, each with its ID and the fields to change. Returns an array of SaveResult objects sorted in the same order as the input, each containing Id and Success. Required: type. Max 50 objects per call; all objects must be of the same type; default WSDL version is 79.

create_a_zuora_settings_batch_request

Submit a batch of Zuora settings requests in a single API operation. Returns a responses array where each item includes id, method, url, children, and response (with body and HTTP status). Required: a request body containing the batch of individual settings operations. Max 100 single operation requests per batch by default, including child requests.

list_all_zuora_settings_listings

List all available settings in your Zuora tenant. Returns: settings.

get_single_zuora_file_by_id

Retrieve a Zuora file by id, such as export results, invoices, and accounting period reports. Returns the raw file content as a binary stream; the response Content-Type header varies by file type (application/pdf, text/csv, application/vnd.ms-excel, application/zip, text/html, text/plain). Required: id. Maximum file size is 2,047 MB.

zuora_files_update_restore

Restore a previously archived Zuora file to its RESTORED status. Returns: success, fileId, status. Required: file_id. The restoration process may take 12 to 48 hours to complete; the operation fails if the count of restored files exceeds the quota limit (1000 by default) in the past 24 hours.

get_single_zuora_file_status_by_id

Get the status of a file in Zuora by its file ID. Returns: success, accessible, status. Required: id.

create_a_zuora_object_import

Create a data import in Zuora by uploading a file with a specified import type. Returns: Id, Success. Required: ImportType, Name, File. ImportType must be one of: Usage, Payment, Quote, TaxationDetail, UpdateAccountingCode, CreateRevenueSchedule, UpdateRevenueSchedule, DeleteRevenueSchedule, ImportFXRate.

get_single_zuora_object_import_by_id

CRUD: Retrieve an import. Returns: CreatedById, CreatedDate, Id, Name, UpdatedById, UpdatedDate. Required: id.

list_all_zuora_custom_exchange_rates

List custom foreign exchange rates from Zuora for a given base currency within a date range. Returns: inverse, rateSetName, rates, and 1 more. Required: currency, startDate, endDate. The end date can be a maximum of 90 days after the start date. Only available when using a custom exchange rate provider with rates uploaded via the Import Foreign Exchange Rates mass action.

create_a_zuora_attachment

Create an attachment in Zuora by uploading a file to an Account, Subscription, Invoice, Credit Memo, or Debit Memo. Returns: fileId, id, success. Required: associatedObjectType, associatedObjectKey, file. Max file size 4 MB.

get_single_zuora_attachment_by_id

Get a single Zuora attachment by id. Returns the full attachment object including id, fileId, fileName, fileContentType, description, createdBy, createdOn, updatedBy, updatedOn, and success. Required: id.

update_a_zuora_attachment_by_id

Update the descriptive fields (description and file name) of a Zuora attachment by id. The actual file content cannot be changed. Returns: reasons, success. Required: id.

delete_a_zuora_attachment_by_id

Delete a Zuora attachment by id. Returns: reasons, success. Required: id.

list_all_zuora_attachments

List attachments for a Zuora account, invoice, subscription, credit memo, or debit memo by object type and key. Returns: attachments, nextPage, success, createdBy, createdOn, description, fileContentType, fileId, fileName, id, updatedBy, updatedOn. Required: object_type, object_key.

list_all_zuora_object_metadatas

List available Zuora metadata objects for a specified data context. Returns: objectName, label, category, supportCustomField, href. Required: context. Supported only for DQ (Data Query) and OQ (Object Query) contexts; use the get method with DSE or AQuA contexts instead.

get_single_zuora_object_metadata_by_id

Retrieve the complete JSON Schema for a specific Zuora metadata object by object name. Returns: $schema, $id, title, description, type, properties, required, x-zuora-context, x-zuora-category, x-zuora-support-custom-field, and 7 more. Required: id (the object's API name, e.g. Account), context. Object name matching is case-insensitive for DQ and OQ contexts;…

list_all_zuora_describes

Describe a Zuora object by its API name to retrieve the full field listing and metadata for data source exports. Returns: name, label, fields (each with name, label, type, contexts, and field-level flags), and related-objects when showRelationships is true. Required: object. The response is an XML document; check each field's contexts element to ensure availability for exports.