{"items":[{"type":"separator","label":"GET STARTED"},{"type":"link","fsPath":"v1-api-reference/introduction.md","metadata":{"type":"markdown"},"label":"Introduction","link":"/v1-api-reference/introduction","routeSlug":"/v1-api-reference/introduction"},{"type":"link","fsPath":"v1-api-reference/object-model.md","metadata":{"type":"markdown"},"label":"Zuora object model","link":"/v1-api-reference/object-model"},{"type":"link","fsPath":"v1-api-reference/cors-rest.md","metadata":{"type":"markdown"},"label":"CORS and Zuora v1 API","link":"/v1-api-reference/cors-rest","routeSlug":"/v1-api-reference/cors-rest"},{"type":"group","label":"API versions","items":[{"type":"link","fsPath":"v1-api-reference/api-versions.md","metadata":{"type":"markdown"},"label":"Introduction to API versions","link":"/v1-api-reference/api-versions","routeSlug":"/v1-api-reference/api-versions"},{"type":"link","fsPath":"v1-api-reference/api-upgrades.md","metadata":{"type":"markdown"},"label":"API upgrades","link":"/v1-api-reference/api-upgrades","routeSlug":"/v1-api-reference/api-upgrades"},{"type":"link","fsPath":"v1-api-reference/api-upgrade-guide.md","metadata":{"type":"markdown"},"label":"API upgrade guide","link":"/v1-api-reference/api-upgrade-guide","routeSlug":"/v1-api-reference/api-upgrade-guide"}]},{"type":"link","fsPath":"v1-api-reference/api-object-names.md","metadata":{"type":"markdown"},"label":"API object names for Describe","link":"/v1-api-reference/api-object-names","routeSlug":"/v1-api-reference/api-object-names"},{"type":"link","fsPath":"docs/get-started/changelogs/v1-api-changelog.md","metadata":{"type":"markdown"},"label":"API changelog","link":"/docs/get-started/changelogs/v1-api-changelog"},{"type":"link","fsPath":"docs/guides/api-policies.md","metadata":{"type":"markdown"},"label":"API policies","link":"/docs/guides/api-policies","routeSlug":"/docs/guides/api-policies"},{"type":"separator","label":"ENDPOINTS"},{"type":"group","label":"v1 API","items":[{"type":"link","label":"API Reference","link":"/v1-api-reference/api","routeSlug":"/v1-api-reference/api"},{"type":"link","label":"More OpenAPI specification options","link":"/v1-api-reference/api/section/more-openapi-specification-options","routeSlug":"/v1-api-reference/api/section/more-openapi-specification-options"},{"type":"separator","label":"Authentication"},{"type":"group","label":"OAuth","link":"/v1-api-reference/api/oauth","routeSlug":"/v1-api-reference/api/oauth","items":[{"label":"Create an OAuth token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/oauth/createtoken","routeSlug":"/v1-api-reference/api/oauth/createtoken","metadata":{"seo":{"title":"Create an OAuth token","description":"Creates a bearer token that enables an OAuth client to authenticate with the Zuora REST API. The OAuth client must have been created using the Zuora UI. See Authentication for more information."}},"httpPath":"/oauth/token"}]},{"type":"separator","label":"Commerce"},{"type":"group","label":"Commerce","link":"/v1-api-reference/api/commerce","routeSlug":"/v1-api-reference/api/commerce","items":[{"label":"Create a billable metric","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/createbillablemetric","routeSlug":"/v1-api-reference/api/commerce/createbillablemetric","metadata":{"seo":{"title":"Create a billable metric","description":"Creates a billable metric that numbered metered features can use to measure entitlement usage."}},"httpPath":"/commerce/billable-metrics"},{"label":"List billable metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getbillablemetrics","routeSlug":"/v1-api-reference/api/commerce/getbillablemetrics","metadata":{"seo":{"title":"List billable metrics","description":"Lists billable metrics that numbered metered features can use to measure entitlement usage."}},"httpPath":"/commerce/billable-metrics"},{"label":"Retrieve a billable metric","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getbillablemetric","routeSlug":"/v1-api-reference/api/commerce/getbillablemetric","metadata":{"seo":{"title":"Retrieve a billable metric","description":"Retrieves a billable metric by its unique identifier or metric number."}},"httpPath":"/commerce/billable-metrics/{id}"},{"label":"Update a billable metric","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updatebillablemetric","routeSlug":"/v1-api-reference/api/commerce/updatebillablemetric","metadata":{"seo":{"title":"Update a billable metric","description":"Updates an existing billable metric. Use this operation to change fields such as name,description, filters, computed_properties, and group_keys. Include metric_keyin the request body to identify the metric."}},"httpPath":"/commerce/billable-metrics/{id}"},{"label":"Delete a billable metric","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/deletebillablemetric","routeSlug":"/v1-api-reference/api/commerce/deletebillablemetric","metadata":{"seo":{"title":"Delete a billable metric","description":"Deletes a billable metric by its unique identifier."}},"httpPath":"/commerce/billable-metrics/{id}"},{"label":"Create a feature","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/createfeature","routeSlug":"/v1-api-reference/api/commerce/createfeature","metadata":{"seo":{"title":"Create a feature","description":"Creates a catalog feature. Supported feature types are boolean (bool), enum (enumType),numbered metered, and numbered unmetered."}},"httpPath":"/commerce/features"},{"label":"List features","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getfeatures","routeSlug":"/v1-api-reference/api/commerce/getfeatures","metadata":{"seo":{"title":"List features","description":"Lists catalog features, including boolean, enum, numbered metered, and numbered unmetered features."}},"httpPath":"/commerce/features"},{"label":"Update a feature","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updatefeature","routeSlug":"/v1-api-reference/api/commerce/updatefeature","metadata":{"seo":{"title":"Update a feature","description":"Updates an existing catalog feature. Use this operation to change fields such as name,description, values, and tags. Omit tags to preserve existing tags. Send clear_tags: trueto remove all tags."}},"httpPath":"/commerce/features"},{"label":"Search features","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/searchfeatures","routeSlug":"/v1-api-reference/api/commerce/searchfeatures","metadata":{"seo":{"title":"Search features","description":"Searches catalog features. Use filters to match fields such as feature_type or feature_tag,or send filter.feature_tag. Soft-deleted features are excluded from the results."}},"httpPath":"/commerce/features/search"},{"label":"Retrieve a feature","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getfeature","routeSlug":"/v1-api-reference/api/commerce/getfeature","metadata":{"seo":{"title":"Retrieve a feature","description":"Retrieves a catalog feature by its unique identifier."}},"httpPath":"/commerce/features/{id}"},{"label":"Delete a feature","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/deletefeature","routeSlug":"/v1-api-reference/api/commerce/deletefeature","metadata":{"seo":{"title":"Delete a feature","description":"Deletes a catalog feature by its unique identifier."}},"httpPath":"/commerce/features/{id}"},{"label":"Create a product rate plan charge with Dynamic Pricing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/createproductrateplanchargewithdynamicpricing","routeSlug":"/v1-api-reference/api/commerce/createproductrateplanchargewithdynamicpricing","metadata":{"seo":{"title":"Create a product rate plan charge with Dynamic Pricing","description":"Create a product rate plan charge (PRPC) in the Product Catalog. Use this endpoint to configure Dynamic Pricing, including default pricing at the charge level and conditional rate cards evaluated by attribute values."}},"httpPath":"/commerce/charges"},{"label":"Update a product rate plan charge with Dynamic Pricing","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updateproductrateplanchargewithdynamicpricing","routeSlug":"/v1-api-reference/api/commerce/updateproductrateplanchargewithdynamicpricing","metadata":{"seo":{"title":"Update a product rate plan charge with Dynamic Pricing","description":"Update an existing product rate plan charge (PRPC). Use this API to update default pricing and/or conditional rate cards."}},"httpPath":"/commerce/charges"},{"label":"Query a product rate plan charge with Dynamic Pricing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/queryproductrateplanchargewithdynamicpricing","routeSlug":"/v1-api-reference/api/commerce/queryproductrateplanchargewithdynamicpricing","metadata":{"seo":{"title":"Query a product rate plan charge with Dynamic Pricing","description":"Returns a product rate plan charge (PRPC) by evaluating Dynamic Pricing against the provided attribute values. If a matching rate-card row is found, its pricing is returned; otherwise, the default charge-level pricing is used (if defined). This operation can be used to simulate pricing resolution without creating or updating the charge."}},"httpPath":"/commerce/charges/query"},{"label":"Create a product with plans and charges","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/createproduct","routeSlug":"/v1-api-reference/api/commerce/createproduct","metadata":{"seo":{"title":"Create a product with plans and charges","description":"Create a product in the Product Catalog with one or more plans and charges. Charges can be usage (per-unit), recurring (flat fee), or other supported models."}},"httpPath":"/commerce/products"},{"label":"Update a product","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updateproduct","routeSlug":"/v1-api-reference/api/commerce/updateproduct","metadata":{"seo":{"title":"Update a product","description":"Updates an existing product in the Product Catalog. Use this API to update core product fields such as name, description, category, effective dates, and custom fields."}},"httpPath":"/commerce/products"},{"label":"Create a product rate plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/createplan","routeSlug":"/v1-api-reference/api/commerce/createplan","metadata":{"seo":{"title":"Create a product rate plan","description":"Create a product rate plan (Plan) under an existing product.A plan includes one or more charges. Each charge must include:"}},"httpPath":"/commerce/plans"},{"label":"Update a product rate plan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updateproductrateplan","routeSlug":"/v1-api-reference/api/commerce/updateproductrateplan","metadata":{"seo":{"title":"Update a product rate plan","description":"Updates an existing Product Rate Plan (PRP) in the Product Catalog. Use this API to update core plan fields such as name, description, grade, and effective dates."}},"httpPath":"/commerce/plans"},{"label":"Query product rate plan details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/querycommerceproductrateplans","routeSlug":"/v1-api-reference/api/commerce/querycommerceproductrateplans","metadata":{"seo":{"title":"Query product rate plan details","description":"Retrieve details of a single product rate plan (PRP) from the Product Catalog. You can expand associated product rate plan charges for each plan.This operation is a strict lookup and requires product_rate_plan_key. It does not support attributes or other list-style filters.To browse or filter plans (including by attributes), use  the \"Query product rate plans\" operation (POST /commerce/plans/list)."}},"httpPath":"/commerce/plans/query"},{"label":"Query product rate plans","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/querycommerceplanslist","routeSlug":"/v1-api-reference/api/commerce/querycommerceplanslist","metadata":{"seo":{"title":"Query product rate plans","description":"Queries product rate plans (PRPs) from the Product Catalog using filters such as plan ID, name, or product ID. You can optionally expand related Product Rate Plan Charges (PRPCs) in the response."}},"httpPath":"/commerce/plans/list"},{"label":"Create an entitlement definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/createentitlementdefinition","routeSlug":"/v1-api-reference/api/commerce/createentitlementdefinition","metadata":{"seo":{"title":"Create an entitlement definition","description":"Creates a catalog entitlement definition on a plan. The definition associates a productfeature with the plan. Include featureNumber or feature_number. Numbered features caninclude quantity or limitValue. Enum features can include values."}},"httpPath":"/commerce/plans/{id}/entitlements"},{"label":"Update an entitlement definition","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updateentitlementdefinition","routeSlug":"/v1-api-reference/api/commerce/updateentitlementdefinition","metadata":{"seo":{"title":"Update an entitlement definition","description":"Updates a catalog entitlement definition. Use this operation to link the definition to a charge, set boolean values, or change enforcement settings."}},"httpPath":"/commerce/plans/entitlements"},{"label":"Retrieve an entitlement definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getentitlementdefinition","routeSlug":"/v1-api-reference/api/commerce/getentitlementdefinition","metadata":{"seo":{"title":"Retrieve an entitlement definition","description":"Retrieves a catalog entitlement definition by its unique identifier or entitlement number."}},"httpPath":"/commerce/plans/entitlements/{id}"},{"label":"Retrieve a product by key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getproductbykey","routeSlug":"/v1-api-reference/api/commerce/getproductbykey","metadata":{"seo":{"title":"Retrieve a product by key","description":"Retrieves detailed information about a specific product by its unique product number or ID. You can optionally specify related objects to expand in the request body."}},"httpPath":"/commerce/products/{product_key}"},{"label":"Add a feature to a product","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/addproductfeature","routeSlug":"/v1-api-reference/api/commerce/addproductfeature","metadata":{"seo":{"title":"Add a feature to a product","description":"Links a catalog feature to a product. Include feature_number or featureNumber.After a feature is linked to a product, you can create an entitlement definition on a planthat belongs to that product."}},"httpPath":"/commerce/products/{id}/features/add"},{"label":"Query legacy products from the Product Catalog","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/querylegacyproducts","routeSlug":"/v1-api-reference/api/commerce/querylegacyproducts","metadata":{"seo":{"title":"Query legacy products from the Product Catalog","description":"This operation is functionally equivalent to the \"Query products from the Product Catalog\" operation, except that it returns resultsin the V1 response format. It is primarily intended for customers migrating from older V1 integrationswho want to use new Commerce capabilities — such as Dynamic Pricing—without refactoring their existing integrations."}},"httpPath":"/commerce/legacy/products/list"},{"label":"Update a product rate plan charge tier","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updatetier","routeSlug":"/v1-api-reference/api/commerce/updatetier","metadata":{"seo":{"title":"Update a product rate plan charge tier","description":"Updates the price and other editable attributes, when supported, for a specific Product Rate Plan Charge Tier."}},"httpPath":"/commerce/tiers"},{"label":"Query purchase options by PRP ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/querypurchaseoptionsbyprpid","routeSlug":"/v1-api-reference/api/commerce/querypurchaseoptionsbyprpid","metadata":{"seo":{"title":"Query purchase options by PRP ID","description":"Retrieves one or more product rate plans (PRPs) from the Product Catalog based on specified filters such as product ID or PRP ID. You can optionally expand related product rate plan charges (PRPCs) in the response."}},"httpPath":"/commerce/purchase-options/list"},{"label":"List entitlement audit events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getentitlementauditevents","routeSlug":"/v1-api-reference/api/commerce/getentitlementauditevents","metadata":{"seo":{"title":"List entitlement audit events","description":"Lists entitlement audit events. Filter results by account, feature, grant, subscription, event type, and date."}},"httpPath":"/commerce/entitlements/audit-events"},{"label":"Authorize entitlement consumption","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/authorizeentitlementconsumption","routeSlug":"/v1-api-reference/api/commerce/authorizeentitlementconsumption","metadata":{"seo":{"title":"Authorize entitlement consumption","description":"Authorizes consumption against a numbered metered feature and deducts requestedQuantityfrom the remaining entitlement balance when the request is allowed."}},"httpPath":"/commerce/entitlements/authorize"},{"label":"Check entitlements by tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/validateentitlementsbytag","routeSlug":"/v1-api-reference/api/commerce/validateentitlementsbytag","metadata":{"seo":{"title":"Check entitlements by tag","description":"Checks whether an account has access to features that match featureTag, or to thefeatures in featureKeys. Do not send featureTag and featureKey in the same request."}},"httpPath":"/commerce/entitlements/bulk-challenge"},{"label":"Check multiple entitlements","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/validateentitlementfeatures","routeSlug":"/v1-api-reference/api/commerce/validateentitlementfeatures","metadata":{"seo":{"title":"Check multiple entitlements","description":"Checks whether an account has access to multiple features in one request. IncluderequestedQuantity when evaluating numbered metered features."}},"httpPath":"/commerce/entitlements/bulk-check"},{"label":"Create entitlement grants in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/bulkgrantentitlements","routeSlug":"/v1-api-reference/api/commerce/bulkgrantentitlements","metadata":{"seo":{"title":"Create entitlement grants in bulk","description":"Creates runtime entitlement grants for multiple accounts or subscriptions in a singlecall. Each item uses the same shape as POST /commerce/entitlements/grant, but thisoperation reports each item's outcome independently instead of failing the whole batchon the first bad item."}},"httpPath":"/commerce/entitlements/bulk-grant"},{"label":"Revoke entitlement grants","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/bulkrevokeentitlements","routeSlug":"/v1-api-reference/api/commerce/bulkrevokeentitlements","metadata":{"seo":{"title":"Revoke entitlement grants","description":"Revokes one or more runtime entitlement grants. Include revokedDate when the revocationshould take effect on a specific date."}},"httpPath":"/commerce/entitlements/bulk-revoke"},{"label":"Check entitlement access","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/validateentitlementaccess","routeSlug":"/v1-api-reference/api/commerce/validateentitlementaccess","metadata":{"seo":{"title":"Check entitlement access","description":"Checks whether an account has access to a feature. For numbered metered features, includerequestedQuantity. For enum features, include enumValues."}},"httpPath":"/commerce/entitlements/challenge"},{"label":"Create entitlement grants","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/createentitlementgrants","routeSlug":"/v1-api-reference/api/commerce/createentitlementgrants","metadata":{"seo":{"title":"Create entitlement grants","description":"Creates one or more runtime entitlement grants. Use this operation to issue a manual grant for an account, independently of a catalog entitlement definition on a plan."}},"httpPath":"/commerce/entitlements/grant"},{"label":"List entitlement grants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getentitlementgrants","routeSlug":"/v1-api-reference/api/commerce/getentitlementgrants","metadata":{"seo":{"title":"List entitlement grants","description":"Lists runtime entitlement grants. Filter results by account, subscription, feature, state, or charge source."}},"httpPath":"/commerce/entitlements/grants"},{"label":"Retrieve an entitlement grant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getentitlementgrant","routeSlug":"/v1-api-reference/api/commerce/getentitlementgrant","metadata":{"seo":{"title":"Retrieve an entitlement grant","description":"Retrieves one runtime entitlement grant by its entitlement key."}},"httpPath":"/commerce/entitlements/grants/{entitlementKey}"},{"label":"Update an entitlement grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updateentitlementgrant","routeSlug":"/v1-api-reference/api/commerce/updateentitlementgrant","metadata":{"seo":{"title":"Update an entitlement grant","description":"Updates the dates or quantity of a runtime entitlement grant. Use redate withstartDate and/or endDate to change the grant term, or increment and decrementwith delta to change the granted quantity. Billable grants may return status: queuedwith an orderIntentId."}},"httpPath":"/commerce/entitlements/{entitlementKey}/modify"},{"label":"Update entitlement grant state","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updateentitlementgrantstate","routeSlug":"/v1-api-reference/api/commerce/updateentitlementgrantstate","metadata":{"seo":{"title":"Update entitlement grant state","description":"Updates the state of a runtime entitlement grant. Supported action values are pause,resume, activate, deactivate, and revoke."}},"httpPath":"/commerce/entitlements/{entitlementKey}/state"}]},{"type":"separator","label":"Customer Accounts"},{"type":"group","label":"Accounts","link":"/v1-api-reference/api/accounts","routeSlug":"/v1-api-reference/api/accounts","items":[{"label":"Create an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/post_account","routeSlug":"/v1-api-reference/api/accounts/post_account","metadata":{"seo":{"title":"Create an account","description":"Creates a customer account with a payment method, a bill-to contact,and optional sold-to and ship-to contacts. Request and response field descriptions and sample code are provided. Use this operation to optionally create a subscription,invoice for that subscription, and collect payment through the default payment method. The transaction is atomic; if any part fails for any reason, the entiretransaction is rolled back."}},"httpPath":"/v1/accounts"},{"label":"Delete an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/delete_account","routeSlug":"/v1-api-reference/api/accounts/delete_account","metadata":{"seo":{"title":"Delete an account","description":"Deletes a specific account asynchronously."}},"httpPath":"/v1/accounts/{account-key}"},{"label":"Retrieve an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/get_account","routeSlug":"/v1-api-reference/api/accounts/get_account","metadata":{"seo":{"title":"Retrieve an account","description":"Retrieves basic information about a customer account."}},"httpPath":"/v1/accounts/{account-key}"},{"label":"Update an account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/put_account","routeSlug":"/v1-api-reference/api/accounts/put_account","metadata":{"seo":{"title":"Update an account","description":"Updates a customer account by specifying the account-key."}},"httpPath":"/v1/accounts/{account-key}"},{"label":"List payment methods of an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/get_acountpaymentmethods","routeSlug":"/v1-api-reference/api/accounts/get_acountpaymentmethods","metadata":{"seo":{"title":"List payment methods of an account","description":"Retrieves the payment methods of the specified customer account."}},"httpPath":"/v1/accounts/{account-key}/payment-methods"},{"label":"Retrieve configuration of cascading payment methods for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/getaccountpaymentmethodcascading","routeSlug":"/v1-api-reference/api/accounts/getaccountpaymentmethodcascading","metadata":{"seo":{"title":"Retrieve configuration of cascading payment methods for an account","description":"Zuora provides the Cascading Payment Method feature to dynamically retry the failed payment with alternative payment methods according to a predefined priority list. Use this API operation to retrieve the configuration information for Cascading Payment Method of a specified account, including the cascading consent value and the priority list of payment methods."}},"httpPath":"/v1/accounts/{account-key}/payment-methods/cascading"},{"label":"Configure cascading payment methods for an account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/putaccountpaymentmethodcascading","routeSlug":"/v1-api-reference/api/accounts/putaccountpaymentmethodcascading","metadata":{"seo":{"title":"Configure cascading payment methods for an account","description":"Zuora provides the Cascading Payment Method feature to dynamically retry the failed payment with alternative payment methods according to a predefined priority list. Use this API operation to configure the cascading consent for a specified account and set up the priority list of payment methods to be used in Cascading Payment Method."}},"httpPath":"/v1/accounts/{account-key}/payment-methods/cascading"},{"label":"Retrieve the default payment method of an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/get_acountdefaultpaymentmethod","routeSlug":"/v1-api-reference/api/accounts/get_acountdefaultpaymentmethod","metadata":{"seo":{"title":"Retrieve the default payment method of an account","description":"Retrieves the default payment method of the specified customer account."}},"httpPath":"/v1/accounts/{account-key}/payment-methods/default"},{"label":"Retrieve an account summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/get_accountsummary","routeSlug":"/v1-api-reference/api/accounts/get_accountsummary","metadata":{"seo":{"title":"Retrieve an account summary","description":"Retrieves detailed information about the specified customer account."}},"httpPath":"/v1/accounts/{account-key}/summary"}]},{"type":"group","label":"Contacts","link":"/v1-api-reference/api/contacts","routeSlug":"/v1-api-reference/api/contacts","items":[{"label":"Create a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/contacts/post_createcontact","routeSlug":"/v1-api-reference/api/contacts/post_createcontact","metadata":{"seo":{"title":"Create a contact","description":"Creates a contact for a specified account. Each account must have at least one contact before it can be saved. You can add a maximum of 2000 contacts to an account."}},"httpPath":"/v1/contacts"},{"label":"Delete a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/contacts/delete_contact","routeSlug":"/v1-api-reference/api/contacts/delete_contact","metadata":{"seo":{"title":"Delete a contact","description":"Deletes a contact."}},"httpPath":"/v1/contacts/{contactId}"},{"label":"Retrieve a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/contacts/get_contact","routeSlug":"/v1-api-reference/api/contacts/get_contact","metadata":{"seo":{"title":"Retrieve a contact","description":"Retrieves detailed information about a specific contact."}},"httpPath":"/v1/contacts/{contactId}"},{"label":"Update a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/contacts/put_contact","routeSlug":"/v1-api-reference/api/contacts/put_contact","metadata":{"seo":{"title":"Update a contact","description":"Updates a contact for a specified account."}},"httpPath":"/v1/contacts/{contactId}"},{"label":"Transfer a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/contacts/transfercontent","routeSlug":"/v1-api-reference/api/contacts/transfercontent","metadata":{"seo":{"title":"Transfer a contact","description":"This operation transfers contacts of the accounts within the Customer Hierarchy when removing the account."}},"httpPath":"/v1/contacts/{contactId}/transfer"},{"label":"Scrub a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/contacts/put_scrubcontact","routeSlug":"/v1-api-reference/api/contacts/put_scrubcontact","metadata":{"seo":{"title":"Scrub a contact","description":"Scrubs the sensitive data of a specific contact."}},"httpPath":"/v1/contacts/{contactId}/scrub"}]},{"type":"group","label":"Contact Snapshots","link":"/v1-api-reference/api/contact-snapshots","routeSlug":"/v1-api-reference/api/contact-snapshots","items":[{"label":"Retrieve a contact snapshot","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/contact-snapshots/get_contactsnapshot","routeSlug":"/v1-api-reference/api/contact-snapshots/get_contactsnapshot","metadata":{"seo":{"title":"Retrieve a contact snapshot","description":"Retrieves detailed information about the snapshot of a contact, either a bill-to contact or sold-to contact."}},"httpPath":"/v1/contact-snapshots/{contact-snapshot-id}"}]},{"type":"separator","label":"Orders and Subscriptions"},{"type":"group","label":"Sign Up","link":"/v1-api-reference/api/sign-up","routeSlug":"/v1-api-reference/api/sign-up","items":[{"label":"Sign up","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/sign-up/post_signup","routeSlug":"/v1-api-reference/api/sign-up/post_signup","metadata":{"seo":{"title":"Sign up","description":"This call performs many actions. You can use this operation to implementthe standard requirements for signing up a customer, such as validating theuniqueness of an account and limiting the number of subscriptions per account.Also, you can use this operation to create a subscription, generate an invoice,and collect payment for a new or existing customer."}},"httpPath":"/v1/sign-up"}]},{"type":"group","label":"Orders","link":"/v1-api-reference/api/orders","routeSlug":"/v1-api-reference/api/orders","items":[{"label":"Preview an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/post_previeworder","routeSlug":"/v1-api-reference/api/orders/post_previeworder","metadata":{"seo":{"title":"Preview an order","description":"Notes:"}},"httpPath":"/v1/orders/preview"},{"label":"Preview an order asynchronously","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/post_previeworderasynchronously","routeSlug":"/v1-api-reference/api/orders/post_previeworderasynchronously","metadata":{"seo":{"title":"Preview an order asynchronously","description":"Notes:"}},"httpPath":"/v1/async/orders/preview"},{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/get_allorders","routeSlug":"/v1-api-reference/api/orders/get_allorders","metadata":{"seo":{"title":"List orders","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"httpPath":"/v1/orders"},{"label":"Create an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/post_order","routeSlug":"/v1-api-reference/api/orders/post_order","metadata":{"seo":{"title":"Create an order","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the  new features on Zuora Billing."}},"httpPath":"/v1/orders"},{"label":"Create an order asynchronously","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/post_createorderasynchronously","routeSlug":"/v1-api-reference/api/orders/post_createorderasynchronously","metadata":{"seo":{"title":"Create an order asynchronously","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."}},"httpPath":"/v1/async/orders"},{"label":"Delete an order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/delete_order","routeSlug":"/v1-api-reference/api/orders/delete_order","metadata":{"seo":{"title":"Delete an order","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."}},"httpPath":"/v1/orders/{orderNumber}"},{"label":"Retrieve an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/get_order","routeSlug":"/v1-api-reference/api/orders/get_order","metadata":{"seo":{"title":"Retrieve an order","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"httpPath":"/v1/orders/{orderNumber}"},{"label":"Update an order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/put_order","routeSlug":"/v1-api-reference/api/orders/put_order","metadata":{"seo":{"title":"Update an order","description":"Notes:"}},"httpPath":"/v1/orders/{orderNumber}"},{"label":"Delete an order asynchronously","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/deleteorderasynchronously","routeSlug":"/v1-api-reference/api/orders/deleteorderasynchronously","metadata":{"seo":{"title":"Delete an order asynchronously","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enableOrders Harmonization to access the Orders feature. With Orders, you can access both existingfunctions for subscription and billing management and the new features on Zuora Billing.Note: The Order Line Itemsfeature is now generally available to all Zuora customers. You need to enablethe Ordersfeature to access the Order Line Itemsfeature. As of Zuora Billing Release 313 (November 2021), new customers whoonboard on Orderswill have the Order Line Items feature enabled by default.Deletes a specified order.All the subscriptions changed by this order are deleted. After the deletion, the subscriptions are rolled back to the previous version.All the order line items created in this order are deleted.You are not allowed to delete an order if the charges that are affected by this order are invoiced."}},"httpPath":"/v1/async/orders/{orderNumber}"},{"label":"Retrieve the status and response of a job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/get_jobstatusandresponse","routeSlug":"/v1-api-reference/api/orders/get_jobstatusandresponse","metadata":{"seo":{"title":"Retrieve the status and response of a job","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."}},"httpPath":"/v1/async-jobs/{jobId}"},{"label":"List orders of a subscription owner","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/get_ordersbysubscriptionowner","routeSlug":"/v1-api-reference/api/orders/get_ordersbysubscriptionowner","metadata":{"seo":{"title":"List orders of a subscription owner","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"httpPath":"/v1/orders/subscriptionOwner/{accountNumber}"},{"label":"List orders by subscription number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/get_ordersbysubscriptionnumber","routeSlug":"/v1-api-reference/api/orders/get_ordersbysubscriptionnumber","metadata":{"seo":{"title":"List orders by subscription number","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"httpPath":"/v1/orders/subscription/{subscriptionNumber}"},{"label":"List orders of an invoice owner","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/get_ordersbyinvoiceowner","routeSlug":"/v1-api-reference/api/orders/get_ordersbyinvoiceowner","metadata":{"seo":{"title":"List orders of an invoice owner","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"httpPath":"/v1/orders/invoiceOwner/{accountNumber}"},{"label":"Update order custom fields","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/put_updateordercustomfields","routeSlug":"/v1-api-reference/api/orders/put_updateordercustomfields","metadata":{"seo":{"title":"Update order custom fields","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"httpPath":"/v1/orders/{orderNumber}/customFields"},{"label":"Update subscription custom fields","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/put_updatesubscriptioncustomfields","routeSlug":"/v1-api-reference/api/orders/put_updatesubscriptioncustomfields","metadata":{"seo":{"title":"Update subscription custom fields","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."}},"httpPath":"/v1/subscriptions/{subscriptionNumber}/customFields"},{"label":"Update order action trigger dates","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/put_ordertriggerdates","routeSlug":"/v1-api-reference/api/orders/put_ordertriggerdates","metadata":{"seo":{"title":"Update order action trigger dates","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."}},"httpPath":"/v1/orders/{orderNumber}/triggerDates"},{"label":"Activate an order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/put_orderactivate","routeSlug":"/v1-api-reference/api/orders/put_orderactivate","metadata":{"seo":{"title":"Activate an order","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."}},"httpPath":"/v1/orders/{orderNumber}/activate"},{"label":"Cancel an order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/put_ordercancel","routeSlug":"/v1-api-reference/api/orders/put_ordercancel","metadata":{"seo":{"title":"Cancel an order","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."}},"httpPath":"/v1/orders/{orderNumber}/cancel"},{"label":"Rescan a commitment's account associations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/rescancommitmentaccountassociations","routeSlug":"/v1-api-reference/api/orders/rescancommitmentaccountassociations","metadata":{"seo":{"title":"Rescan a commitment's account associations","description":"Re-evaluates a commitment's account eligibility condition against current account data and activates (inserts or reactivates) any newly-eligible accounts."}},"httpPath":"/v1/orders/commitments/{commitmentNumber}/associations/rescan"},{"label":"Retrieve the order delta metrics of an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/getorderdeltametricsbyordernumber","routeSlug":"/v1-api-reference/api/orders/getorderdeltametricsbyordernumber","metadata":{"seo":{"title":"Retrieve the order delta metrics of an order","description":"Note: This operation is only available if you have the OrderDelta Metricsfeature enabled. The Ordersfeature must be enabled before you can access Order Delta Metrics."}},"httpPath":"/v1/orders/deltaMetrics/{orderNumber}"},{"label":"List pending orders by subscription number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/get_pendingordersbysubscriptionnumber","routeSlug":"/v1-api-reference/api/orders/get_pendingordersbysubscriptionnumber","metadata":{"seo":{"title":"List pending orders by subscription number","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"httpPath":"/v1/orders/subscription/{subscription-key}/pending"}]},{"type":"group","label":"Order Actions","link":"/v1-api-reference/api/order-actions","routeSlug":"/v1-api-reference/api/order-actions","items":[{"label":"Update an order action","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/order-actions/put_orderactions","routeSlug":"/v1-api-reference/api/order-actions/put_orderactions","metadata":{"seo":{"title":"Update an order action","description":"Updates the change reason and custom fields for an order action."}},"httpPath":"/v1/orderActions/{id}"}]},{"type":"group","label":"Order Line Items","link":"/v1-api-reference/api/order-line-items","routeSlug":"/v1-api-reference/api/order-line-items","items":[{"label":"Retrieve an order line item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/order-line-items/get_orderlineitem","routeSlug":"/v1-api-reference/api/order-line-items/get_orderlineitem","metadata":{"seo":{"title":"Retrieve an order line item","description":"Note: The Order Line Itemsfeature is now generally available to all Zuora customers. If you already have access to the Orders feature, you automatically have access to Order Line Items as well. As of Zuora Billing Release 313 (November 2021), new customers who onboard on Orders will have the Order Line Items feature enabled by default."}},"httpPath":"/v1/order-line-items/{itemId}"},{"label":"Update an order line item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/order-line-items/put_orderlineitem","routeSlug":"/v1-api-reference/api/order-line-items/put_orderlineitem","metadata":{"seo":{"title":"Update an order line item","description":"Note: The Order Line Itemsfeature is now generally available to all Zuora customers. If you already have access to the Orders feature, you automatically have access to Order Line Items as well. As of Zuora Billing Release 313 (November 2021), new customers who onboard on Orders will have the Order Line Items feature enabled by default."}},"httpPath":"/v1/order-line-items/{itemId}"},{"label":"Update order line items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/order-line-items/post_orderlineitems","routeSlug":"/v1-api-reference/api/order-line-items/post_orderlineitems","metadata":{"seo":{"title":"Update order line items","description":"Note: The Order Line Items feature is now generally available to all Zuora customers. If you already have access to the Orders feature, you automatically have access to Order Line Items as well. As of Zuora Billing Release 313 (November 2021), new customers who onboard on Orders will have the Order Line Items feature enabled by default."}},"httpPath":"/v1/order-line-items/bulk"}]},{"type":"group","label":"Fulfillments","link":"/v1-api-reference/api/fulfillments","routeSlug":"/v1-api-reference/api/fulfillments","items":[{"label":"Create fulfillments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/create_fulfillment","routeSlug":"/v1-api-reference/api/fulfillments/create_fulfillment","metadata":{"seo":{"title":"Create fulfillments","description":"Creates one or multiple Fulfillment objects. You can also generate invoices or memos for these Fulfillment objects in this API call. The following tutorials demonstrate how to use this operation:"}},"httpPath":"/v1/fulfillments"},{"label":"Delete a fulfillment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/delete_fulfillment","routeSlug":"/v1-api-reference/api/fulfillments/delete_fulfillment","metadata":{"seo":{"title":"Delete a fulfillment","description":"Deletes a specified fulfillment. A fulfillment can only be deleted when it is in the Executing state."}},"httpPath":"/v1/fulfillments/{key}"},{"label":"Retrieve a fulfillment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/get_fulfillment","routeSlug":"/v1-api-reference/api/fulfillments/get_fulfillment","metadata":{"seo":{"title":"Retrieve a fulfillment","description":"Retrieves the detailed information about a specified fulfillment. The following tutorial demonstrates how to use this operation:"}},"httpPath":"/v1/fulfillments/{key}"},{"label":"Update a fulfillment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/put_fulfillment","routeSlug":"/v1-api-reference/api/fulfillments/put_fulfillment","metadata":{"seo":{"title":"Update a fulfillment","description":"Updates a specified fulfillment. The state field of a fulfillment can only be updated when it is in a different state, to trigger the state transition. The other fields of a fulfillment can only be updated when the fulfillment is in the Executing state, or when the fulfillment is in the Booked state and the user has the \"Allow Edit Of Booked Order Line Items\" permission.The following tutorial demonstrates how to use this operation:"}},"httpPath":"/v1/fulfillments/{key}"},{"label":"Create fulfillment items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/create_fulfillmentitem","routeSlug":"/v1-api-reference/api/fulfillments/create_fulfillmentitem","metadata":{"seo":{"title":"Create fulfillment items","description":"Creates one or multiple fulfillment items."}},"httpPath":"/v1/fulfillment-items"},{"label":"Delete a fulfillment item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/delete_fulfillmentitem","routeSlug":"/v1-api-reference/api/fulfillments/delete_fulfillmentitem","metadata":{"seo":{"title":"Delete a fulfillment item","description":"Deletes a specified fulfillment item."}},"httpPath":"/v1/fulfillment-items/{id}"},{"label":"Retrieve a fulfillment item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/get_fulfillmentitem","routeSlug":"/v1-api-reference/api/fulfillments/get_fulfillmentitem","metadata":{"seo":{"title":"Retrieve a fulfillment item","description":"Retrieves the detailed information about a specified fulfillment item."}},"httpPath":"/v1/fulfillment-items/{id}"},{"label":"Update a fulfillment item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/put_fulfillmentitem","routeSlug":"/v1-api-reference/api/fulfillments/put_fulfillmentitem","metadata":{"seo":{"title":"Update a fulfillment item","description":"Updates a specified fulfillment item."}},"httpPath":"/v1/fulfillment-items/{id}"}]},{"type":"group","label":"Ramps","link":"/v1-api-reference/api/ramps","routeSlug":"/v1-api-reference/api/ramps","items":[{"label":"Retrieve a ramp","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/ramps/get_rampbyrampnumber","routeSlug":"/v1-api-reference/api/ramps/get_rampbyrampnumber","metadata":{"seo":{"title":"Retrieve a ramp","description":"Note: This operation is only available if you have the Ramps feature enabled. The Orders feature must be enabled before you can access the Ramps feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information coming October 2020."}},"httpPath":"/v1/ramps/{rampNumber}"},{"label":"List all ramp metrics of a ramp","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/ramps/get_rampmetricsbyrampnumber","routeSlug":"/v1-api-reference/api/ramps/get_rampmetricsbyrampnumber","metadata":{"seo":{"title":"List all ramp metrics of a ramp","description":"Note: This operation is only available if you have the Ramps feature enabled. The Orders feature must be enabled before you can access the Ramps feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information coming October 2020."}},"httpPath":"/v1/ramps/{rampNumber}/ramp-metrics"},{"label":"Retrieve a ramp by subscription key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/ramps/get_rampsbysubscriptionkey","routeSlug":"/v1-api-reference/api/ramps/get_rampsbysubscriptionkey","metadata":{"seo":{"title":"Retrieve a ramp by subscription key","description":"Note: This operation is only available if you have the Ramps feature enabled. The Orders feature must be enabled before you can access the Ramps feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information coming October 2020."}},"httpPath":"/v1/subscriptions/{subscriptionKey}/ramps"},{"label":"List ramp metrics by subscription key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/ramps/get_rampmetricsbysubscriptionkey","routeSlug":"/v1-api-reference/api/ramps/get_rampmetricsbysubscriptionkey","metadata":{"seo":{"title":"List ramp metrics by subscription key","description":"Note: This operation is only available if you have the Ramps feature enabled. The Orders feature must be enabled before you can access the Ramps feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information coming October 2020."}},"httpPath":"/v1/subscriptions/{subscriptionKey}/ramp-metrics"},{"label":"List ramp metrics by order number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/ramps/get_rampmetricsbyordernumber","routeSlug":"/v1-api-reference/api/ramps/get_rampmetricsbyordernumber","metadata":{"seo":{"title":"List ramp metrics by order number","description":"Note: This operation is only available if you have the Ramps feature enabled. The Orders feature must be enabled before you can access the Ramps feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information coming October 2020."}},"httpPath":"/v1/orders/{orderNumber}/ramp-metrics"}]},{"type":"group","label":"Subscriptions","link":"/v1-api-reference/api/subscriptions","routeSlug":"/v1-api-reference/api/subscriptions","items":[{"label":"Preview a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/post_previewsubscription","routeSlug":"/v1-api-reference/api/subscriptions/post_previewsubscription","metadata":{"seo":{"title":"Preview a subscription","description":"The REST API reference describes how to create a new subscription in preview mode. This call does not require a valid customer account. It can be used to show potential new customers a preview of a subscription with complete details and charges before creating an account, or to let existing customers preview a subscription with all charges before committing."}},"httpPath":"/v1/subscriptions/preview"},{"label":"Preview a subscription by subscription key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/previewexistingsubscription","routeSlug":"/v1-api-reference/api/subscriptions/previewexistingsubscription","metadata":{"seo":{"title":"Preview a subscription by subscription key","description":"Describes how to preview an existing subscription to view information about existing and future invoices or credit memos."}},"httpPath":"/v1/subscriptions/{subscription-key}/preview"},{"label":"Create a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/post_subscription","routeSlug":"/v1-api-reference/api/subscriptions/post_subscription","metadata":{"seo":{"title":"Create a subscription","description":"This operation describes how to create a new subscription for an existing customer account."}},"httpPath":"/v1/subscriptions"},{"label":"List subscriptions by account key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/get_subscriptionsbyaccount","routeSlug":"/v1-api-reference/api/subscriptions/get_subscriptionsbyaccount","metadata":{"seo":{"title":"List subscriptions by account key","description":"Retrieves all subscriptions associated with the specified account. Zuora only returns the latest version of the subscriptions."}},"httpPath":"/v1/subscriptions/accounts/{account-key}"},{"label":"Retrieve a subscription by key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/get_subscriptionsbykey","routeSlug":"/v1-api-reference/api/subscriptions/get_subscriptionsbykey","metadata":{"seo":{"title":"Retrieve a subscription by key","description":"This REST API reference describes how to retrieve detailed information about a specified subscription in the latest version."}},"httpPath":"/v1/subscriptions/{subscription-key}"},{"label":"Update a subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/put_subscription","routeSlug":"/v1-api-reference/api/subscriptions/put_subscription","metadata":{"seo":{"title":"Update a subscription","description":"Use this call to make the following kinds of changes to a subscription:"}},"httpPath":"/v1/subscriptions/{subscription-key}"},{"label":"Retrieve a subscription by key and version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/get_subscriptionsbykeyandversion","routeSlug":"/v1-api-reference/api/subscriptions/get_subscriptionsbykeyandversion","metadata":{"seo":{"title":"Retrieve a subscription by key and version","description":"This REST API reference describes how to retrieve detailed information about a specified subscription in a specified version. When you create a subscription amendment, you create a new version of the subscription. You can use this method to retrieve information about a subscription in any version."}},"httpPath":"/v1/subscriptions/{subscription-key}/versions/{version}"},{"label":"Renew a subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/put_renewsubscription","routeSlug":"/v1-api-reference/api/subscriptions/put_renewsubscription","metadata":{"seo":{"title":"Renew a subscription","description":"Renews a termed subscription using existing renewal terms. When you renew a subscription, the current subscription term is extended by creating a new term.  If any charge in your subscription has the billing period set as SubscriptionTerm, a new charge segment is generated for the new term."}},"httpPath":"/v1/subscriptions/{subscription-key}/renew"},{"label":"Cancel a subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/put_cancelsubscription","routeSlug":"/v1-api-reference/api/subscriptions/put_cancelsubscription","metadata":{"seo":{"title":"Cancel a subscription","description":"This REST API reference describes how to cancel an active subscription."}},"httpPath":"/v1/subscriptions/{subscription-key}/cancel"},{"label":"Resume a subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/put_resumesubscription","routeSlug":"/v1-api-reference/api/subscriptions/put_resumesubscription","metadata":{"seo":{"title":"Resume a subscription","description":"This REST API reference describes how to resume a suspended subscription."}},"httpPath":"/v1/subscriptions/{subscription-key}/resume"},{"label":"Suspend a subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/put_suspendsubscription","routeSlug":"/v1-api-reference/api/subscriptions/put_suspendsubscription","metadata":{"seo":{"title":"Suspend a subscription","description":"This REST API reference describes how to suspend an active subscription."}},"httpPath":"/v1/subscriptions/{subscription-key}/suspend"},{"label":"Delete a subscription by number","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/put_deletesubscription","routeSlug":"/v1-api-reference/api/subscriptions/put_deletesubscription","metadata":{"seo":{"title":"Delete a subscription by number","description":"This REST API reference describes how to delete a subscription of the specified subscription number."}},"httpPath":"/v1/subscriptions/{subscription-key}/delete"},{"label":"Update subscription custom fields of a subscription version","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/put_updatesubscriptioncustomfieldsofaspecifiedversion","routeSlug":"/v1-api-reference/api/subscriptions/put_updatesubscriptioncustomfieldsofaspecifiedversion","metadata":{"seo":{"title":"Update subscription custom fields of a subscription version","description":"Updates the custom fields of a specified subscription version."}},"httpPath":"/v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields"},{"label":"List subscription metrics by subscription numbers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/getmetricsbysubscriptionnumbers","routeSlug":"/v1-api-reference/api/subscriptions/getmetricsbysubscriptionnumbers","metadata":{"seo":{"title":"List subscription metrics by subscription numbers","description":"Lists subscription metrics for the subscriptions that you specify by subscription numbers."}},"httpPath":"/v1/subscriptions/subscription-metrics"}]},{"type":"group","label":"Omnichannel Subscriptions","link":"/v1-api-reference/api/omnichannel-subscriptions","routeSlug":"/v1-api-reference/api/omnichannel-subscriptions","items":[{"label":"Create an omnichannel subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/omnichannel-subscriptions/postomnichannelsubscription","routeSlug":"/v1-api-reference/api/omnichannel-subscriptions/postomnichannelsubscription","metadata":{"seo":{"title":"Create an omnichannel subscription","description":"Creates or updates an omnichannel subscription for a customer account."}},"httpPath":"/v1/omni-channel-subscriptions"},{"label":"Retrieve an omnichannel subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/omnichannel-subscriptions/getomnichannelsubscription","routeSlug":"/v1-api-reference/api/omnichannel-subscriptions/getomnichannelsubscription","metadata":{"seo":{"title":"Retrieve an omnichannel subscription","description":"Retrieves the information about a specific omnichannel subscription."}},"httpPath":"/v1/omni-channel-subscriptions/{subscriptionKey}"},{"label":"Delete an omnichannel subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/omnichannel-subscriptions/deleteomnichannelsubscription","routeSlug":"/v1-api-reference/api/omnichannel-subscriptions/deleteomnichannelsubscription","metadata":{"seo":{"title":"Delete an omnichannel subscription","description":"Deletes a specified omnichannel subscription."}},"httpPath":"/v1/omni-channel-subscriptions/{subscriptionKey}"}]},{"type":"group","label":"Rate Plans","link":"/v1-api-reference/api/rate-plans","routeSlug":"/v1-api-reference/api/rate-plans","items":[{"label":"Retrieve a rate plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/rate-plans/get_rateplan","routeSlug":"/v1-api-reference/api/rate-plans/get_rateplan","metadata":{"seo":{"title":"Retrieve a rate plan","description":"Retrieves the detailed information about a specific subscription rate plan."}},"httpPath":"/v1/rateplans/{ratePlanId}"}]},{"type":"group","label":"Commitments","link":"/v1-api-reference/api/commitments","routeSlug":"/v1-api-reference/api/commitments","items":[{"label":"List commitments for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commitments/getcommitments","routeSlug":"/v1-api-reference/api/commitments/getcommitments","metadata":{"seo":{"title":"List commitments for an account","description":"Retrieves a paginated list of commitments for a commitment owner account."}},"httpPath":"/commitments"},{"label":"Retrieve a commitment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commitments/getcommitmentbykey","routeSlug":"/v1-api-reference/api/commitments/getcommitmentbykey","metadata":{"seo":{"title":"Retrieve a commitment","description":"Retrieves the details of a specific commitment using its ID or number."}},"httpPath":"/commitments/{commitmentKey}"},{"label":"List periods for a commitment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commitments/getcommitmentperiods","routeSlug":"/v1-api-reference/api/commitments/getcommitmentperiods","metadata":{"seo":{"title":"List periods for a commitment","description":"Lists periods of the commitment. You can paginate the results using page and pageSize query parameters."}},"httpPath":"/commitments/periods"},{"label":"Preview the balance for a commitment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commitments/getcommitmentbalancepreview","routeSlug":"/v1-api-reference/api/commitments/getcommitmentbalancepreview","metadata":{"seo":{"title":"Preview the balance for a commitment","description":"Preview the balance for a commitment for current and past periods.Future periods are not covered."}},"httpPath":"/commitments/{commitmentId}/balancepreview"},{"label":"List schedules for a commitment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commitments/listcommitmentschedules","routeSlug":"/v1-api-reference/api/commitments/listcommitmentschedules","metadata":{"seo":{"title":"List schedules for a commitment","description":"Retrieves all the schedules for a specific commitment."}},"httpPath":"/commitments/{commitmentKey}/schedules"},{"label":"Expire a commitment-linked prepayment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commitments/expireprepayment","routeSlug":"/v1-api-reference/api/commitments/expireprepayment","metadata":{"seo":{"title":"Expire a commitment-linked prepayment","description":"Expires a single commitment-linked prepayment and returns the updated prepayment state."}},"httpPath":"/prepayments/{prepaymentId}/expire"},{"label":"List the change history for a commitment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commitments/listcommitmenthistoricalchanges","routeSlug":"/v1-api-reference/api/commitments/listcommitmenthistoricalchanges","metadata":{"seo":{"title":"List the change history for a commitment","description":"Lists the historical changes made to a specific commitment, ordered by the most recent changes first."}},"httpPath":"/commitments/{commitmentKey}/commitmentChanges"}]},{"type":"separator","label":"Advanced Consumption Billing"},{"type":"group","label":"Prepaid with Drawdown","link":"/v1-api-reference/api/prepaid-with-drawdown","routeSlug":"/v1-api-reference/api/prepaid-with-drawdown","items":[{"label":"Reverse fund rollover","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/prepaid-with-drawdown/post_reverserollover","routeSlug":"/v1-api-reference/api/prepaid-with-drawdown/post_reverserollover","metadata":{"seo":{"title":"Reverse fund rollover","description":"This REST API reference describes how to manually reverse fund rollover from source validity period to destination validity period. There are no path or query parameters."}},"httpPath":"/v1/ppdd/reverse-rollover"},{"label":"Trigger fund rollover","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/prepaid-with-drawdown/post_rollover","routeSlug":"/v1-api-reference/api/prepaid-with-drawdown/post_rollover","metadata":{"seo":{"title":"Trigger fund rollover","description":"Prepaid with Drawdown Rollover enables you to transfer the accumulative carryover of your customers’ prepaid balance funds to the following validity period when using Prepaid with Drawdown. This REST API reference describes how to manually trigger fund rollover from source validity period to destination validity period. There are no path or query parameters."}},"httpPath":"/v1/ppdd/rollover"},{"label":"Deplete funds","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/prepaid-with-drawdown/expireprepaidfunds","routeSlug":"/v1-api-reference/api/prepaid-with-drawdown/expireprepaidfunds","metadata":{"seo":{"title":"Deplete funds","description":"Depletes prepaid balance funds."}},"httpPath":"/v1/prepaid-balance-funds/deplete"}]},{"type":"separator","label":"Usage"},{"type":"group","label":"Usage","link":"/v1-api-reference/api/usage","routeSlug":"/v1-api-reference/api/usage","items":[{"type":"link","label":"Note on dynamic pricing usage charges","link":"/v1-api-reference/api/usage/note-on-dynamic-pricing-usage-charges","routeSlug":"/v1-api-reference/api/usage/note-on-dynamic-pricing-usage-charges"},{"label":"Upload a usage file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/usage/post_usage","routeSlug":"/v1-api-reference/api/usage/post_usage","metadata":{"seo":{"title":"Upload a usage file","description":"This REST API reference describes how to post or import usage data for one or more accounts in the CSV format. There are no path or query parameters. The data is uploaded using the HTTP multipart/form-data POST method and applied to the user's tenant."}},"httpPath":"/v1/usage"},{"label":"Retrieve usage rate detail for an invoice item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/usage/get_usage_rate_detail_by_invoice_item","routeSlug":"/v1-api-reference/api/usage/get_usage_rate_detail_by_invoice_item","metadata":{"seo":{"title":"Retrieve usage rate detail for an invoice item","description":"Use this REST API operation to retrieve the usage rate detail for an invoice item to understand how the total amount is calculated. The information is the same as the Rate Detail presented on PDF invoices."}},"httpPath":"/v1/invoices/invoice-item/{invoice-item-id}/usage-rate-detail"},{"label":"CRUD: Create a usage record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/usage/object_postusage","routeSlug":"/v1-api-reference/api/usage/object_postusage","metadata":{"seo":{"title":"CRUD: Create a usage record","description":"Creates a usage record."}},"httpPath":"/v1/object/usage"},{"label":"CRUD: Delete a usage record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/usage/object_deleteusage","routeSlug":"/v1-api-reference/api/usage/object_deleteusage","metadata":{"seo":{"title":"CRUD: Delete a usage record","description":"Deletes a usage record. Usage records that are associated with a dynamic pricing usage charge cannot be deleted with this legacy Billing endpoint. When a delete request targets such a record, the operation fails and the usage record is not removed. Operations on dynamic pricing usage are supported only via Mediation-driven flows."}},"httpPath":"/v1/object/usage/{id}"},{"label":"CRUD: Retrieve a usage record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/usage/object_getusage","routeSlug":"/v1-api-reference/api/usage/object_getusage","metadata":{"seo":{"title":"CRUD: Retrieve a usage record","description":"Retrieve a usage record."}},"httpPath":"/v1/object/usage/{id}"},{"label":"CRUD: Update a usage record","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/usage/object_putusage","routeSlug":"/v1-api-reference/api/usage/object_putusage","metadata":{"seo":{"title":"CRUD: Update a usage record","description":"Updates a usage record. Updating usage records that are associated with a dynamic pricing usage charge is not supported through this endpoint. The request fails and the record is not updated. Use Mediation-based flows to manage such usage."}},"httpPath":"/v1/object/usage/{id}"}]},{"type":"separator","label":"Mediation"},{"type":"group","label":"Meters","link":"/v1-api-reference/api/meters","routeSlug":"/v1-api-reference/api/meters","items":[{"label":"Run a specific version of a meter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/meters/runspecificversionofmeter","routeSlug":"/v1-api-reference/api/meters/runspecificversionofmeter","metadata":{"seo":{"title":"Run a specific version of a meter","description":"Executes a specific version of a meter in Zuora Mediation. You can choose to run it with either a local file or event store source by providing optional configurations."}},"httpPath":"/meters/run/{meterId}/{version}"},{"label":"Stop a specific version of a meter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/meters/stopmeterversion","routeSlug":"/v1-api-reference/api/meters/stopmeterversion","metadata":{"seo":{"title":"Stop a specific version of a meter","description":"Stops all runnable NORMAL-mode runs for a specific version of a meter in Zuora Mediation."}},"httpPath":"/meters/stop/{meterId}/{version}"},{"label":"Test a specific version of a meter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/meters/testspecificversionofmeter","routeSlug":"/v1-api-reference/api/meters/testspecificversionofmeter","metadata":{"seo":{"title":"Test a specific version of a meter","description":"Test a specific version of a meter in Zuora Mediation without executing a full run. It supports multiple input methods, including uploaded files, sample files, and manual test data. This is useful for validating meter logic and transformations before meter run."}},"httpPath":"/meters/debug/{meterId}/{version}"},{"label":"Retrieve summary data for a meter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/meters/retrievemetersummarydata","routeSlug":"/v1-api-reference/api/meters/retrievemetersummarydata","metadata":{"seo":{"title":"Retrieve summary data for a meter","description":"Retrieves summary data for a specific meter in Zuora Mediation, providing a rolled-up view of a meter run or time window. The API supports grouping by Operator ID, Error Code, or Session ID, and allows optional filters such as Query From Time, Query To Time, Operator IDs, and Session IDs. The API returns aggregated output and error counts per group and includes validation with detailed error responses for invalid parameters or formats."}},"httpPath":"/meters/{meterId}/summary"},{"label":"Retrieve the run status of a specific meter version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/meters/getrunstatusofspecificmeterversion","routeSlug":"/v1-api-reference/api/meters/getrunstatusofspecificmeterversion","metadata":{"seo":{"title":"Retrieve the run status of a specific meter version","description":"Retrieves the current run status of a specific meter version in Zuora Mediation. It returns an integer code indicating the status, such as RUNNING, COMPLETED, or FAILED, which helps monitor the meter's execution state."}},"httpPath":"/meters/{meterId}/{version}/runStatus"},{"label":"Export details of a specific meter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/meters/exportspecificmeter","routeSlug":"/v1-api-reference/api/meters/exportspecificmeter","metadata":{"seo":{"title":"Export details of a specific meter","description":"The Export Meter operation exports the full definition of a specific meter in Zuora Mediation, including metadata, all versions, event schemas, and operator configurations (source, processor, sink). It's useful for reviewing, backing up, or replicating meter setups across environments."}},"httpPath":"/meters/export/{meterId}"},{"label":"Import a meter definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/meters/importmeterdefinition","routeSlug":"/v1-api-reference/api/meters/importmeterdefinition","metadata":{"seo":{"title":"Import a meter definition","description":"Import a meter definition into Zuora Mediation using a file exported from the Export Meter API."}},"httpPath":"/meters/import"}]},{"type":"group","label":"Data Ingestion","link":"/v1-api-reference/api/data-ingestion","routeSlug":"/v1-api-reference/api/data-ingestion","items":[{"label":"Upload a file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-ingestion/uploadmeteringfile","routeSlug":"/v1-api-reference/api/data-ingestion/uploadmeteringfile","metadata":{"seo":{"title":"Upload a file","description":"Uploads and stores a file in Zuora Mediation for use in meter processing. Supported formats include CSV, Excel, and JSON. You can specify metadata like headers, delimiters, sheets, and data ranges."}},"httpPath":"/meters/files"},{"label":"Ingest usage events for a meter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-ingestion/ingestusageevents","routeSlug":"/v1-api-reference/api/data-ingestion/ingestusageevents","metadata":{"seo":{"title":"Ingest usage events for a meter","description":"Ingests usage events directly into Zuora Mediation in real time. You can send a single event or batch multiple events in a JSON array to optimize throughput. Each event must conform to the meter's event schema. This operation is supported only for meters that use the Streaming API as their source in Zuora Mediation. You can use this API to bulk-ingest events into a meter only when the meter's source is configured as a Streaming API operator. For meters that use other sources, use the appropriate ingestion mechanism for that source instead."}},"httpPath":"/usage/bulk/{meterGlobalId}"}]},{"type":"group","label":"Audit Trail","link":"/v1-api-reference/api/audit-trail","routeSlug":"/v1-api-reference/api/audit-trail","items":[{"label":"Retrieve the audit trail entries for a meter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-trail/getaudittrailentriesformeter","routeSlug":"/v1-api-reference/api/audit-trail/getaudittrailentriesformeter","metadata":{"seo":{"title":"Retrieve the audit trail entries for a meter","description":"Retrieves the audit trail entries for a specific meter in Zuora Mediation. The API provides detailed, record-level information about what happened during processing, including Payload and error details, operator information, and the trace ID/event ID."}},"httpPath":"/meters/{meterId}/auditTrail/entries"},{"label":"Retrieve the list of export jobs for a meter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-trail/getaudittrailexportjobs","routeSlug":"/v1-api-reference/api/audit-trail/getaudittrailexportjobs","metadata":{"seo":{"title":"Retrieve the list of export jobs for a meter","description":"Retrieves the list of previously initiated export jobs for a specific meter in Zuora Mediation.You can filter the results by export type, session IDs, or request ID by using the exportType,sessionIds, and requestId query parameters. Use the requestId returned when you create an exportjob to retrieve a specific job. If requestId is omitted, the API returns the list of export jobs.Use the status and fileList fields to determine whether a job is complete and which files to download.Then use the \"Retrieve the presigned URL for an export job\" operation with each fileKey in fileListto obtain the download URLs."}},"httpPath":"/meters/{meterId}/auditTrail/export"},{"label":"Create a job to export audit trail data for a meter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-trail/createaudittrailexportjob","routeSlug":"/v1-api-reference/api/audit-trail/createaudittrailexportjob","metadata":{"seo":{"title":"Create a job to export audit trail data for a meter","description":"Creates a background job to export the audit trail entries for a specific meter in Zuora Mediation.This API is for large-scale, offline access to audit data. Only one export job is processed per tenantat a time, and each export has a record limit, for example, up to 5 million rows per report.Use the returned requestId as the requestId query parameter with the \"Retrieve the list of export jobs for a meter\"operation to track the status of that specific job and retrieve the generated file names from fileList.Then use the \"Retrieve the presigned URL for an export job\" operation with each fileKey in fileList todownload the files."}},"httpPath":"/meters/{meterId}/auditTrail/export"},{"label":"Retrieve the presigned URL for an export job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-trail/getpresignedurlformeterexport","routeSlug":"/v1-api-reference/api/audit-trail/getpresignedurlformeterexport","metadata":{"seo":{"title":"Retrieve the presigned URL for an export job","description":"Returns a pre-signed URL that you can use to download a specific export file (usually from object storage such as S3). The fileKey corresponds to one entry from the fileList array in the List API. Use the returned URL in the data field directly in a browser or via a HTTP client to download the export file."}},"httpPath":"/meters/auditTrail/presignedUrl"},{"label":"List prefetch audit records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-trail/listprefetchauditrecords","routeSlug":"/v1-api-reference/api/audit-trail/listprefetchauditrecords","metadata":{"seo":{"title":"List prefetch audit records","description":"List audit records for prefetch operations by processor ID with filtering and cursor-based pagination."}},"httpPath":"/meters/{meterId}/prefetchAudit"}]},{"type":"group","label":"Event Store","link":"/v1-api-reference/api/event-store","routeSlug":"/v1-api-reference/api/event-store","items":[{"label":"Bulk delete events from an event store","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/event-store/bulkdeleteeventsfromeventstore","routeSlug":"/v1-api-reference/api/event-store/bulkdeleteeventsfromeventstore","metadata":{"seo":{"title":"Bulk delete events from an event store","description":"Allows you to delete multiple events from an event store in Zuora Mediation using a file that lists the event IDs to be removed. It is useful for cleaning up or correcting data in bulk."}},"httpPath":"/meters/events/bulkDelete"},{"label":"Retrieve the latest query job of a specific event store","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/event-store/getlatestqueryjobofspecificeventstore","routeSlug":"/v1-api-reference/api/event-store/getlatestqueryjobofspecificeventstore","metadata":{"seo":{"title":"Retrieve the latest query job of a specific event store","description":"Retrieves the most recent query job executed on a specific event store in Zuora Mediation. It returns metadata such as query type (for example, DELETE), status, record counts, and timestamps."}},"httpPath":"/meters/events/stores/{eventStoreId}/jobs/latest"},{"label":"Truncate all data from an event store","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/event-store/truncateeventstore","routeSlug":"/v1-api-reference/api/event-store/truncateeventstore","metadata":{"seo":{"title":"Truncate all data from an event store","description":"Truncates (deletes) all events from a specific event store in Zuora Mediation."}},"httpPath":"/meters/events/stores/{eventStoreId}/truncate"},{"label":"Submit an event store query","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/event-store/submiteventstorequery","routeSlug":"/v1-api-reference/api/event-store/submiteventstorequery","metadata":{"seo":{"title":"Submit an event store query","description":"Submits a SQL-style asynchronous query to the Event Store to retrieve and inspect metering events for validation, troubleshooting, and reconciliation. The API returns a queryId that can be used to poll and fetch paginated results."}},"httpPath":"/meters/event-store-queries"},{"label":"Retrieve the results for an event store query","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/event-store/getqueryresultsforeventstore","routeSlug":"/v1-api-reference/api/event-store/getqueryresultsforeventstore","metadata":{"seo":{"title":"Retrieve the results for an event store query","description":"Retrieves paginated result rows and column metadata for a previously submitted Event Store query using its queryId, including total row count, row-level field values, and readiness status. Query execution is asynchronous."}},"httpPath":"/meters/event-store-queries/{queryId}"}]},{"type":"separator","label":"Billing Documents"},{"type":"group","label":"Delivery Adjustments","link":"/v1-api-reference/api/delivery-adjustments","routeSlug":"/v1-api-reference/api/delivery-adjustments","items":[{"label":"List all delivery adjustments of a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/delivery-adjustments/get_subscription_adjustments","routeSlug":"/v1-api-reference/api/delivery-adjustments/get_subscription_adjustments","metadata":{"seo":{"title":"List all delivery adjustments of a subscription","description":"Describes how to retrieve detailed information about delivery adjustments of a subscription."}},"httpPath":"/v1/adjustments"},{"label":"Create a delivery adjustment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/delivery-adjustments/create_adjustment","routeSlug":"/v1-api-reference/api/delivery-adjustments/create_adjustment","metadata":{"seo":{"title":"Create a delivery adjustment","description":"Describes how to create one or more delivery adjustments for a subscription."}},"httpPath":"/v1/adjustments"},{"label":"Preview a delivery adjustment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/delivery-adjustments/preview_adjustment","routeSlug":"/v1-api-reference/api/delivery-adjustments/preview_adjustment","metadata":{"seo":{"title":"Preview a delivery adjustment","description":"Describes how to preview delivery adjustments of a subscription."}},"httpPath":"/v1/adjustments/preview"},{"label":"Retrieve a delivery adjustment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/delivery-adjustments/get_adjustment","routeSlug":"/v1-api-reference/api/delivery-adjustments/get_adjustment","metadata":{"seo":{"title":"Retrieve a delivery adjustment","description":"Describes how to retrieve detailed information about a delivery adjustment."}},"httpPath":"/v1/adjustments/{adjustment-key}"},{"label":"Cancel a delivery adjustment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/delivery-adjustments/put_canceladjustment","routeSlug":"/v1-api-reference/api/delivery-adjustments/put_canceladjustment","metadata":{"seo":{"title":"Cancel a delivery adjustment","description":"Describes how to cancel an unbilled delivery adjustment."}},"httpPath":"/v1/adjustments/{adjustmentId}/cancel"}]},{"type":"group","label":"Billing Documents","link":"/v1-api-reference/api/billing-documents","routeSlug":"/v1-api-reference/api/billing-documents","items":[{"label":"List billing documents for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/billing-documents/get_billingdocuments","routeSlug":"/v1-api-reference/api/billing-documents/get_billingdocuments","metadata":{"seo":{"title":"List billing documents for an account","description":"Retrieves the information about all billing documents associated with a specified account. The billing documents contain invoices, credit memos, and debit memos."}},"httpPath":"/v1/billing-documents"},{"label":"Create a job to hard delete billing document files","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/billing-documents/post_billingdocumentfilesdeletionjob","routeSlug":"/v1-api-reference/api/billing-documents/post_billingdocumentfilesdeletionjob","metadata":{"seo":{"title":"Create a job to hard delete billing document files","description":"Creates an asynchronous job to permanently delete all billing document PDF files for specific accounts."}},"httpPath":"/v1/accounts/billing-documents/files/deletion-jobs"},{"label":"Retrieve a job of hard deleting billing document files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/billing-documents/get_billingdocumentfilesdeletionjob","routeSlug":"/v1-api-reference/api/billing-documents/get_billingdocumentfilesdeletionjob","metadata":{"seo":{"title":"Retrieve a job of hard deleting billing document files","description":"Retrieves information about an asynchronous job of permanently deleting all billing document PDF files for specific accounts."}},"httpPath":"/v1/accounts/billing-documents/files/deletion-jobs/{jobId}"},{"label":"Generate billing documents by account ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/billing-documents/post_generatebillingdocuments","routeSlug":"/v1-api-reference/api/billing-documents/post_generatebillingdocuments","metadata":{"seo":{"title":"Generate billing documents by account ID","description":"Generates draft or posted billing documents for a specified account. You can also generate billing documents for specified subscriptions of a specified account. The billing documents contain invoices and credit memos. To generate credit memos, you must have the Invoice Settlement feature enabled."}},"httpPath":"/v1/accounts/{key}/billing-documents/generate"}]},{"type":"group","label":"Invoices","link":"/v1-api-reference/api/invoices","routeSlug":"/v1-api-reference/api/invoices","items":[{"label":"Create a standalone invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/post_standaloneinvoice","routeSlug":"/v1-api-reference/api/invoices/post_standaloneinvoice","metadata":{"seo":{"title":"Create a standalone invoice","description":"Creates a standalone invoice for selling physical goods, services or other items on a non-recurring basis to your subscription customers."}},"httpPath":"/v1/invoices"},{"label":"Update invoices","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/put_batchupdateinvoices","routeSlug":"/v1-api-reference/api/invoices/put_batchupdateinvoices","metadata":{"seo":{"title":"Update invoices","description":"Updates multiple invoices in batches with one call. The following tutorials demonstrate how to use this operation:"}},"httpPath":"/v1/invoices"},{"label":"Create standalone invoices","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/post_standaloneinvoices","routeSlug":"/v1-api-reference/api/invoices/post_standaloneinvoices","metadata":{"seo":{"title":"Create standalone invoices","description":"Creates multiple standalone invoices for selling physical goods, services or other items on a non-recurring basis to your subscription customers."}},"httpPath":"/v1/invoices/batch"},{"label":"Post invoices","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/post_postinvoices","routeSlug":"/v1-api-reference/api/invoices/post_postinvoices","metadata":{"seo":{"title":"Post invoices","description":"Posts multiple invoices."}},"httpPath":"/v1/invoices/bulk-post"},{"label":"Retrieve the PDF file generation status of invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/getinvoicepdfstatus","routeSlug":"/v1-api-reference/api/invoices/getinvoicepdfstatus","metadata":{"seo":{"title":"Retrieve the PDF file generation status of invoices","description":"Retrieves the PDF generation statuses of a batch of invoices."}},"httpPath":"/v1/invoices/pdf-status"},{"label":"Delete an invoice","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/delete_deleteinvoice","routeSlug":"/v1-api-reference/api/invoices/delete_deleteinvoice","metadata":{"seo":{"title":"Delete an invoice","description":"Deletes a specific invoice."}},"httpPath":"/v1/invoices/{invoiceKey}"},{"label":"Retrieve an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/get_getinvoice","routeSlug":"/v1-api-reference/api/invoices/get_getinvoice","metadata":{"seo":{"title":"Retrieve an invoice","description":"Retrieves a specific invoice."}},"httpPath":"/v1/invoices/{invoiceKey}"},{"label":"Update an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/put_updateinvoice","routeSlug":"/v1-api-reference/api/invoices/put_updateinvoice","metadata":{"seo":{"title":"Update an invoice","description":"Updates a specific invoice.The following tutorials demonstrate how to use this operation:"}},"httpPath":"/v1/invoices/{invoiceKey}"},{"label":"Cancel an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/cancelinvoice","routeSlug":"/v1-api-reference/api/invoices/cancelinvoice","metadata":{"seo":{"title":"Cancel an invoice","description":"Cancel the invoice synchronously or asynchronously based on the number of invoiceitems it contains. By default, Zuora cancels invoices with fewer than 1,000 invoiceitems synchronously and cancels invoices with 1,000 or more invoice items asynchronously."}},"httpPath":"/v1/invoices/{invoiceKey}/cancel"},{"label":"List all application parts of an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/get_invoiceapplicationparts","routeSlug":"/v1-api-reference/api/invoices/get_invoiceapplicationparts","metadata":{"seo":{"title":"List all application parts of an invoice","description":"Note: This operation is only available if you have Invoice Settlementenabled. The Invoice Settlement feature is generally available as of Zuora BillingRelease 296 (March 2021). This feature includes Unapplied Payments, Credit andDebit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement,see Invoice Settlement Enablement and Checklist Guidefor more information.If you are using Zuora version 341 or later, this operation returns only processed payments applied to the invoice. If you are using a version earlier than 341, the behavior remains unchanged, and this operation returns all payments associated with the invoice, regardless of payment status.Retrieves information about the payments or credit memos that are applied to aspecified invoice."}},"httpPath":"/v1/invoices/{invoiceKey}/application-parts"},{"label":"Email an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/post_emailinvoice","routeSlug":"/v1-api-reference/api/invoices/post_emailinvoice","metadata":{"seo":{"title":"Email an invoice","description":"Sends a posted invoice to the specified email addresses manually."}},"httpPath":"/v1/invoices/{invoiceKey}/emails"},{"label":"List all files of an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/get_invoicefiles","routeSlug":"/v1-api-reference/api/invoices/get_invoicefiles","metadata":{"seo":{"title":"List all files of an invoice","description":"Retrieves the information about all PDF files of a specified invoice."}},"httpPath":"/v1/invoices/{invoiceKey}/files"},{"label":"Upload a file for an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/post_uploadfileforinvoice","routeSlug":"/v1-api-reference/api/invoices/post_uploadfileforinvoice","metadata":{"seo":{"title":"Upload a file for an invoice","description":"Uploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status.To use this operation, you must enable the Modify Invoice permission. See Billing Permissions for more information.This operation has the following restrictions:"}},"httpPath":"/v1/invoices/{invoiceKey}/files"},{"label":"List all items of an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/get_invoiceitems","routeSlug":"/v1-api-reference/api/invoices/get_invoiceitems","metadata":{"seo":{"title":"List all items of an invoice","description":"Retrieves the information about all items of a specified invoice."}},"httpPath":"/v1/invoices/{invoiceKey}/items"},{"label":"List all taxation items of an invoice item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/get_taxationitemsofinvoiceitem","routeSlug":"/v1-api-reference/api/invoices/get_taxationitemsofinvoiceitem","metadata":{"seo":{"title":"List all taxation items of an invoice item","description":"Retrieves information about the taxation items of a specific invoice item."}},"httpPath":"/v1/invoices/{invoiceKey}/items/{itemId}/taxation-items"},{"label":"Reverse an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/put_reverseinvoice","routeSlug":"/v1-api-reference/api/invoices/put_reverseinvoice","metadata":{"seo":{"title":"Reverse an invoice","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/invoices/{invoiceKey}/reverse"},{"label":"Split an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/splitinvoice","routeSlug":"/v1-api-reference/api/invoices/splitinvoice","metadata":{"seo":{"title":"Split an invoice","description":"Splits a draft invoice into 2 to 20 invoices based on specified amounts or percentages. The source invoice must be in Draft status. For amount-based splits, the sum of all split amounts must exactly equal the original invoice total, and each split amount must be at least the minimum currency unit. For percentage-based splits, the sum of all split percentages must be exactly 100, up to 9 decimal places. Zuora distributes charges, discounts, tax amounts, and tax-exempt amounts proportionally across split invoices and uses a Largest Remainder algorithm to ensure precise rounding at both the line and invoice levels."}},"httpPath":"/v1/invoices/{invoiceKey}/split"},{"label":"Create taxation items for an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/post_inv_taxationitems","routeSlug":"/v1-api-reference/api/invoices/post_inv_taxationitems","metadata":{"seo":{"title":"Create taxation items for an invoice","description":"Creates taxation items for an invoice."}},"httpPath":"/v1/invoices/{invoiceKey}/taxation-items"},{"label":"Write off an invoice asynchronously","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/writeoffinvoiceasync","routeSlug":"/v1-api-reference/api/invoices/writeoffinvoiceasync","metadata":{"seo":{"title":"Write off an invoice asynchronously","description":"Asynchronously writes off a posted invoice. By writing off an invoice, a credit memo is created and applied to the invoice. If theinvoice contains more than 2,000 items, this operation is performed asynchronously. Use the Retrieve invoice write-off async joboperation to track the status of the async job."}},"httpPath":"/v1/invoices/{invoiceKey}/write-off-async"},{"label":"Retrieve an invoice write-off async job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/retrieveinvoicewriteoffasyncjob","routeSlug":"/v1-api-reference/api/invoices/retrieveinvoicewriteoffasyncjob","metadata":{"seo":{"title":"Retrieve an invoice write-off async job","description":"Retrieves information about a specific asynchronous invoice write-off job."}},"httpPath":"/v1/invoices/write-off-async-jobs/{asyncJobId}"},{"label":"Write off an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/put_writeoffinvoice","routeSlug":"/v1-api-reference/api/invoices/put_writeoffinvoice","metadata":{"seo":{"title":"Write off an invoice","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/invoices/{invoiceKey}/write-off"},{"label":"Unpost an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/unpostinvoice","routeSlug":"/v1-api-reference/api/invoices/unpostinvoice","metadata":{"seo":{"title":"Unpost an invoice","description":"Unposts a posted invoice and changes its status to Draft."}},"httpPath":"/v1/invoices/{invoiceKey}/unpost"}]},{"type":"group","label":"Credit Memos","link":"/v1-api-reference/api/credit-memos","routeSlug":"/v1-api-reference/api/credit-memos","items":[{"label":"List credit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemos","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemos","metadata":{"seo":{"title":"List credit memos","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos"},{"label":"Create a credit memo from a charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_creditmemofromprpc","routeSlug":"/v1-api-reference/api/credit-memos/post_creditmemofromprpc","metadata":{"seo":{"title":"Create a credit memo from a charge","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos"},{"label":"Create credit memos","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_createcreditmemos","routeSlug":"/v1-api-reference/api/credit-memos/post_createcreditmemos","metadata":{"seo":{"title":"Create credit memos","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/bulk"},{"label":"Update credit memos","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_updatecreditmemos","routeSlug":"/v1-api-reference/api/credit-memos/put_updatecreditmemos","metadata":{"seo":{"title":"Update credit memos","description":"Notes:"}},"httpPath":"/v1/credit-memos/bulk"},{"label":"Retrieve the PDF file generation status of credit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemopdfstatus","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemopdfstatus","metadata":{"seo":{"title":"Retrieve the PDF file generation status of credit memos","description":"Retrieves the PDF generation statuses of a batch of credit memos."}},"httpPath":"/v1/credit-memos/pdf-status"},{"label":"List all taxation items of a credit memo item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_taxationitemsofcreditmemoitem","routeSlug":"/v1-api-reference/api/credit-memos/get_taxationitemsofcreditmemoitem","metadata":{"seo":{"title":"List all taxation items of a credit memo item","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoId}/items/{cmitemid}/taxation-items"},{"label":"Write off a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_writeoffcreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_writeoffcreditmemo","metadata":{"seo":{"title":"Write off a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoId}/write-off"},{"label":"Delete a credit memo","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/delete_creditmemo","routeSlug":"/v1-api-reference/api/credit-memos/delete_creditmemo","metadata":{"seo":{"title":"Delete a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}"},{"label":"Retrieve a credit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemo","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemo","metadata":{"seo":{"title":"Retrieve a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}"},{"label":"Update a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_updatecreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_updatecreditmemo","metadata":{"seo":{"title":"Update a credit memo","description":"Notes:"}},"httpPath":"/v1/credit-memos/{creditMemoKey}"},{"label":"Apply a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_applycreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_applycreditmemo","metadata":{"seo":{"title":"Apply a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/apply"},{"label":"Cancel a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_cancelcreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_cancelcreditmemo","metadata":{"seo":{"title":"Cancel a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/cancel"},{"label":"Email a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_emailcreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/post_emailcreditmemo","metadata":{"seo":{"title":"Email a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/emails"},{"label":"Upload a file for a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_uploadfileforcreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/post_uploadfileforcreditmemo","metadata":{"seo":{"title":"Upload a file for a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/files"},{"label":"List all files of a credit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemofiles","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemofiles","metadata":{"seo":{"title":"List all files of a credit memo","description":"Retrieves the information about all PDF files of a specified credit memo."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/files"},{"label":"List credit memo items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemoitems","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemoitems","metadata":{"seo":{"title":"List credit memo items","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/items"},{"label":"Retrieve a credit memo item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemoitem","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemoitem","metadata":{"seo":{"title":"Retrieve a credit memo item","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/items/{cmitemid}"},{"label":"List all parts of a credit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemoparts","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemoparts","metadata":{"seo":{"title":"List all parts of a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/parts"},{"label":"Retrieve a credit memo part","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemopart","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemopart","metadata":{"seo":{"title":"Retrieve a credit memo part","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/parts/{partid}"},{"label":"Generate a credit memo PDF file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_creditmemopdf","routeSlug":"/v1-api-reference/api/credit-memos/post_creditmemopdf","metadata":{"seo":{"title":"Generate a credit memo PDF file","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/pdfs"},{"label":"Post a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_postcreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_postcreditmemo","metadata":{"seo":{"title":"Post a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/post"},{"label":"Refund a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_refundcreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/post_refundcreditmemo","metadata":{"seo":{"title":"Refund a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/refund"},{"label":"Reverse a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_reversecreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_reversecreditmemo","metadata":{"seo":{"title":"Reverse a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/reverse"},{"label":"Create taxation items for a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_cm_taxationitems","routeSlug":"/v1-api-reference/api/credit-memos/post_cm_taxationitems","metadata":{"seo":{"title":"Create taxation items for a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/taxation-items"},{"label":"Unapply a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_unapplycreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_unapplycreditmemo","metadata":{"seo":{"title":"Unapply a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/unapply"},{"label":"Unpost a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_unpostcreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_unpostcreditmemo","metadata":{"seo":{"title":"Unpost a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/unpost"},{"label":"Create a credit memo from an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_creditmemofrominvoice","routeSlug":"/v1-api-reference/api/credit-memos/post_creditmemofrominvoice","metadata":{"seo":{"title":"Create a credit memo from an invoice","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/invoice/{invoiceKey}"},{"label":"Retrieve an async unapply credit memo job by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/getunapplycreditmemoasyncjob","routeSlug":"/v1-api-reference/api/credit-memos/getunapplycreditmemoasyncjob","metadata":{"seo":{"title":"Retrieve an async unapply credit memo job by ID","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.Retrieves information about a specific Async Credit Memo Unapply job."}},"httpPath":"/v1/credit-memos/unapply-async-jobs/{unapplyAsyncJobId}"},{"label":"Retrieve an async unapply credit memo job by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/getapplycreditmemoasyncjob","routeSlug":"/v1-api-reference/api/credit-memos/getapplycreditmemoasyncjob","metadata":{"seo":{"title":"Retrieve an async unapply credit memo job by ID","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.Retrieves information about a specific Async Credit Memo Apply job."}},"httpPath":"/v1/credit-memos/apply-async-jobs/{applyAsyncJobId}"},{"label":"Apply a credit memo aysnchronously","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/applycreditmemoasync","routeSlug":"/v1-api-reference/api/credit-memos/applycreditmemoasync","metadata":{"seo":{"title":"Apply a credit memo aysnchronously","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/apply-async"},{"label":"Unapply a credit memo asynchronously","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/unapplycreditmemoasync","routeSlug":"/v1-api-reference/api/credit-memos/unapplycreditmemoasync","metadata":{"seo":{"title":"Unapply a credit memo asynchronously","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.Asynchronously Unapplies an applied credit memo from one or more invoices. The full applied amount from invoices is transferred into the unapplied amount of the credit memo."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/unapply-async"}]},{"type":"group","label":"Debit Memos","link":"/v1-api-reference/api/debit-memos","routeSlug":"/v1-api-reference/api/debit-memos","items":[{"label":"List debit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_debitmemos","routeSlug":"/v1-api-reference/api/debit-memos/get_debitmemos","metadata":{"seo":{"title":"List debit memos","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos"},{"label":"Create a debit memo from a charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_debitmemofromprpc","routeSlug":"/v1-api-reference/api/debit-memos/post_debitmemofromprpc","metadata":{"seo":{"title":"Create a debit memo from a charge","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos"},{"label":"Update due dates for debit memos","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/put_updatedebitmemosduedates","routeSlug":"/v1-api-reference/api/debit-memos/put_updatedebitmemosduedates","metadata":{"seo":{"title":"Update due dates for debit memos","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos"},{"label":"Create debit memos","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_createdebitmemos","routeSlug":"/v1-api-reference/api/debit-memos/post_createdebitmemos","metadata":{"seo":{"title":"Create debit memos","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/bulk"},{"label":"Update debit memos","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/put_updatedebitmemos","routeSlug":"/v1-api-reference/api/debit-memos/put_updatedebitmemos","metadata":{"seo":{"title":"Update debit memos","description":"Notes:"}},"httpPath":"/v1/debit-memos/bulk"},{"label":"Retrieve the PDF file generation status of debit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_debitmemopdfstatus","routeSlug":"/v1-api-reference/api/debit-memos/get_debitmemopdfstatus","metadata":{"seo":{"title":"Retrieve the PDF file generation status of debit memos","description":"Retrieves the PDF generation statuses of a batch of debit memos."}},"httpPath":"/v1/debit-memos/pdf-status"},{"label":"List all application parts of a debit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_debitmemoapplicationparts","routeSlug":"/v1-api-reference/api/debit-memos/get_debitmemoapplicationparts","metadata":{"seo":{"title":"List all application parts of a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/{debitMemoId}/application-parts"},{"label":"List all taxation items of a debit memo item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_taxationitemsofdebitmemoitem","routeSlug":"/v1-api-reference/api/debit-memos/get_taxationitemsofdebitmemoitem","metadata":{"seo":{"title":"List all taxation items of a debit memo item","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/{debitMemoId}/items/{dmitemid}/taxation-items"},{"label":"Delete a debit memo","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/delete_debitmemo","routeSlug":"/v1-api-reference/api/debit-memos/delete_debitmemo","metadata":{"seo":{"title":"Delete a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/{debitMemoKey}"},{"label":"Retrieve a debit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_debitmemo","routeSlug":"/v1-api-reference/api/debit-memos/get_debitmemo","metadata":{"seo":{"title":"Retrieve a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/{debitMemoKey}"},{"label":"Update a debit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/put_debitmemo","routeSlug":"/v1-api-reference/api/debit-memos/put_debitmemo","metadata":{"seo":{"title":"Update a debit memo","description":"Notes:"}},"httpPath":"/v1/debit-memos/{debitMemoKey}"},{"label":"Cancel a debit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/put_canceldebitmemo","routeSlug":"/v1-api-reference/api/debit-memos/put_canceldebitmemo","metadata":{"seo":{"title":"Cancel a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/cancel"},{"label":"Collect a posted debit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_debitmemocollect","routeSlug":"/v1-api-reference/api/debit-memos/post_debitmemocollect","metadata":{"seo":{"title":"Collect a posted debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/collect"},{"label":"Email a debit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_emaildebitmemo","routeSlug":"/v1-api-reference/api/debit-memos/post_emaildebitmemo","metadata":{"seo":{"title":"Email a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/emails"},{"label":"Upload a file for a debit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_uploadfilefordebitmemo","routeSlug":"/v1-api-reference/api/debit-memos/post_uploadfilefordebitmemo","metadata":{"seo":{"title":"Upload a file for a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/files"},{"label":"List all files of a debit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_debitmemofiles","routeSlug":"/v1-api-reference/api/debit-memos/get_debitmemofiles","metadata":{"seo":{"title":"List all files of a debit memo","description":"Retrieves the information about all PDF files of a specified debit memo."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/files"},{"label":"List debit memo items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_debitmemoitems","routeSlug":"/v1-api-reference/api/debit-memos/get_debitmemoitems","metadata":{"seo":{"title":"List debit memo items","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/items"},{"label":"Retrieve a debit memo item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_debitmemoitem","routeSlug":"/v1-api-reference/api/debit-memos/get_debitmemoitem","metadata":{"seo":{"title":"Retrieve a debit memo item","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/items/{dmitemid}"},{"label":"Generate a debit memo PDF file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_debitmemopdf","routeSlug":"/v1-api-reference/api/debit-memos/post_debitmemopdf","metadata":{"seo":{"title":"Generate a debit memo PDF file","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/pdfs"},{"label":"Post a debit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/put_postdebitmemo","routeSlug":"/v1-api-reference/api/debit-memos/put_postdebitmemo","metadata":{"seo":{"title":"Post a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/post"},{"label":"Create taxation items for a debit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_dm_taxationitems","routeSlug":"/v1-api-reference/api/debit-memos/post_dm_taxationitems","metadata":{"seo":{"title":"Create taxation items for a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/taxation-items"},{"label":"Unpost a debit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/put_unpostdebitmemo","routeSlug":"/v1-api-reference/api/debit-memos/put_unpostdebitmemo","metadata":{"seo":{"title":"Unpost a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/unpost"},{"label":"Create a debit memo from an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_debitmemofrominvoice","routeSlug":"/v1-api-reference/api/debit-memos/post_debitmemofrominvoice","metadata":{"seo":{"title":"Create a debit memo from an invoice","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/invoice/{invoiceKey}"},{"label":"Write off a debit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/put_writeoffdebitmemo","routeSlug":"/v1-api-reference/api/debit-memos/put_writeoffdebitmemo","metadata":{"seo":{"title":"Write off a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/write-off"}]},{"type":"group","label":"E-Invoicing","link":"/v1-api-reference/api/e-invoicing","routeSlug":"/v1-api-reference/api/e-invoicing","items":[{"label":"List e-invoicing service providers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/get_einvoicingserviceproviders","routeSlug":"/v1-api-reference/api/e-invoicing/get_einvoicingserviceproviders","metadata":{"seo":{"title":"List e-invoicing service providers","description":"Lists information about e-invoicing service providers."}},"httpPath":"/v1/einvoice/service-providers"},{"label":"Create an e-invoicing service provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/post_einvoicingserviceprovider","routeSlug":"/v1-api-reference/api/e-invoicing/post_einvoicingserviceprovider","metadata":{"seo":{"title":"Create an e-invoicing service provider","description":"Creates an e-invoicing service provider."}},"httpPath":"/v1/einvoice/service-providers"},{"label":"Delete an e-invoicing service provider","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/delete_einvoicingserviceprovider","routeSlug":"/v1-api-reference/api/e-invoicing/delete_einvoicingserviceprovider","metadata":{"seo":{"title":"Delete an e-invoicing service provider","description":"Deletes an e-invoicing service privider."}},"httpPath":"/v1/einvoice/service-providers/{key}"},{"label":"Retrieve an e-invoicing service provider","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/get_einvoicingserviceprovider","routeSlug":"/v1-api-reference/api/e-invoicing/get_einvoicingserviceprovider","metadata":{"seo":{"title":"Retrieve an e-invoicing service provider","description":"Retrieves information about an e-invoicing service privider."}},"httpPath":"/v1/einvoice/service-providers/{key}"},{"label":"Update an e-invoicing service provider","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/put_updateeinvoicingserviceprovider","routeSlug":"/v1-api-reference/api/e-invoicing/put_updateeinvoicingserviceprovider","metadata":{"seo":{"title":"Update an e-invoicing service provider","description":"Updates information about an e-invoicing service privider."}},"httpPath":"/v1/einvoice/service-providers/{key}"},{"label":"List e-invoicing business regions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/get_einvoicingbusinessregions","routeSlug":"/v1-api-reference/api/e-invoicing/get_einvoicingbusinessregions","metadata":{"seo":{"title":"List e-invoicing business regions","description":"Lists information about e-invoicing business regions."}},"httpPath":"/v1/einvoice/business-regions"},{"label":"Create an e-invoicing business region","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/post_createeinvoicingbusinessregion","routeSlug":"/v1-api-reference/api/e-invoicing/post_createeinvoicingbusinessregion","metadata":{"seo":{"title":"Create an e-invoicing business region","description":"Creates an e-invoicing business region."}},"httpPath":"/v1/einvoice/business-regions"},{"label":"Delete an e-invoicing business region","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/delete_einvoicingbusinessregion","routeSlug":"/v1-api-reference/api/e-invoicing/delete_einvoicingbusinessregion","metadata":{"seo":{"title":"Delete an e-invoicing business region","description":"Deletes an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region."}},"httpPath":"/v1/einvoice/business-regions/{key}"},{"label":"Retrieve an e-invoicing business region","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/get_einvoicingbusinessregion","routeSlug":"/v1-api-reference/api/e-invoicing/get_einvoicingbusinessregion","metadata":{"seo":{"title":"Retrieve an e-invoicing business region","description":"Retrieves information about an e-invoicing business region."}},"httpPath":"/v1/einvoice/business-regions/{key}"},{"label":"Update an e-invoicing business region","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/put_updateeinvoicingbusinessregion","routeSlug":"/v1-api-reference/api/e-invoicing/put_updateeinvoicingbusinessregion","metadata":{"seo":{"title":"Update an e-invoicing business region","description":"Updates an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region."}},"httpPath":"/v1/einvoice/business-regions/{key}"},{"label":"List mandates for downloading files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/geteinvoicemandates","routeSlug":"/v1-api-reference/api/e-invoicing/geteinvoicemandates","metadata":{"seo":{"title":"List mandates for downloading files","description":"Fetches mandates for downloading files based on the country code, category, and process type selection.This API operation returns the the list of file formats in which the document can be downloaded."}},"httpPath":"/v1/e-invoice/mandates"},{"label":"Retrieve a mandate for downloading a file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/geteinvoicemandateoninvoice","routeSlug":"/v1-api-reference/api/e-invoicing/geteinvoicemandateoninvoice","metadata":{"seo":{"title":"Retrieve a mandate for downloading a file","description":"Fetches mandates for downloading e-invoice based on the country code, category, and process type selection."}},"httpPath":"/v1/invoices/{invoiceKey}/e-invoice/mandate"},{"label":"Retrieve a mandate for downloading a credit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/geteinvoicecreditmemomandate","routeSlug":"/v1-api-reference/api/e-invoicing/geteinvoicecreditmemomandate","metadata":{"seo":{"title":"Retrieve a mandate for downloading a credit memo","description":"Fetches mandates for downloading a Credit Memo file based on the country code, category, and process type selection."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/e-invoice/mandate"},{"label":"Retrieve a mandate for downloading a debit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/geteinvoicedebitmemomandate","routeSlug":"/v1-api-reference/api/e-invoicing/geteinvoicedebitmemomandate","metadata":{"seo":{"title":"Retrieve a mandate for downloading a debit memo","description":"Fetches mandates for downloading a Debit Memo file based on the country code, category, and process type selection."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/e-invoice/mandate"},{"label":"Download a file in the specified file format","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/downloadeinvoiceofspecifiedformat","routeSlug":"/v1-api-reference/api/e-invoicing/downloadeinvoiceofspecifiedformat","metadata":{"seo":{"title":"Download a file in the specified file format","description":"Downloads the e-invoice based on the selected file format. The system supports XML, UBL, PNG, or QR codes formats that each country requires or supports."}},"httpPath":"/v1/invoices/{invoiceKey}/e-invoice/download"},{"label":"Download a credit memo in the specified file format","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/downloadcreditmemoeinvoice","routeSlug":"/v1-api-reference/api/e-invoicing/downloadcreditmemoeinvoice","metadata":{"seo":{"title":"Download a credit memo in the specified file format","description":"Downloads the credit memo based on the specified file format. The system supports XML, UBL, PNG, or QR codes formats that each country requires or supports."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/e-invoice/download"},{"label":"Download a debit memo in the specified file format","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/downloaddebitmemoeinvoice","routeSlug":"/v1-api-reference/api/e-invoicing/downloaddebitmemoeinvoice","metadata":{"seo":{"title":"Download a debit memo in the specified file format","description":"Downloads the debit memo based on the specified file format. The system supports XML, UBL, PNG, or QR codes formats that each country requires or supports."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/e-invoice/download"},{"label":"Cancel the e-invoice file for an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/canceleinvoicebyinvoicekey","routeSlug":"/v1-api-reference/api/e-invoicing/canceleinvoicebyinvoicekey","metadata":{"seo":{"title":"Cancel the e-invoice file for an invoice","description":"Cancels the E-Invoice for the given billing document"}},"httpPath":"/v1/invoices/{invoiceKey}/e-invoice/cancel"},{"label":"List e-invoice file templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/get_einvoicefiletemplates","routeSlug":"/v1-api-reference/api/e-invoicing/get_einvoicefiletemplates","metadata":{"seo":{"title":"List e-invoice file templates","description":"Lists information about e-invoice file templates."}},"httpPath":"/v1/einvoice/templates"},{"label":"Create an e-invoice file template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/post_createeinvoicefiletemplate","routeSlug":"/v1-api-reference/api/e-invoicing/post_createeinvoicefiletemplate","metadata":{"seo":{"title":"Create an e-invoice file template","description":"Creates an e-invoice file templates for your billing documents, including invoices, credit memos, and debit memos."}},"httpPath":"/v1/einvoice/templates"},{"label":"Delete an e-invoice file template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/delete_einvoicefiletemplate","routeSlug":"/v1-api-reference/api/e-invoicing/delete_einvoicefiletemplate","metadata":{"seo":{"title":"Delete an e-invoice file template","description":"Deletes an e-invoice file template by key. The key can be the unique ID or number of an e-invoice file template."}},"httpPath":"/v1/einvoice/templates/{key}"},{"label":"Retrieve an e-invoice file template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/get_einvoicefiletemplate","routeSlug":"/v1-api-reference/api/e-invoicing/get_einvoicefiletemplate","metadata":{"seo":{"title":"Retrieve an e-invoice file template","description":"Retrieves information about an e-invoice file template."}},"httpPath":"/v1/einvoice/templates/{key}"},{"label":"Update an e-invoice file template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/put_einvoicefiletemplate","routeSlug":"/v1-api-reference/api/e-invoicing/put_einvoicefiletemplate","metadata":{"seo":{"title":"Update an e-invoice file template","description":"Updates information about an e-invoice file template."}},"httpPath":"/v1/einvoice/templates/{key}"},{"label":"Sync the e-Invoice status of an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/updateinvoiceinvokesyncstatus","routeSlug":"/v1-api-reference/api/e-invoicing/updateinvoiceinvokesyncstatus","metadata":{"seo":{"title":"Sync the e-Invoice status of an invoice","description":"Initiates a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the e-Invoice."}},"httpPath":"/v1/invoices/{invoiceKey}/e-invoice/sync-status"},{"label":"Sync the e-Invoice status of a debit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/updatedebitmemoinvokesyncstatus","routeSlug":"/v1-api-reference/api/e-invoicing/updatedebitmemoinvokesyncstatus","metadata":{"seo":{"title":"Sync the e-Invoice status of a debit memo","description":"Initiates a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the debit memo."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/e-invoice/sync-status"},{"label":"Sync the e-Invoice status of a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/updatecreditmemoinvokesyncstatus","routeSlug":"/v1-api-reference/api/e-invoicing/updatecreditmemoinvokesyncstatus","metadata":{"seo":{"title":"Sync the e-Invoice status of a credit memo","description":"Initiates a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the credit memo."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/e-invoice/sync-status"},{"label":"Generate an e-invoice file for an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/put_generationeinvoicegenerationforinvoices","routeSlug":"/v1-api-reference/api/e-invoicing/put_generationeinvoicegenerationforinvoices","metadata":{"seo":{"title":"Generate an e-invoice file for an invoice","description":"Generates an e-invoice file for an invoice.If the invoice status is Failed during e-invoice generation, you can use Regenerate E-Invoice. Once you fix the errors and trigger the regeneration, the system will resubmit the document to the e-invoicing service provider, and its status will update to Processing."}},"httpPath":"/v1/invoices/{invoiceKey}/einvoice/generate"},{"label":"Generate an e-invoice file for a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/put_generateeinvoicefileforcreditmemo","routeSlug":"/v1-api-reference/api/e-invoicing/put_generateeinvoicefileforcreditmemo","metadata":{"seo":{"title":"Generate an e-invoice file for a credit memo","description":"Generates an e-invoice file for a credit memo. If the Credit Memo status is Failed during e-invoice generation, you can use Regenerate E-Invoice. Once you fix the errors and trigger the regeneration, the system will resubmit the document to the e-invoicing service provider, and its status will update to Processing."}},"httpPath":"/v1/credit-memos/{creditMemoKey}/e-invoice/generate"},{"label":"Generate an e-invoice file for a debit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/put_generateeinvoicefilefordebitmemo","routeSlug":"/v1-api-reference/api/e-invoicing/put_generateeinvoicefilefordebitmemo","metadata":{"seo":{"title":"Generate an e-invoice file for a debit memo","description":"Generates an e-invoice file for a debit memo. If the Credit Memo status is Failed during e-invoice generation, you can use Regenerate E-Invoice. Once you fix the errors and trigger the regeneration, the system will resubmit the document to the e-invoicing service provider, and its status will update to Processing."}},"httpPath":"/v1/debit-memos/{debitMemoKey}/e-invoice/generate"},{"label":"Create an e-invoice lifecycle status update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/createeinvoicelifecyclestatusupdate","routeSlug":"/v1-api-reference/api/e-invoicing/createeinvoicelifecyclestatusupdate","metadata":{"seo":{"title":"Create an e-invoice lifecycle status update","description":"Creates a seller-initiated status update request for an e-invoice lifecycle. Use this operation to notify the tax authority when the business status of a source document changes, such as when payment is collected, the document is canceled, or the lifecycle is completed."}},"httpPath":"/v1/e-compliance/lifecycle/status-update"},{"label":"List e-invoice business lifecycle status updates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/geteinvoicelifecyclestatusupdates","routeSlug":"/v1-api-reference/api/e-invoicing/geteinvoicelifecyclestatusupdates","metadata":{"seo":{"title":"List e-invoice business lifecycle status updates","description":"Lists e-invoice business lifecycle status update audit records, optionally filtered by document, status, and requested action."}},"httpPath":"/v1/e-compliance/lifecycle/status-updates"},{"label":"Retrieve an e-invoice business lifecycle status update by key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/geteinvoicelifecyclestatusupdate","routeSlug":"/v1-api-reference/api/e-invoicing/geteinvoicelifecyclestatusupdate","metadata":{"seo":{"title":"Retrieve an e-invoice business lifecycle status update by key","description":"Retrieves a single e-invoice business lifecycle status update audit record by its unique identifier."}},"httpPath":"/v1/e-compliance/lifecycle/status-updates/{key}"},{"label":"Reconcile an e-compliance request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/reconcileecompliance","routeSlug":"/v1-api-reference/api/e-invoicing/reconcileecompliance","metadata":{"seo":{"title":"Reconcile an e-compliance request","description":"Reconciles an e-compliance request for the supplied source object."}},"httpPath":"/v1/e-compliance/reconcile"},{"label":"Trigger an e-compliance request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/triggerecompliancerequest","routeSlug":"/v1-api-reference/api/e-invoicing/triggerecompliancerequest","metadata":{"seo":{"title":"Trigger an e-compliance request","description":"Creates an e-compliance request for the supplied source object."}},"httpPath":"/v1/e-compliance/trigger"},{"label":"Regenerate an e-compliance request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/regenerateecompliancerequest","routeSlug":"/v1-api-reference/api/e-invoicing/regenerateecompliancerequest","metadata":{"seo":{"title":"Regenerate an e-compliance request","description":"Regenerates a failed or rejected e-compliance request."}},"httpPath":"/v1/e-compliance/regenerate"}]},{"type":"group","label":"E-Reporting","link":"/v1-api-reference/api/e-reporting","routeSlug":"/v1-api-reference/api/e-reporting","items":[{"label":"Reconcile an e-compliance request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/reconcileecompliance","routeSlug":"/v1-api-reference/api/e-reporting/reconcileecompliance","metadata":{"seo":{"title":"Reconcile an e-compliance request","description":"Reconciles an e-compliance request for the supplied source object."}},"httpPath":"/v1/e-compliance/reconcile"},{"label":"List all e-reporting templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/getereportingtemplates","routeSlug":"/v1-api-reference/api/e-reporting/getereportingtemplates","metadata":{"seo":{"title":"List all e-reporting templates","description":"Lists information about e-reporting templates."}},"httpPath":"/v1/e-reporting/templates"},{"label":"Create an e-reporting template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/createereportingtemplate","routeSlug":"/v1-api-reference/api/e-reporting/createereportingtemplate","metadata":{"seo":{"title":"Create an e-reporting template","description":"Creates an e-reporting template."}},"httpPath":"/v1/e-reporting/templates"},{"label":"Delete an e-reporting template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/deleteereportingtemplate","routeSlug":"/v1-api-reference/api/e-reporting/deleteereportingtemplate","metadata":{"seo":{"title":"Delete an e-reporting template","description":"Deletes an e-reporting template."}},"httpPath":"/v1/e-reporting/templates/{key}"},{"label":"Retrieve an e-reporting template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/getereportingtemplate","routeSlug":"/v1-api-reference/api/e-reporting/getereportingtemplate","metadata":{"seo":{"title":"Retrieve an e-reporting template","description":"Retrieves an e-reporting template."}},"httpPath":"/v1/e-reporting/templates/{key}"},{"label":"Update an e-reporting template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/updateereportingtemplate","routeSlug":"/v1-api-reference/api/e-reporting/updateereportingtemplate","metadata":{"seo":{"title":"Update an e-reporting template","description":"Updates an e-reporting template"}},"httpPath":"/v1/e-reporting/templates/{key}"},{"label":"List e-reporting business regions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/listereportingbusinessregions","routeSlug":"/v1-api-reference/api/e-reporting/listereportingbusinessregions","metadata":{"seo":{"title":"List e-reporting business regions","description":"Lists e-reporting business regions."}},"httpPath":"/v1/e-reporting/business-regions"},{"label":"Create an e-reporting business region","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/createereportingbusinessregion","routeSlug":"/v1-api-reference/api/e-reporting/createereportingbusinessregion","metadata":{"seo":{"title":"Create an e-reporting business region","description":"Creates an e-reporting business region."}},"httpPath":"/v1/e-reporting/business-regions"},{"label":"Delete an e-reporting business region","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/deleteereportingbusinessregion","routeSlug":"/v1-api-reference/api/e-reporting/deleteereportingbusinessregion","metadata":{"seo":{"title":"Delete an e-reporting business region","description":"Deletes an e-reporting business region."}},"httpPath":"/v1/e-reporting/business-regions/{key}"},{"label":"Retrieve an e-reporting business region","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/getereportingbusinessregion","routeSlug":"/v1-api-reference/api/e-reporting/getereportingbusinessregion","metadata":{"seo":{"title":"Retrieve an e-reporting business region","description":"Retrieves an e-reporting business region."}},"httpPath":"/v1/e-reporting/business-regions/{key}"},{"label":"Update an e-reporting business region","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/updateereportingbusinessregion","routeSlug":"/v1-api-reference/api/e-reporting/updateereportingbusinessregion","metadata":{"seo":{"title":"Update an e-reporting business region","description":"Updates an e-reporting business region."}},"httpPath":"/v1/e-reporting/business-regions/{key}"},{"label":"List e-reporting requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/getereportingrequests","routeSlug":"/v1-api-reference/api/e-reporting/getereportingrequests","metadata":{"seo":{"title":"List e-reporting requests","description":"Lists e-reporting requests, optionally filtered by source object and status."}},"httpPath":"/v1/e-compliance/e-reporting/requests"},{"label":"Retrieve an e-reporting request by key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/getereportingrequest","routeSlug":"/v1-api-reference/api/e-reporting/getereportingrequest","metadata":{"seo":{"title":"Retrieve an e-reporting request by key","description":"Retrieves a single e-reporting request by its unique identifier."}},"httpPath":"/v1/e-compliance/e-reporting/requests/{key}"},{"label":"Download the e-compliance file for a source object","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/downloadecompliancefile","routeSlug":"/v1-api-reference/api/e-reporting/downloadecompliancefile","metadata":{"seo":{"title":"Download the e-compliance file for a source object","description":"Downloads the provider-certified compliance document for the given source object. The response Content-Type depends on the format returned by the provider (e.g. application/xml or application/pdf)."}},"httpPath":"/v1/e-compliance/{complianceType}/files/{sourceObjectType}/{sourceObjectId}"},{"label":"Download the e-compliance snapshot for a source object","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/downloadecompliancesnapshot","routeSlug":"/v1-api-reference/api/e-reporting/downloadecompliancesnapshot","metadata":{"seo":{"title":"Download the e-compliance snapshot for a source object","description":"Downloads the provider-certified compliance snapshot for the given source object. The snapshot contains the raw payload submitted to the compliance provider."}},"httpPath":"/v1/e-compliance/{complianceType}/snapshots/{sourceObjectType}/{sourceObjectId}"},{"label":"Trigger an e-compliance request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/triggerecompliancerequest","routeSlug":"/v1-api-reference/api/e-reporting/triggerecompliancerequest","metadata":{"seo":{"title":"Trigger an e-compliance request","description":"Creates an e-compliance request for the supplied source object."}},"httpPath":"/v1/e-compliance/trigger"},{"label":"Regenerate an e-compliance request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/regenerateecompliancerequest","routeSlug":"/v1-api-reference/api/e-reporting/regenerateecompliancerequest","metadata":{"seo":{"title":"Regenerate an e-compliance request","description":"Regenerates a failed or rejected e-compliance request."}},"httpPath":"/v1/e-compliance/regenerate"}]},{"type":"group","label":"Invoice Schedules","link":"/v1-api-reference/api/invoice-schedules","routeSlug":"/v1-api-reference/api/invoice-schedules","items":[{"label":"Create an invoice schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/post_createinvoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/post_createinvoiceschedule","metadata":{"seo":{"title":"Create an invoice schedule","description":"Creates an invoice schedule."}},"httpPath":"/v1/invoice-schedules"},{"label":"Delete an invoice schedule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/delete_invoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/delete_invoiceschedule","metadata":{"seo":{"title":"Delete an invoice schedule","description":"Deletes an invoice schedule in Pending status. The status of the invoiceschedule to be deleted must be Pending."}},"httpPath":"/v1/invoice-schedules/{scheduleKey}"},{"label":"Retrieve an invoice schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/get_invoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/get_invoiceschedule","metadata":{"seo":{"title":"Retrieve an invoice schedule","description":"Retrieves detailed information about an invoice schedule."}},"httpPath":"/v1/invoice-schedules/{scheduleKey}"},{"label":"Update an invoice schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/put_updateinvoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/put_updateinvoiceschedule","metadata":{"seo":{"title":"Update an invoice schedule","description":"Updates a pending invoice schedule. You can use this API operation to update invoice schedules in the following aspects:"}},"httpPath":"/v1/invoice-schedules/{scheduleKey}"},{"label":"Execute an invoice schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/post_executeinvoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/post_executeinvoiceschedule","metadata":{"seo":{"title":"Execute an invoice schedule","description":"Executes an invoice schedule immediately. During the execution, a bill run is created and generates an invoice or a credit memo asynchronously."}},"httpPath":"/v1/invoice-schedules/{scheduleKey}/execute"},{"label":"Pause an invoice schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/put_pauseinvoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/put_pauseinvoiceschedule","metadata":{"seo":{"title":"Pause an invoice schedule","description":"Pauses an invoice schedule immediately."}},"httpPath":"/v1/invoice-schedules/{scheduleKey}/pause"},{"label":"Resume an invoice schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/put_resumeinvoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/put_resumeinvoiceschedule","metadata":{"seo":{"title":"Resume an invoice schedule","description":"Resumes an invoice schedule in Paused status immediately."}},"httpPath":"/v1/invoice-schedules/{scheduleKey}/resume"},{"label":"Detach charges from an invoice schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/detachchargesfrominvoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/detachchargesfrominvoiceschedule","metadata":{"seo":{"title":"Detach charges from an invoice schedule","description":"Detaches charges from an invoice schedule. The invoice schedules you want to detach charges from must be in Fully Processed or Partially Processed status. Invoice schedules do not bill detached charges."}},"httpPath":"/v1/invoice-schedules/{scheduleKey}/detach"},{"label":"Attach charges to an invoice schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/attachchargestoinvoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/attachchargestoinvoiceschedule","metadata":{"seo":{"title":"Attach charges to an invoice schedule","description":"Attaches charges to an invoice schedule. The invoice schedules you want to attach charges to must be in Fully Processed or Partially Processed status. You can attach charges only if they were previously detached from the same invoice schedule. Invoice schedules will automatically bill re-attached charges in the upcoming planned invoice schedule items."}},"httpPath":"/v1/invoice-schedules/{scheduleKey}/attach"}]},{"type":"group","label":"Taxation Items","link":"/v1-api-reference/api/taxation-items","routeSlug":"/v1-api-reference/api/taxation-items","items":[{"label":"CRUD: Create a taxation item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/taxation-items/object_posttaxationitem","routeSlug":"/v1-api-reference/api/taxation-items/object_posttaxationitem","metadata":{"seo":{"title":"CRUD: Create a taxation item","description":"Creates a Taxation Item object."}},"httpPath":"/v1/object/taxation-item"},{"label":"Delete a taxation item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/taxation-items/delete_taxationitem","routeSlug":"/v1-api-reference/api/taxation-items/delete_taxationitem","metadata":{"seo":{"title":"Delete a taxation item","description":"Deletes a specific taxation item by ID."}},"httpPath":"/v1/taxation-items/{id}"},{"label":"Retrieve a taxation item\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/taxation-items/get_taxationitem","routeSlug":"/v1-api-reference/api/taxation-items/get_taxationitem","metadata":{"seo":{"title":"Retrieve a taxation item\n","description":"Retrieves the information about a specific taxation item by ID."}},"httpPath":"/v1/taxation-items/{id}"},{"label":"Update a taxation item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/taxation-items/put_taxationitem","routeSlug":"/v1-api-reference/api/taxation-items/put_taxationitem","metadata":{"seo":{"title":"Update a taxation item","description":"Updates a specific taxation item by ID."}},"httpPath":"/v1/taxation-items/{id}"}]},{"type":"group","label":"Sequence Sets","link":"/v1-api-reference/api/sequence-sets","routeSlug":"/v1-api-reference/api/sequence-sets","items":[{"label":"List sequence sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/sequence-sets/get_sequencesets","routeSlug":"/v1-api-reference/api/sequence-sets/get_sequencesets","metadata":{"seo":{"title":"List sequence sets","description":"Retrieves information about all sequence sets configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos."}},"httpPath":"/v1/sequence-sets"},{"label":"Create sequence sets","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/sequence-sets/post_sequencesets","routeSlug":"/v1-api-reference/api/sequence-sets/post_sequencesets","metadata":{"seo":{"title":"Create sequence sets","description":"Creates sequence sets, allowing distinct numbering sequences for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos."}},"httpPath":"/v1/sequence-sets"},{"label":"Delete a sequence set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/sequence-sets/delete_sequenceset","routeSlug":"/v1-api-reference/api/sequence-sets/delete_sequenceset","metadata":{"seo":{"title":"Delete a sequence set","description":"Deletes a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos."}},"httpPath":"/v1/sequence-sets/{id}"},{"label":"Retrieve a sequence set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/sequence-sets/get_sequenceset","routeSlug":"/v1-api-reference/api/sequence-sets/get_sequenceset","metadata":{"seo":{"title":"Retrieve a sequence set","description":"Retrieves information about a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos"}},"httpPath":"/v1/sequence-sets/{id}"},{"label":"Update a sequence set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/sequence-sets/put_sequenceset","routeSlug":"/v1-api-reference/api/sequence-sets/put_sequenceset","metadata":{"seo":{"title":"Update a sequence set","description":"Updates a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos."}},"httpPath":"/v1/sequence-sets/{id}"}]},{"type":"group","label":"Operations","link":"/v1-api-reference/api/operations","routeSlug":"/v1-api-reference/api/operations","items":[{"label":"Generate a billing preview","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/operations/post_billingpreview","routeSlug":"/v1-api-reference/api/operations/post_billingpreview","metadata":{"seo":{"title":"Generate a billing preview","description":"Generates a preview of future invoice items for one customer account. Use the BillingPreview call to calculate how much a single customer will be invoiced from the most recent invoice to a specific end of term date in the future."}},"httpPath":"/v1/operations/billing-preview"},{"label":"Invoice and collect","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/operations/post_transactioninvoicepayment","routeSlug":"/v1-api-reference/api/operations/post_transactioninvoicepayment","metadata":{"seo":{"title":"Invoice and collect","description":"Generates and posts invoices and credit memos, and collects payments for posted invoices. Credit memos are only available if you have the InvoiceSettlement feature enabled and negative charges exist. Credit memos will not be applied to invoices. If draft invoices and credit memos exist when you runthis operation, this operation will post the invoices and credit memos. Note that draft credit memos created from an invoice or a product rate plan chargewill not be posted."}},"httpPath":"/v1/operations/invoice-collect"},{"label":"Retrieve an operation job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/operations/get_operationjob","routeSlug":"/v1-api-reference/api/operations/get_operationjob","metadata":{"seo":{"title":"Retrieve an operation job","description":"Retrieves information about a specific operation job."}},"httpPath":"/v1/operations/jobs/{jobId}"},{"label":"Export bulk PDF files","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/operations/create_bulkpdftozipgeneration","routeSlug":"/v1-api-reference/api/operations/create_bulkpdftozipgeneration","metadata":{"seo":{"title":"Export bulk PDF files","description":"The background job that compresses large number of PDF(s) into ZIP files. For answers to frequently asked questions regarding exporting bulk PDF files, see Export Bulk PDF Files FAQs.Note: Do not include multiple objectIds with the same PDF file names in a single bulk PDF upload request."}},"httpPath":"/v1/operations/bulk-pdf"},{"label":"Retrieve information of a bulk PDF file generation job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/operations/get_bulkpdftozipgeneration","routeSlug":"/v1-api-reference/api/operations/get_bulkpdftozipgeneration","metadata":{"seo":{"title":"Retrieve information of a bulk PDF file generation job","description":"Retrieves information about the job which includes its status, message, and downloadable ZIP file URL link."}},"httpPath":"/v1/operations/bulk-pdf/{jobId}"}]},{"type":"group","label":"Summary Statements","link":"/v1-api-reference/api/summary-statements","routeSlug":"/v1-api-reference/api/summary-statements","items":[{"label":"Create a summary statement run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-statements/createsummarystatementrun","routeSlug":"/v1-api-reference/api/summary-statements/createsummarystatementrun","metadata":{"seo":{"title":"Create a summary statement run","description":"Allows you to initiate the generation of a summary statement run. You can specify parameters such as the run type (AdHoc or scheduled) and the target account categories (single or multiple accounts)."}},"httpPath":"/v1/summary-statement-runs"},{"label":"Delete a summary statement","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-statements/deletesummarystatement","routeSlug":"/v1-api-reference/api/summary-statements/deletesummarystatement","metadata":{"seo":{"title":"Delete a summary statement","description":"Deletes a specific summary statement."}},"httpPath":"/v1/summary-statements/{summaryStatementKey}"}]},{"type":"separator","label":"Bill Runs"},{"type":"group","label":"Bill Run","link":"/v1-api-reference/api/bill-run","routeSlug":"/v1-api-reference/api/bill-run","items":[{"label":"Create a bill run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bill-run/post_createbillrun","routeSlug":"/v1-api-reference/api/bill-run/post_createbillrun","metadata":{"seo":{"title":"Create a bill run","description":"Creates an ad-hoc bill run or a scheduled bill run. Support the following:"}},"httpPath":"/v1/bill-runs"},{"label":"Delete a bill run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bill-run/delete_deletebillrun","routeSlug":"/v1-api-reference/api/bill-run/delete_deletebillrun","metadata":{"seo":{"title":"Delete a bill run","description":"Deletes a bill run. You can only delete bill runs in Canceled or Error status."}},"httpPath":"/v1/bill-runs/{billRunId}"},{"label":"Retrieve a bill run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bill-run/get_billrun","routeSlug":"/v1-api-reference/api/bill-run/get_billrun","metadata":{"seo":{"title":"Retrieve a bill run","description":"Retrieves the information about a specific bill run."}},"httpPath":"/v1/bill-runs/{billRunId}"},{"label":"Cancel a bill run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bill-run/put_cancelbillrun","routeSlug":"/v1-api-reference/api/bill-run/put_cancelbillrun","metadata":{"seo":{"title":"Cancel a bill run","description":"Cancels a bill run in Draft status."}},"httpPath":"/v1/bill-runs/{billRunId}/cancel"},{"label":"Post a bill run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bill-run/put_postbillrun","routeSlug":"/v1-api-reference/api/bill-run/put_postbillrun","metadata":{"seo":{"title":"Post a bill run","description":"Posts a bill run asynchronously. To post a bill run, the current bill run must be in Completed status."}},"httpPath":"/v1/bill-runs/{billRunId}/post"},{"label":"Email billing documents generated from a bill run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bill-run/post_emailbillingdocumentsfrombillrun","routeSlug":"/v1-api-reference/api/bill-run/post_emailbillingdocumentsfrombillrun","metadata":{"seo":{"title":"Email billing documents generated from a bill run","description":"Manually emails all the billing documents that are generated from a specified bill run to your customers."}},"httpPath":"/v1/bill-runs/{billRunKey}/emails"}]},{"type":"group","label":"Billing Preview Run","link":"/v1-api-reference/api/billing-preview-run","routeSlug":"/v1-api-reference/api/billing-preview-run","items":[{"label":"Create a billing preview run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/billing-preview-run/post_billingpreviewrun","routeSlug":"/v1-api-reference/api/billing-preview-run/post_billingpreviewrun","metadata":{"seo":{"title":"Create a billing preview run","description":"Creates a billing preview run for single and multiple customer accounts."}},"httpPath":"/v1/billing-preview-runs"},{"label":"Retrieve a billing preview run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/billing-preview-run/get_billingpreviewrun","routeSlug":"/v1-api-reference/api/billing-preview-run/get_billingpreviewrun","metadata":{"seo":{"title":"Retrieve a billing preview run","description":"Retrieves a preview of future invoice items for multiple customer accounts through a billing preview run. If you have the Invoice Settlement feature enabled,  you can also retrieve a preview of future credit memo items. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/billing-preview-runs/{billingPreviewRunId}"}]},{"type":"separator","label":"Payment Methods"},{"type":"group","label":"Payment Methods","link":"/v1-api-reference/api/payment-methods","routeSlug":"/v1-api-reference/api/payment-methods","items":[{"label":"Create a payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/post_paymentmethods","routeSlug":"/v1-api-reference/api/payment-methods/post_paymentmethods","metadata":{"seo":{"title":"Create a payment method","description":"You can use this operation to create either a payment method associatedwith a specific customer account, or an orphan payment method that is not associatedwith any customer account."}},"httpPath":"/v1/payment-methods"},{"label":"Create an Apple Pay payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/post_paymentmethodsdecryption","routeSlug":"/v1-api-reference/api/payment-methods/post_paymentmethodsdecryption","metadata":{"seo":{"title":"Create an Apple Pay payment method","description":"The decryption API endpoint can conditionally perform 4 tasks in one atomic call:"}},"httpPath":"/v1/payment-methods/decryption"},{"label":"Delete a payment method","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/delete_paymentmethods","routeSlug":"/v1-api-reference/api/payment-methods/delete_paymentmethods","metadata":{"seo":{"title":"Delete a payment method","description":"Deletes a credit card payment method."}},"httpPath":"/v1/payment-methods/{payment-method-id}"},{"label":"Retrieve a payment method","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/get_paymentmethod","routeSlug":"/v1-api-reference/api/payment-methods/get_paymentmethod","metadata":{"seo":{"title":"Retrieve a payment method","description":"Use this operation to get the detailed information of an electronic payment method. To retrieve information of both electronic and non-electronic payment methods, use the Object Query operation."}},"httpPath":"/v1/payment-methods/{payment-method-id}"},{"label":"Update a payment method","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/put_paymentmethod","routeSlug":"/v1-api-reference/api/payment-methods/put_paymentmethod","metadata":{"seo":{"title":"Update a payment method","description":"This operation allows you to update an existing payment method."}},"httpPath":"/v1/payment-methods/{payment-method-id}"},{"label":"Verify a payment method","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/put_verifypaymentmethods","routeSlug":"/v1-api-reference/api/payment-methods/put_verifypaymentmethods","metadata":{"seo":{"title":"Verify a payment method","description":"Sends an authorization request to the corresponding payment gateway to verify the payment method, even though no changes are made for the payment method. Supported payment methods are Credit Cards and Paypal."}},"httpPath":"/v1/payment-methods/{payment-method-id}/verify"},{"label":"Scrub a payment method","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/put_scrubpaymentmethods","routeSlug":"/v1-api-reference/api/payment-methods/put_scrubpaymentmethods","metadata":{"seo":{"title":"Scrub a payment method","description":"This operation enables you to replace all sensitive data in a payment method, related payment method snapshot table, and four related log tables with dummy values that will be stored in Zuora databases."}},"httpPath":"/v1/payment-methods/{payment-method-id}/scrub"},{"label":"Retrieve the balance of a bank account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/getbankaccountbalance","routeSlug":"/v1-api-reference/api/payment-methods/getbankaccountbalance","metadata":{"seo":{"title":"Retrieve the balance of a bank account","description":"Zuora supports Plaid's Auth and Balance products for ACH transactions.Auth authenticates account details before sending requests to the gateway,while Balance checks the real-time account balance before transactions.Use this API operation to implement the integration with Plaid Balance manually."}},"httpPath":"/v1/payment-methods/{payment-method-id}/balance"},{"label":"List stored credential profiles of a payment method","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/get_storedcredentialprofiles","routeSlug":"/v1-api-reference/api/payment-methods/get_storedcredentialprofiles","metadata":{"seo":{"title":"List stored credential profiles of a payment method","description":"Retrieves the stored credential profiles within a payment method."}},"httpPath":"/v1/payment-methods/{payment-method-id}/profiles"},{"label":"Create a stored credential profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/post_createstoredcredentialprofile","routeSlug":"/v1-api-reference/api/payment-methods/post_createstoredcredentialprofile","metadata":{"seo":{"title":"Create a stored credential profile","description":"Creates a stored credential profile within a payment method."}},"httpPath":"/v1/payment-methods/{payment-method-id}/profiles"},{"label":"Cancel a stored credential profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/post_cancelstoredcredentialprofile","routeSlug":"/v1-api-reference/api/payment-methods/post_cancelstoredcredentialprofile","metadata":{"seo":{"title":"Cancel a stored credential profile","description":"Cancels a stored credential profile within a payment method."}},"httpPath":"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel"},{"label":"Expire a stored credential profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/post_expirestoredcredentialprofile","routeSlug":"/v1-api-reference/api/payment-methods/post_expirestoredcredentialprofile","metadata":{"seo":{"title":"Expire a stored credential profile","description":"Expires a stored credential profile within a payment method."}},"httpPath":"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire"},{"label":"Add gateway profile data to a stored credential profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/addgatewayprofiledata","routeSlug":"/v1-api-reference/api/payment-methods/addgatewayprofiledata","metadata":{"seo":{"title":"Add gateway profile data to a stored credential profile","description":"Adds gateway profile data to an existing stored credential profile within a payment method."}},"httpPath":"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/profile-data"},{"label":"List registered domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/getwalletdomains","routeSlug":"/v1-api-reference/api/payment-methods/getwalletdomains","metadata":{"seo":{"title":"List registered domains","description":"Use this operation to retreive list of registered domains."}},"httpPath":"/v1/payment-methods/wallet/domains"},{"label":"Register a wallet domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/registerwalletdomain","routeSlug":"/v1-api-reference/api/payment-methods/registerwalletdomain","metadata":{"seo":{"title":"Register a wallet domain","description":"Before adding Apple Pay to your checkout flow by integrating with the JavaScript SDK provided by Zuora, your domains that will show the Apple Pay button must be registered with Apple. Use this operation to register a domain."}},"httpPath":"/v1/payment-methods/wallet/domains"},{"label":"Unregister a wallet domain","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/deleteunregisterwalletdomain","routeSlug":"/v1-api-reference/api/payment-methods/deleteunregisterwalletdomain","metadata":{"seo":{"title":"Unregister a wallet domain","description":"Use this operation to unregister a wallet domain."}},"httpPath":"/v1/payment-methods/wallet/domains/{id}"},{"label":"Create a payment session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/post_createpaymentsession","routeSlug":"/v1-api-reference/api/payment-methods/post_createpaymentsession","metadata":{"seo":{"title":"Create a payment session","description":"Use this operation to create a payment session on your server side.The response contains a token for the payment session data."}},"httpPath":"/web-payments/sessions"}]},{"type":"group","label":"Custom Payment Method Types","link":"/v1-api-reference/api/custom-payment-method-types","routeSlug":"/v1-api-reference/api/custom-payment-method-types","items":[{"label":"Create a draft custom payment method type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-payment-method-types/post_createdraftopenpaymentmethodtype","routeSlug":"/v1-api-reference/api/custom-payment-method-types/post_createdraftopenpaymentmethodtype","metadata":{"seo":{"title":"Create a draft custom payment method type","description":"Creates a draft version of a custom payment method type. Revision number 1 is assigned to this version. You can update your draft version through the Update a custom payment method type operation. You must publish your draft version through the Publish a custom payment method type operation before your custom payment method type goes live."}},"httpPath":"/open-payment-method-types"},{"label":"Publish a custom payment method type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-payment-method-types/put_publishopenpaymentmethodtype","routeSlug":"/v1-api-reference/api/custom-payment-method-types/put_publishopenpaymentmethodtype","metadata":{"seo":{"title":"Publish a custom payment method type","description":"Publish the latest draft revision of a specific custom payment method type."}},"httpPath":"/open-payment-method-types/publish/{paymentMethodTypeName}"},{"label":"Update a custom payment method type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-payment-method-types/put_updateopenpaymentmethodtype","routeSlug":"/v1-api-reference/api/custom-payment-method-types/put_updateopenpaymentmethodtype","metadata":{"seo":{"title":"Update a custom payment method type","description":"Update the latest draft version of your custom payment method type. If the latest draft version has been published, the revision number is increased by 1 after the draft version is updated. You must publish your latest revision again through the Publish a custom payment method type operation before your updated custom payment method type goes live."}},"httpPath":"/open-payment-method-types/{paymentMethodTypeName}"},{"label":"Retrieve a specific draft revision of a custom payment method type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-payment-method-types/get_openpaymentmethodtyperevision","routeSlug":"/v1-api-reference/api/custom-payment-method-types/get_openpaymentmethodtyperevision","metadata":{"seo":{"title":"Retrieve a specific draft revision of a custom payment method type","description":"Retrieves a specific draft revision of a custom payment method type."}},"httpPath":"/open-payment-method-types/{paymentMethodTypeName}/draft/{revisionNumber}"},{"label":"Retrieve a published custom payment method type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-payment-method-types/get_openpaymentmethodtypepublish","routeSlug":"/v1-api-reference/api/custom-payment-method-types/get_openpaymentmethodtypepublish","metadata":{"seo":{"title":"Retrieve a published custom payment method type","description":"Retrieves a published custom payment method type."}},"httpPath":"/open-payment-method-types/{paymentMethodTypeName}/published"}]},{"type":"group","label":"Payment Method Updater","link":"/v1-api-reference/api/payment-method-updater","routeSlug":"/v1-api-reference/api/payment-method-updater","items":[{"label":"List Payment Method Updater instances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-method-updater/get_paymentmethodupdaterinstances","routeSlug":"/v1-api-reference/api/payment-method-updater/get_paymentmethodupdaterinstances","metadata":{"seo":{"title":"List Payment Method Updater instances","description":"Retrieves the detailed information of all Payment Method Updater (PMU) instances on your tenant, except for American Express (AMEX)."}},"httpPath":"/v1/payment-method-updaters"},{"label":"Create a Payment Method Updater batch asynchronously","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-method-updater/post_paymentmethodupdaterbatch","routeSlug":"/v1-api-reference/api/payment-method-updater/post_paymentmethodupdaterbatch","metadata":{"seo":{"title":"Create a Payment Method Updater batch asynchronously","description":"Creates a Payment Method Updater (PMU) batch asynchronously. PMU for American Express (AMEX) is not supported."}},"httpPath":"/v1/payment-method-updaters/batches"}]},{"type":"group","label":"Payment Method Snapshots","link":"/v1-api-reference/api/payment-method-snapshots","routeSlug":"/v1-api-reference/api/payment-method-snapshots","items":[{"label":"CRUD: Retrieve a payment method snapshot","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-method-snapshots/object_getpaymentmethodsnapshot","routeSlug":"/v1-api-reference/api/payment-method-snapshots/object_getpaymentmethodsnapshot","metadata":{"seo":{"title":"CRUD: Retrieve a payment method snapshot","description":"This REST API reference describes how to retrieve a Payment Method Snapshot."}},"httpPath":"/v1/object/payment-method-snapshot/{id}"}]},{"type":"group","label":"Payment Method Transaction Logs","link":"/v1-api-reference/api/payment-method-transaction-logs","routeSlug":"/v1-api-reference/api/payment-method-transaction-logs","items":[{"label":"CRUD: Retrieve a payment method transaction log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-method-transaction-logs/object_getpaymentmethodtransactionlog","routeSlug":"/v1-api-reference/api/payment-method-transaction-logs/object_getpaymentmethodtransactionlog","metadata":{"seo":{"title":"CRUD: Retrieve a payment method transaction log","description":"Retrieves a Payment Method Transaction Log object."}},"httpPath":"/v1/object/payment-method-transaction-log/{id}"}]},{"type":"group","label":"Hosted Pages","link":"/v1-api-reference/api/hosted-pages","routeSlug":"/v1-api-reference/api/hosted-pages","items":[{"label":"List hosted pages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/hosted-pages/get_hostedpages","routeSlug":"/v1-api-reference/api/hosted-pages/get_hostedpages","metadata":{"seo":{"title":"List hosted pages","description":"Returns the Payment Pages configuration metadata,specifically, page ID, page version, payment method type."}},"httpPath":"/v1/hostedpages"}]},{"type":"group","label":"RSA Signatures","link":"/v1-api-reference/api/rsa-signatures","routeSlug":"/v1-api-reference/api/rsa-signatures","items":[{"label":"Generate an RSA signature","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/rsa-signatures/post_rsasignatures","routeSlug":"/v1-api-reference/api/rsa-signatures/post_rsasignatures","metadata":{"seo":{"title":"Generate an RSA signature","description":"The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature. The POST rsa_signatures call generates and returns the required digital signature and token for a Payment Pages 2.0 form. You need to pass the generated signature to your client for it to access Payment Pages 2.0."}},"httpPath":"/v1/rsa-signatures"},{"label":"Decrypt an RSA signature","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/rsa-signatures/post_decryptrsasignatures","routeSlug":"/v1-api-reference/api/rsa-signatures/post_decryptrsasignatures","metadata":{"seo":{"title":"Decrypt an RSA signature","description":"The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature. You use rsa_signatures to generate the required digital signature and token for a Payment Pages 2.0 form, and then you use the decrypt REST service to decrypt the signature to validate the signature and key."}},"httpPath":"/v1/rsa-signatures/decrypt"}]},{"type":"separator","label":"Payments"},{"type":"group","label":"Payment Authorization","link":"/v1-api-reference/api/payment-authorization","routeSlug":"/v1-api-reference/api/payment-authorization","items":[{"label":"Create authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-authorization/post_createauthorization","routeSlug":"/v1-api-reference/api/payment-authorization/post_createauthorization","metadata":{"seo":{"title":"Create authorization","description":"Enables you to authorize the availability of funds for a transaction but delay the capture of funds until a later time. Subsequently, use Create a payment or Create an order to capture the authorized funds, or use Cancel authorization to cancel the authorization."}},"httpPath":"/v1/payment-methods/{payment-method-id}/authorize"},{"label":"Cancel authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-authorization/post_cancelauthorization","routeSlug":"/v1-api-reference/api/payment-authorization/post_cancelauthorization","metadata":{"seo":{"title":"Cancel authorization","description":"Allows you to cancel an authorization. For gateway integrations that support this operation, see Delayed Capture."}},"httpPath":"/v1/payment-methods/{payment-method-id}/voidAuthorize"}]},{"type":"group","label":"Payment Gateways","link":"/v1-api-reference/api/payment-gateways","routeSlug":"/v1-api-reference/api/payment-gateways","items":[{"label":"List all payment gateways","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-gateways/get_paymentgateways","routeSlug":"/v1-api-reference/api/payment-gateways/get_paymentgateways","metadata":{"seo":{"title":"List all payment gateways","description":"Retrieves all payment gateways configured in your tenant in a single, non-paginated response. There is no limit on the number of gateways returned."}},"httpPath":"/v1/paymentgateways"},{"label":"Trigger a pre-debit notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-gateways/triggerpredebitnotification","routeSlug":"/v1-api-reference/api/payment-gateways/triggerpredebitnotification","metadata":{"seo":{"title":"Trigger a pre-debit notification","description":"To support processing recurring UPI payments through Adyen Integration v2.0,a pre-debit notification for each posted invoice must be sent to the UPI usersbefore collecting the recurring payments. Use this operation to send pre-debit notification requeststo the gateway for invoices that meet the requirements.See Implement UPI on Adyen Integration v2.0 for more information."}},"httpPath":"/v1/payment-gateways/pre-debit-notification"}]},{"type":"group","label":"Payment Gateway Reconciliation","link":"/v1-api-reference/api/payment-gateway-reconciliation","routeSlug":"/v1-api-reference/api/payment-gateway-reconciliation","items":[{"label":"Reverse a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-gateway-reconciliation/post_reversepayment","routeSlug":"/v1-api-reference/api/payment-gateway-reconciliation/post_reversepayment","metadata":{"seo":{"title":"Reverse a payment","description":"If the Asynchronous Payment Statuses feature is not enabled, thisAPI operation sets the Gateway State field of the payment to Settled, createsa refund for the amount specified in the request, and returns the Refund objectas response."}},"httpPath":"/v1/gateway-settlement/payments/{payment-key}/chargeback"},{"label":"Reject a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-gateway-reconciliation/post_rejectpayment","routeSlug":"/v1-api-reference/api/payment-gateway-reconciliation/post_rejectpayment","metadata":{"seo":{"title":"Reject a payment","description":"If the Asynchronous Payment Statuses feature is not enabled, thisAPI operation sets the Gateway State field of the payment to FailedToSettle,creates a refund for the payment amount, and returns the Refund object as response."}},"httpPath":"/v1/gateway-settlement/payments/{payment-key}/reject"},{"label":"Settle a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-gateway-reconciliation/post_settlepayment","routeSlug":"/v1-api-reference/api/payment-gateway-reconciliation/post_settlepayment","metadata":{"seo":{"title":"Settle a payment","description":"If the Asynchronous Payment Statuses feature is not enabled, this API operation sets the Gateway State field of the payment to Settled and returns the Payment object as response."}},"httpPath":"/v1/gateway-settlement/payments/{payment-key}/settle"},{"label":"Reconcile a refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-gateway-reconciliation/post_reconcilerefund","routeSlug":"/v1-api-reference/api/payment-gateway-reconciliation/post_reconcilerefund","metadata":{"seo":{"title":"Reconcile a refund","description":"Reconciles a refund when receiving the gateway reconciliation request or event."}},"httpPath":"/v1/refunds/{refund-key}/reconcile"}]},{"type":"group","label":"Payments","link":"/v1-api-reference/api/payments","routeSlug":"/v1-api-reference/api/payments","items":[{"label":"List payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/get_retrieveallpayments","routeSlug":"/v1-api-reference/api/payments/get_retrieveallpayments","metadata":{"seo":{"title":"List payments","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payments"},{"label":"Create a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/post_createpayment","routeSlug":"/v1-api-reference/api/payments/post_createpayment","metadata":{"seo":{"title":"Create a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payments"},{"label":"Update a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/put_updatepayment","routeSlug":"/v1-api-reference/api/payments/put_updatepayment","metadata":{"seo":{"title":"Update a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payments/{paymentKey}"},{"label":"Delete a payment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/delete_payment","routeSlug":"/v1-api-reference/api/payments/delete_payment","metadata":{"seo":{"title":"Delete a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payments/{paymentKey}"},{"label":"Retrieve a payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/get_payment","routeSlug":"/v1-api-reference/api/payments/get_payment","metadata":{"seo":{"title":"Retrieve a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payments/{paymentKey}"},{"label":"Apply a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/put_applypayment","routeSlug":"/v1-api-reference/api/payments/put_applypayment","metadata":{"seo":{"title":"Apply a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payments/{paymentKey}/apply"},{"label":"Cancel a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/put_cancelpayment","routeSlug":"/v1-api-reference/api/payments/put_cancelpayment","metadata":{"seo":{"title":"Cancel a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payments/{paymentKey}/cancel"},{"label":"List all parts of a payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/get_paymentparts","routeSlug":"/v1-api-reference/api/payments/get_paymentparts","metadata":{"seo":{"title":"List all parts of a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payments/{paymentKey}/parts"},{"label":"Retrieve a payment part","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/get_paymentpart","routeSlug":"/v1-api-reference/api/payments/get_paymentpart","metadata":{"seo":{"title":"Retrieve a payment part","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payments/{paymentKey}/parts/{partid}"},{"label":"List all payment part items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/get_paymentitemparts","routeSlug":"/v1-api-reference/api/payments/get_paymentitemparts","metadata":{"seo":{"title":"List all payment part items","description":"Note: This operation is only available if you have the Invoice Item Settlement feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payments/{paymentKey}/parts/{partid}/item-parts"},{"label":"Retrieve a payment part item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/get_paymentitempart","routeSlug":"/v1-api-reference/api/payments/get_paymentitempart","metadata":{"seo":{"title":"Retrieve a payment part item","description":"Note: This operation is only available if you have the Invoice Item Settlement feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payments/{paymentKey}/parts/{partid}/item-parts/{itempartid}"},{"label":"Refund a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/post_refundpayment","routeSlug":"/v1-api-reference/api/payments/post_refundpayment","metadata":{"seo":{"title":"Refund a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payments/{paymentKey}/refunds"},{"label":"Refund a payment with auto-unapplying","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/post_refundpaymentwithautounapply","routeSlug":"/v1-api-reference/api/payments/post_refundpaymentwithautounapply","metadata":{"seo":{"title":"Refund a payment with auto-unapplying","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payments/{paymentKey}/refunds/unapply"},{"label":"Transfer a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/put_transferpayment","routeSlug":"/v1-api-reference/api/payments/put_transferpayment","metadata":{"seo":{"title":"Transfer a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payments/{paymentKey}/transfer"},{"label":"Unapply a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/put_unapplypayment","routeSlug":"/v1-api-reference/api/payments/put_unapplypayment","metadata":{"seo":{"title":"Unapply a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payments/{paymentKey}/unapply"}]},{"type":"group","label":"Payment Transaction Logs","link":"/v1-api-reference/api/payment-transaction-logs","routeSlug":"/v1-api-reference/api/payment-transaction-logs","items":[{"label":"CRUD: Retrieve a payment transaction log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-transaction-logs/object_getpaymenttransactionlog","routeSlug":"/v1-api-reference/api/payment-transaction-logs/object_getpaymenttransactionlog","metadata":{"seo":{"title":"CRUD: Retrieve a payment transaction log","description":"Retrieves information about a specific payment transaction log."}},"httpPath":"/v1/object/payment-transaction-log/{id}"}]},{"type":"group","label":"Payment Runs","link":"/v1-api-reference/api/payment-runs","routeSlug":"/v1-api-reference/api/payment-runs","items":[{"label":"List payment runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-runs/get_paymentruns","routeSlug":"/v1-api-reference/api/payment-runs/get_paymentruns","metadata":{"seo":{"title":"List payment runs","description":"Retrieves the information about all payment runs. You can define filterable fields to restrict the data returned in the response."}},"httpPath":"/v1/payment-runs"},{"label":"Create a payment run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-runs/post_paymentrun","routeSlug":"/v1-api-reference/api/payment-runs/post_paymentrun","metadata":{"seo":{"title":"Create a payment run","description":"Creates a payment run. You can create a payment run to be executed immediately after it is created, or a scheduled payment run to be executed in future."}},"httpPath":"/v1/payment-runs"},{"label":"Delete a payment run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-runs/delete_paymentrun","routeSlug":"/v1-api-reference/api/payment-runs/delete_paymentrun","metadata":{"seo":{"title":"Delete a payment run","description":"Deletes a payment run. Only payment runs with the Canceled or Error status can be deleted."}},"httpPath":"/v1/payment-runs/{paymentRunKey}"},{"label":"Retrieve a payment run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-runs/get_paymentrun","routeSlug":"/v1-api-reference/api/payment-runs/get_paymentrun","metadata":{"seo":{"title":"Retrieve a payment run","description":"Retrives the information about a specific payment run."}},"httpPath":"/v1/payment-runs/{paymentRunKey}"},{"label":"Update a payment run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-runs/put_paymentrun","routeSlug":"/v1-api-reference/api/payment-runs/put_paymentrun","metadata":{"seo":{"title":"Update a payment run","description":"Updates the information about an unexecuted payment run. Only pending payment runs can be updated."}},"httpPath":"/v1/payment-runs/{paymentRunKey}"},{"label":"Retrieve payment run data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-runs/get_paymentrundata","routeSlug":"/v1-api-reference/api/payment-runs/get_paymentrundata","metadata":{"seo":{"title":"Retrieve payment run data","description":"Retrieves payment run data and the processing result with details, if the data field was specified in the Create payment run operation."}},"httpPath":"/v1/payment-runs/{paymentRunKey}/data"},{"label":"Retrieve a payment run summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-runs/get_paymentrunsummary","routeSlug":"/v1-api-reference/api/payment-runs/get_paymentrunsummary","metadata":{"seo":{"title":"Retrieve a payment run summary","description":"Retrives the summary of a payment run."}},"httpPath":"/v1/payment-runs/{paymentRunKey}/summary"}]},{"type":"group","label":"Payment Schedules","link":"/v1-api-reference/api/payment-schedules","routeSlug":"/v1-api-reference/api/payment-schedules","items":[{"label":"Retry failed payment schedule items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/post_retrypaymentscheduleitem","routeSlug":"/v1-api-reference/api/payment-schedules/post_retrypaymentscheduleitem","metadata":{"seo":{"title":"Retry failed payment schedule items","description":"Retries failed payment schedule items. The payment method and payment gateway of the failed payment can be updated to new values before the retry."}},"httpPath":"/v1/payment-schedule-items/retry-payment"},{"label":"Cancel a payment schedule item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/put_cancelpaymentscheduleitem","routeSlug":"/v1-api-reference/api/payment-schedules/put_cancelpaymentscheduleitem","metadata":{"seo":{"title":"Cancel a payment schedule item","description":"Cancels a payment schedule item by ID."}},"httpPath":"/v1/payment-schedule-items/{item-id}/cancel"},{"label":"Skip a payment schedule item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/put_skippaymentscheduleitem","routeSlug":"/v1-api-reference/api/payment-schedules/put_skippaymentscheduleitem","metadata":{"seo":{"title":"Skip a payment schedule item","description":"Skips a payment schedule item by ID. The skipped payment schedule item will turn to the canceled status, and a new item will be scheduled on the next recurring date after the last existing scheduled date."}},"httpPath":"/v1/payment-schedule-items/{item-id}/skip"},{"label":"Retrieve a payment schedule item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/get_paymentscheduleitem","routeSlug":"/v1-api-reference/api/payment-schedules/get_paymentscheduleitem","metadata":{"seo":{"title":"Retrieve a payment schedule item","description":"Retrieves a payment schedule item by ID."}},"httpPath":"/v1/payment-schedule-items/{psi-id}"},{"label":"Update a payment schedule item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/put_paymentscheduleitem","routeSlug":"/v1-api-reference/api/payment-schedules/put_paymentscheduleitem","metadata":{"seo":{"title":"Update a payment schedule item","description":"Updates a payment schedule item by ID."}},"httpPath":"/v1/payment-schedule-items/{psi-id}"},{"label":"Delete a payment schedule item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/deletepaymentscheduleitem","routeSlug":"/v1-api-reference/api/payment-schedules/deletepaymentscheduleitem","metadata":{"seo":{"title":"Delete a payment schedule item","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payment-schedule-items/{psi-id}"},{"label":"List payment schedules by customer account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/get_paymentschedules","routeSlug":"/v1-api-reference/api/payment-schedules/get_paymentschedules","metadata":{"seo":{"title":"List payment schedules by customer account","description":"Retrieves payment schedules of a customer account."}},"httpPath":"/v1/payment-schedules"},{"label":"Create a payment schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/post_paymentschedule","routeSlug":"/v1-api-reference/api/payment-schedules/post_paymentschedule","metadata":{"seo":{"title":"Create a payment schedule","description":"Creates a payment schedule. You can create either recurring payment schedules or custom payment schedules."}},"httpPath":"/v1/payment-schedules"},{"label":"Create multiple payment schedules at once","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/post_paymentschedules","routeSlug":"/v1-api-reference/api/payment-schedules/post_paymentschedules","metadata":{"seo":{"title":"Create multiple payment schedules at once","description":"Creates multiple payment schedules at once. You can create both recurring payment schedules and custom payment schedules in one request.The maximum number of payment schedules that can be created by a single request is 50.The maximum number of payment schedule items that each payment schedule can contain is 1000, i.e., you must specify less than 1000 items for a custom payment schedule, and the occurrences field must be less than 1000 for a recurring payment schedule."}},"httpPath":"/v1/payment-schedules/batch"},{"label":"Retrieve payment schedule statistic of a date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/get_paymentschedulestatistic","routeSlug":"/v1-api-reference/api/payment-schedules/get_paymentschedulestatistic","metadata":{"seo":{"title":"Retrieve payment schedule statistic of a date","description":"Retrieves the payment schedule statistic of a specific date."}},"httpPath":"/v1/payment-schedules/statistics/{yyyy-mm-dd}"},{"label":"Retrieve a payment schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/get_paymentschedule","routeSlug":"/v1-api-reference/api/payment-schedules/get_paymentschedule","metadata":{"seo":{"title":"Retrieve a payment schedule","description":"Retrieves a payment schedule by payment schedule key."}},"httpPath":"/v1/payment-schedules/{paymentScheduleKey}"},{"label":"Update a payment schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/put_paymentschedule","routeSlug":"/v1-api-reference/api/payment-schedules/put_paymentschedule","metadata":{"seo":{"title":"Update a payment schedule","description":"Updates a payment schedule. For custom payment schedules, only the custom fields on the payment schedules can be udpated. Use the Update a payment schedule item operation to update payment schedule items of custom payment schedule."}},"httpPath":"/v1/payment-schedules/{paymentScheduleKey}"},{"label":"Delete a payment schedule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/deletepaymentschedule","routeSlug":"/v1-api-reference/api/payment-schedules/deletepaymentschedule","metadata":{"seo":{"title":"Delete a payment schedule","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/payment-schedules/{paymentScheduleKey}"},{"label":"Cancel a payment schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/put_cancelpaymentschedule","routeSlug":"/v1-api-reference/api/payment-schedules/put_cancelpaymentschedule","metadata":{"seo":{"title":"Cancel a payment schedule","description":"Cancels a payment schedule."}},"httpPath":"/v1/payment-schedules/{paymentScheduleKey}/cancel"},{"label":"Add payment schedule items to a custom payment schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/post_additemstocustompaymentschedule","routeSlug":"/v1-api-reference/api/payment-schedules/post_additemstocustompaymentschedule","metadata":{"seo":{"title":"Add payment schedule items to a custom payment schedule","description":"Adds payment schedule items to a custom payment schedule. You cannot use this operation to add payment schedule items to recurring payment schedules."}},"httpPath":"/v1/payment-schedules/{paymentScheduleKey}/items"},{"label":"Preview the result of payment schedule updates","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/put_paymentscheduleupdatepreview","routeSlug":"/v1-api-reference/api/payment-schedules/put_paymentscheduleupdatepreview","metadata":{"seo":{"title":"Preview the result of payment schedule updates","description":"Preview the result of a payment schedule update. This operation only provides a preview. No changes will be made to the database. For custom payment schedules, only the custom fields on the payment schedules can be udpated. Use the Update a payment schedule item operation to update payment schedule items of custom payment schedule."}},"httpPath":"/v1/payment-schedules/{paymentScheduleKey}/preview"}]},{"type":"group","label":"Refunds","link":"/v1-api-reference/api/refunds","routeSlug":"/v1-api-reference/api/refunds","items":[{"label":"List refunds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/get_refunds","routeSlug":"/v1-api-reference/api/refunds/get_refunds","metadata":{"seo":{"title":"List refunds","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/refunds"},{"label":"Update a refund","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/put_updaterefund","routeSlug":"/v1-api-reference/api/refunds/put_updaterefund","metadata":{"seo":{"title":"Update a refund","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/refunds/{refundKey}"},{"label":"Delete a refund","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/delete_refund","routeSlug":"/v1-api-reference/api/refunds/delete_refund","metadata":{"seo":{"title":"Delete a refund","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/refunds/{refundKey}"},{"label":"Retrieve a refund","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/get_refund","routeSlug":"/v1-api-reference/api/refunds/get_refund","metadata":{"seo":{"title":"Retrieve a refund","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/refunds/{refundKey}"},{"label":"Cancel a refund","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/put_cancelrefund","routeSlug":"/v1-api-reference/api/refunds/put_cancelrefund","metadata":{"seo":{"title":"Cancel a refund","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/refunds/{refundKey}/cancel"},{"label":"List all parts of a refund","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/get_refundparts","routeSlug":"/v1-api-reference/api/refunds/get_refundparts","metadata":{"seo":{"title":"List all parts of a refund","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/refunds/{refundKey}/parts"},{"label":"Retrieve a refund part","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/get_refundpart","routeSlug":"/v1-api-reference/api/refunds/get_refundpart","metadata":{"seo":{"title":"Retrieve a refund part","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/refunds/{refundKey}/parts/{refundpartid}"},{"label":"List all refund part items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/get_refunditemparts","routeSlug":"/v1-api-reference/api/refunds/get_refunditemparts","metadata":{"seo":{"title":"List all refund part items","description":"Note: This operation is only available if you have the Invoice Item Settlement feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/refunds/{refundKey}/parts/{refundpartid}/item-parts"},{"label":"Retrieve a refund part item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/get_refunditempart","routeSlug":"/v1-api-reference/api/refunds/get_refunditempart","metadata":{"seo":{"title":"Retrieve a refund part item","description":"Note: This operation is only available if you have the Invoice Item Settlement feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/refunds/{refundKey}/parts/{refundpartid}/item-parts/{itempartid}"}]},{"type":"group","label":"Payment Profiles","link":"/v1-api-reference/api/payment-profiles","routeSlug":"/v1-api-reference/api/payment-profiles","items":[{"label":"Create or update payment profiles in bulk","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-profiles/upsertpaymentprofiles","routeSlug":"/v1-api-reference/api/payment-profiles/upsertpaymentprofiles","metadata":{"seo":{"title":"Create or update payment profiles in bulk","description":"Bulk creates payment profiles or updates payment profiles if they already exist."}},"httpPath":"/v1/payment-profile"}]},{"type":"group","label":"Configurable Payment Retry","link":"/v1-api-reference/api/configurable-payment-retry","routeSlug":"/v1-api-reference/api/configurable-payment-retry","items":[{"label":"List the active retry cycles for an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getactiveinvoicecycle","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getactiveinvoicecycle","metadata":{"seo":{"title":"List the active retry cycles for an invoice","description":"Gets information of active retry cycles that have not been completed for an invoice in Configurable Payment Retry."}},"httpPath":"/api/v1/payments/active_invoice_cycle_information/{invoice_id}"},{"label":"List the active retry cycles for a debit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getactivedebitmemocycle","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getactivedebitmemocycle","metadata":{"seo":{"title":"List the active retry cycles for a debit memo","description":"Gets information of active retry cycles that have not been completed for a debit memo in Configurable Payment Retry."}},"httpPath":"/api/v1/payments/active_debit_memo_cycle_information/{debit_memo_id}"},{"label":"List the active retry cycles for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getactiveaccountcycle","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getactiveaccountcycle","metadata":{"seo":{"title":"List the active retry cycles for an account","description":"Gets information of active retry cycles that have not been completed for an account in Configurable Payment Retry."}},"httpPath":"/api/v1/payments/active_account_cycle_information/{account_id}"},{"label":"List the retry cycle history for an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getinvoicecyclehistory","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getinvoicecyclehistory","metadata":{"seo":{"title":"List the retry cycle history for an invoice","description":"Gets information of all retry cycles for an invoice in Configurable Payment Retry."}},"httpPath":"/api/v1/payments/invoice_cycle_history/{invoice_id}"},{"label":"List the retry cycle history for a debit memo.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getdebitmemocyclehistory","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getdebitmemocyclehistory","metadata":{"seo":{"title":"List the retry cycle history for a debit memo.","description":"Gets information of all retry cycles for a debit memo in Configurable Payment Retry."}},"httpPath":"/api/v1/payments/debit_memo_cycle_history/{debit_memo_id}"},{"label":"List the retry cycle history for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getaccountcyclehistory","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getaccountcyclehistory","metadata":{"seo":{"title":"List the retry cycle history for an account","description":"Gets information of all retry cycles for an account in Configurable Payment Retry."}},"httpPath":"/api/v1/payments/account_cycle_history/{account_id}"},{"label":"Execute the invoice payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/putexecuteinvoicepayment","routeSlug":"/v1-api-reference/api/configurable-payment-retry/putexecuteinvoicepayment","metadata":{"seo":{"title":"Execute the invoice payment","description":"For all active retry cycles associated with an invoice, schedules the next payment retry attempt to occur in the next hourly payment processor run."}},"httpPath":"/api/v1/payments/execute_invoice_payment/{invoice_id}"},{"label":"Execute the debit memo payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/putexecutedebitmemopayment","routeSlug":"/v1-api-reference/api/configurable-payment-retry/putexecutedebitmemopayment","metadata":{"seo":{"title":"Execute the debit memo payment","description":"For all active retry cycles associated with a debit memo, schedules the next payment retry attempt to occur in the next hourly payment processor run."}},"httpPath":"/api/v1/payments/execute_debit_memo_payment/{debit_memo_id}"},{"label":"Execute the account payments","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/putexecuteaccountpayments","routeSlug":"/v1-api-reference/api/configurable-payment-retry/putexecuteaccountpayments","metadata":{"seo":{"title":"Execute the account payments","description":"For all active retry cycles associated with an account, schedules the next payment retry attempt to occur in the next hourly payment processor run."}},"httpPath":"/api/v1/payments/execute_account_payments/{account_id}"},{"label":"Execute payments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/postexecutepayments","routeSlug":"/v1-api-reference/api/configurable-payment-retry/postexecutepayments","metadata":{"seo":{"title":"Execute payments","description":"For all active retry cycles associated with the invoice, debit memo, and/or account IDs provided, schedules the next payment retry attempt to occur in the next hourly payment processor run."}},"httpPath":"/api/v1/payments/execute_payments"},{"label":"Remove an invoice from retry cycle","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/putremoveinovicefromcycle","routeSlug":"/v1-api-reference/api/configurable-payment-retry/putremoveinovicefromcycle","metadata":{"seo":{"title":"Remove an invoice from retry cycle","description":"Stops any active retry cycles associated with the invoice provided."}},"httpPath":"/api/v1/payments/remove_invoice_from_retry_cycle/{invoice_id}"},{"label":"Remove a debit memo from retry cycle","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/putremovedebitmemofromcycle","routeSlug":"/v1-api-reference/api/configurable-payment-retry/putremovedebitmemofromcycle","metadata":{"seo":{"title":"Remove a debit memo from retry cycle","description":"Stops any active retry cycles associated with the debit memo provided."}},"httpPath":"/api/v1/payments/remove_debit_memo_from_retry_cycle/{debit_memo_id}"},{"label":"Remove an account from retry cycle","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/putremoveaccountfromcycle","routeSlug":"/v1-api-reference/api/configurable-payment-retry/putremoveaccountfromcycle","metadata":{"seo":{"title":"Remove an account from retry cycle","description":"Stops any active retry cycles associated with the account provided."}},"httpPath":"/api/v1/payments/remove_account_from_retry_cycle/{account_id}"},{"label":"Submit a payment to retry cycle","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/postsubmitpaymenttocycle","routeSlug":"/v1-api-reference/api/configurable-payment-retry/postsubmitpaymenttocycle","metadata":{"seo":{"title":"Submit a payment to retry cycle","description":"This API request submits a failed payment to the Configurable Payment Retry retry cycle. The request adds the failed payment to the existing CPR retry cycle. If no CPR retry cycle exists, this request creates a new one and adds the failed payment."}},"httpPath":"/api/v1/payments/submit_failed_payment"},{"label":"List the baseline metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getbaselinemetrics","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getbaselinemetrics","metadata":{"seo":{"title":"List the baseline metrics","description":"Gets baseline metrics for Configurable Payment Retry, including Retry Success Rate and trend, Document Success Rate and trend, and Average Days Outstanding and trend. See Response Schema for detailed descriptions of the metrics."}},"httpPath":"/api/v1/metrics/baseline"},{"label":"List the amount recovered metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getamountrecovered","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getamountrecovered","metadata":{"seo":{"title":"List the amount recovered metrics","description":"Gets the Amount Recovered metrics, including the total amount recovered and the amount recovered over the last 30 days broken down by currency."}},"httpPath":"/api/v1/metrics/amount_recovered"},{"label":"List the document success rate metrics by customer group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getdocumentsuccessratebycustomergroup","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getdocumentsuccessratebycustomergroup","metadata":{"seo":{"title":"List the document success rate metrics by customer group","description":"Gets the Document Success Rate timeseries for each customer group over the past 6 months. The data of the current month will not be included. For example, if it is April 15th today, the data for April will not be included. Data for March and earlier will be shown."}},"httpPath":"/api/v1/metrics/customer_group_over_time"},{"label":"List the customer group metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getcustomergroupmetrics","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getcustomergroupmetrics","metadata":{"seo":{"title":"List the customer group metrics","description":"Gets the following metrics for each customer group that is in the active status: - Document Success Rate and trend - Retry Success Rate - Average Attempts"}},"httpPath":"/api/v1/metrics/customer_group"}]},{"type":"separator","label":"Object Query"},{"type":"group","label":"Object Queries","link":"/v1-api-reference/api/object-queries","routeSlug":"/v1-api-reference/api/object-queries","items":[{"label":"List accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryaccounts","routeSlug":"/v1-api-reference/api/object-queries/queryaccounts","metadata":{"seo":{"title":"List accounts","description":"Lists accounts. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/accounts"},{"label":"Retrieve an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryaccountbykey","routeSlug":"/v1-api-reference/api/object-queries/queryaccountbykey","metadata":{"seo":{"title":"Retrieve an account","description":"Retrieve the details of a specific Account object."}},"httpPath":"/object-query/accounts/{key}"},{"label":"List amendments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryamendments","routeSlug":"/v1-api-reference/api/object-queries/queryamendments","metadata":{"seo":{"title":"List amendments","description":"Lists amendments. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/amendments"},{"label":"Retrieve an amendment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryamendmentbykey","routeSlug":"/v1-api-reference/api/object-queries/queryamendmentbykey","metadata":{"seo":{"title":"Retrieve an amendment","description":"Retrieve the details of a specific Amendment object."}},"httpPath":"/object-query/amendments/{key}"},{"label":"List bill runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querybillingruns","routeSlug":"/v1-api-reference/api/object-queries/querybillingruns","metadata":{"seo":{"title":"List bill runs","description":"Lists bill runs. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/billing-runs"},{"label":"Retrieve a bill run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querybillingrunbykey","routeSlug":"/v1-api-reference/api/object-queries/querybillingrunbykey","metadata":{"seo":{"title":"Retrieve a bill run","description":"Retrieve the details of a specific Bill Run object."}},"httpPath":"/object-query/billing-runs/{key}"},{"label":"List contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycontacts","routeSlug":"/v1-api-reference/api/object-queries/querycontacts","metadata":{"seo":{"title":"List contacts","description":"Lists contacts. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/contacts"},{"label":"Retrieve a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycontactbykey","routeSlug":"/v1-api-reference/api/object-queries/querycontactbykey","metadata":{"seo":{"title":"Retrieve a contact","description":"Retrieve the details of a specific Contact object."}},"httpPath":"/object-query/contacts/{key}"},{"label":"List credit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycreditmemos","routeSlug":"/v1-api-reference/api/object-queries/querycreditmemos","metadata":{"seo":{"title":"List credit memos","description":"Lists credit memos. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/credit-memos"},{"label":"Retrieve a credit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycreditmemobykey","routeSlug":"/v1-api-reference/api/object-queries/querycreditmemobykey","metadata":{"seo":{"title":"Retrieve a credit memo","description":"Retrieve the details of a specific Credit Memo object."}},"httpPath":"/object-query/credit-memos/{key}"},{"label":"List credit memo applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycreditmemoapplications","routeSlug":"/v1-api-reference/api/object-queries/querycreditmemoapplications","metadata":{"seo":{"title":"List credit memo applications","description":"Lists credit memo applications. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/credit-memo-applications"},{"label":"Retrieve a credit memo application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycreditmemoapplicationbykey","routeSlug":"/v1-api-reference/api/object-queries/querycreditmemoapplicationbykey","metadata":{"seo":{"title":"Retrieve a credit memo application","description":"Retrieve the details of a specific Credit Memo Application object."}},"httpPath":"/object-query/credit-memo-applications/{key}"},{"label":"List credit memo items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycreditmemoitems","routeSlug":"/v1-api-reference/api/object-queries/querycreditmemoitems","metadata":{"seo":{"title":"List credit memo items","description":"Lists credit memo items. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/credit-memo-items"},{"label":"Retrieve a credit memo item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycreditmemoitembykey","routeSlug":"/v1-api-reference/api/object-queries/querycreditmemoitembykey","metadata":{"seo":{"title":"Retrieve a credit memo item","description":"Retrieve the details of a specific Credit Memo Item object."}},"httpPath":"/object-query/credit-memo-items/{key}"},{"label":"List daily consumption summaries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydailyconsumptionsummaries","routeSlug":"/v1-api-reference/api/object-queries/querydailyconsumptionsummaries","metadata":{"seo":{"title":"List daily consumption summaries","description":"Lists daily consumption summaries. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/daily-consumption-summaries"},{"label":"Retrieve a daily consumption summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydailyconsumptionsummarybykey","routeSlug":"/v1-api-reference/api/object-queries/querydailyconsumptionsummarybykey","metadata":{"seo":{"title":"Retrieve a daily consumption summary","description":"Retrieve the details of a specific Daily Consumption Summary object."}},"httpPath":"/object-query/daily-consumption-summaries/{key}"},{"label":"List debit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydebitmemos","routeSlug":"/v1-api-reference/api/object-queries/querydebitmemos","metadata":{"seo":{"title":"List debit memos","description":"Lists debit memos. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/debit-memos"},{"label":"Retrieve a debit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydebitmemobykey","routeSlug":"/v1-api-reference/api/object-queries/querydebitmemobykey","metadata":{"seo":{"title":"Retrieve a debit memo","description":"Retrieve the details of a specific Debit Memo object."}},"httpPath":"/object-query/debit-memos/{key}"},{"label":"List debit memo items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydebitmemoitems","routeSlug":"/v1-api-reference/api/object-queries/querydebitmemoitems","metadata":{"seo":{"title":"List debit memo items","description":"Lists debit memo items. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/debit-memo-items"},{"label":"Retrieve a debit memo item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydebitmemoitembykey","routeSlug":"/v1-api-reference/api/object-queries/querydebitmemoitembykey","metadata":{"seo":{"title":"Retrieve a debit memo item","description":"Retrieve the details of a specific Debit Memo Item object."}},"httpPath":"/object-query/debit-memo-items/{key}"},{"label":"List delivery adjustments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydeliveryadjustments","routeSlug":"/v1-api-reference/api/object-queries/querydeliveryadjustments","metadata":{"seo":{"title":"List delivery adjustments","description":"Lists Delivery Adjustment objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/delivery-adjustments"},{"label":"Retrieve a delivery adjustment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydeliveryadjustmentbykey","routeSlug":"/v1-api-reference/api/object-queries/querydeliveryadjustmentbykey","metadata":{"seo":{"title":"Retrieve a delivery adjustment","description":"Retrieves a Delivery Adjustment object. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/delivery-adjustments/{key}"},{"label":"List fulfillments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryfulfillments","routeSlug":"/v1-api-reference/api/object-queries/queryfulfillments","metadata":{"seo":{"title":"List fulfillments","description":"Lists Fulfillment objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/fulfillments"},{"label":"Retrieve a fulfillment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryfulfillmentbykey","routeSlug":"/v1-api-reference/api/object-queries/queryfulfillmentbykey","metadata":{"seo":{"title":"Retrieve a fulfillment","description":"Retrieves a Fulfillment object. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/fulfillments/{key}"},{"label":"List invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryinvoices","routeSlug":"/v1-api-reference/api/object-queries/queryinvoices","metadata":{"seo":{"title":"List invoices","description":"Lists invoices. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/invoices"},{"label":"Retrieve an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryinvoicebykey","routeSlug":"/v1-api-reference/api/object-queries/queryinvoicebykey","metadata":{"seo":{"title":"Retrieve an invoice","description":"Retrieves the details of a specific Invoice object."}},"httpPath":"/object-query/invoices/{key}"},{"label":"List invoice items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryinvoiceitems","routeSlug":"/v1-api-reference/api/object-queries/queryinvoiceitems","metadata":{"seo":{"title":"List invoice items","description":"Lists invoice items. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/invoice-items"},{"label":"Retrieve an invoice item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryinvoiceitembykey","routeSlug":"/v1-api-reference/api/object-queries/queryinvoiceitembykey","metadata":{"seo":{"title":"Retrieve an invoice item","description":"Retrieve the details of a specific Invoice Item object."}},"httpPath":"/object-query/invoice-items/{key}"},{"label":"List invoice schedules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryinvoiceschedules","routeSlug":"/v1-api-reference/api/object-queries/queryinvoiceschedules","metadata":{"seo":{"title":"List invoice schedules","description":"Lists invoice schedules. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/invoice-schedules"},{"label":"Retrieve an invoice schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryinvoiceschedulebykey","routeSlug":"/v1-api-reference/api/object-queries/queryinvoiceschedulebykey","metadata":{"seo":{"title":"Retrieve an invoice schedule","description":"Retrieves the details of a specific Invoice Schedule object."}},"httpPath":"/object-query/invoice-schedules/{key}"},{"label":"List order actions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryorderactions","routeSlug":"/v1-api-reference/api/object-queries/queryorderactions","metadata":{"seo":{"title":"List order actions","description":"Lists order actions. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/order-actions"},{"label":"Retrieve an order action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryorderactionbykey","routeSlug":"/v1-api-reference/api/object-queries/queryorderactionbykey","metadata":{"seo":{"title":"Retrieve an order action","description":"Retrieve the details of a specific Order Action object."}},"httpPath":"/object-query/order-actions/{key}"},{"label":"List order line items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryorderlineitems","routeSlug":"/v1-api-reference/api/object-queries/queryorderlineitems","metadata":{"seo":{"title":"List order line items","description":"Lists order line items. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/order-line-items"},{"label":"Retrieve an order line item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryorderlineitembykey","routeSlug":"/v1-api-reference/api/object-queries/queryorderlineitembykey","metadata":{"seo":{"title":"Retrieve an order line item","description":"Retrieve the details of a specific Order Line Item object."}},"httpPath":"/object-query/order-line-items/{key}"},{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryorders","routeSlug":"/v1-api-reference/api/object-queries/queryorders","metadata":{"seo":{"title":"List orders","description":"Lists orders. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/orders"},{"label":"Retrieve an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryordersbykey","routeSlug":"/v1-api-reference/api/object-queries/queryordersbykey","metadata":{"seo":{"title":"Retrieve an order","description":"Retrieve the details of a specific Order object."}},"httpPath":"/object-query/orders/{key}"},{"label":"List payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypayments","routeSlug":"/v1-api-reference/api/object-queries/querypayments","metadata":{"seo":{"title":"List payments","description":"Lists payments. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/payments"},{"label":"Retrieve a payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentbykey","routeSlug":"/v1-api-reference/api/object-queries/querypaymentbykey","metadata":{"seo":{"title":"Retrieve a payment","description":"Retrieve the details of a specific Payment object."}},"httpPath":"/object-query/payments/{key}"},{"label":"List payment applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentapplications","routeSlug":"/v1-api-reference/api/object-queries/querypaymentapplications","metadata":{"seo":{"title":"List payment applications","description":"Lists payment applications. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/payment-applications"},{"label":"Retrieve a payment application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentapplicationbykey","routeSlug":"/v1-api-reference/api/object-queries/querypaymentapplicationbykey","metadata":{"seo":{"title":"Retrieve a payment application","description":"Retrieve the details of a specific Payment Application object."}},"httpPath":"/object-query/payment-applications/{key}"},{"label":"List payment methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentmethods","routeSlug":"/v1-api-reference/api/object-queries/querypaymentmethods","metadata":{"seo":{"title":"List payment methods","description":"Lists payment methods. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/payment-methods"},{"label":"Retrieve a payment method","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentmethodbykey","routeSlug":"/v1-api-reference/api/object-queries/querypaymentmethodbykey","metadata":{"seo":{"title":"Retrieve a payment method","description":"Retrieve the details of a specific Payment Method object."}},"httpPath":"/object-query/payment-methods/{key}"},{"label":"List payment method snapshots","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentmethodsnapshots","routeSlug":"/v1-api-reference/api/object-queries/querypaymentmethodsnapshots","metadata":{"seo":{"title":"List payment method snapshots","description":"Lists payment method snapshots. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/payment-method-snapshots"},{"label":"Retrieve a payment method snapshot","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentmethodsnapshotbykey","routeSlug":"/v1-api-reference/api/object-queries/querypaymentmethodsnapshotbykey","metadata":{"seo":{"title":"Retrieve a payment method snapshot","description":"Retrieve the details of a specific Payment Method Snapshot object."}},"httpPath":"/object-query/payment-method-snapshots/{key}"},{"label":"List payment runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentruns","routeSlug":"/v1-api-reference/api/object-queries/querypaymentruns","metadata":{"seo":{"title":"List payment runs","description":"Lists payment runs. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/payment-runs"},{"label":"Retrieve a payment run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentrunbykey","routeSlug":"/v1-api-reference/api/object-queries/querypaymentrunbykey","metadata":{"seo":{"title":"Retrieve a payment run","description":"Retrieve the details of a specific Payment Run object."}},"httpPath":"/object-query/payment-runs/{key}"},{"label":"List payment schedules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentschedules","routeSlug":"/v1-api-reference/api/object-queries/querypaymentschedules","metadata":{"seo":{"title":"List payment schedules","description":"Lists payment schedules. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/payment-schedules"},{"label":"Retrieve a payment schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentschedulebykey","routeSlug":"/v1-api-reference/api/object-queries/querypaymentschedulebykey","metadata":{"seo":{"title":"Retrieve a payment schedule","description":"Retrieve the details of a specific Payment Schedule object."}},"httpPath":"/object-query/payment-schedules/{key}"},{"label":"List payment schedule items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentscheduleitems","routeSlug":"/v1-api-reference/api/object-queries/querypaymentscheduleitems","metadata":{"seo":{"title":"List payment schedule items","description":"Lists Payment Schedule Item objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/payment-schedule-items"},{"label":"Retrieve a payment schedule item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentscheduleitembykey","routeSlug":"/v1-api-reference/api/object-queries/querypaymentscheduleitembykey","metadata":{"seo":{"title":"Retrieve a payment schedule item","description":"Retrieve the details of a specific Payment Schedule Item object."}},"httpPath":"/object-query/payment-schedule-items/{key}"},{"label":"List prepaid balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprepaidbalances","routeSlug":"/v1-api-reference/api/object-queries/queryprepaidbalances","metadata":{"seo":{"title":"List prepaid balances","description":"Lists Prepaid Balance objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/prepaid-balances"},{"label":"Retrieve a prepaid balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprepaidbalancebykey","routeSlug":"/v1-api-reference/api/object-queries/queryprepaidbalancebykey","metadata":{"seo":{"title":"Retrieve a prepaid balance","description":"Retrieve the details of a specific Prepaid Balance object."}},"httpPath":"/object-query/prepaid-balances/{key}"},{"label":"List prepaid balance funds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprepaidbalancefunds","routeSlug":"/v1-api-reference/api/object-queries/queryprepaidbalancefunds","metadata":{"seo":{"title":"List prepaid balance funds","description":"Lists prepaid balance funds. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/prepaid-balance-funds"},{"label":"Retrieve a prepaid balance fund","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprepaidbalancefundbykey","routeSlug":"/v1-api-reference/api/object-queries/queryprepaidbalancefundbykey","metadata":{"seo":{"title":"Retrieve a prepaid balance fund","description":"Retrieve the details of a specific Prepaid Balance Fund object."}},"httpPath":"/object-query/prepaid-balance-funds/{key}"},{"label":"List prepaid balance transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprepaidbalancetransactions","routeSlug":"/v1-api-reference/api/object-queries/queryprepaidbalancetransactions","metadata":{"seo":{"title":"List prepaid balance transactions","description":"Lists prepaid balance transactions. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/prepaid-balance-transactions"},{"label":"Retrieve a prepaid balance transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprepaidbalancetransactionbykey","routeSlug":"/v1-api-reference/api/object-queries/queryprepaidbalancetransactionbykey","metadata":{"seo":{"title":"Retrieve a prepaid balance transaction","description":"Retrieve the details of a Prepaid Balance Transaction object."}},"httpPath":"/object-query/prepaid-balance-transactions/{key}"},{"label":"List processed usage records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprocessedusages","routeSlug":"/v1-api-reference/api/object-queries/queryprocessedusages","metadata":{"seo":{"title":"List processed usage records","description":"Lists Processed Usage Record objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/processed-usages"},{"label":"Retrieve a processed usage record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprocessedusagebykey","routeSlug":"/v1-api-reference/api/object-queries/queryprocessedusagebykey","metadata":{"seo":{"title":"Retrieve a processed usage record","description":"Retrieve the details of a specific Processed Usage Record object."}},"httpPath":"/object-query/processed-usages/{key}"},{"label":"List products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproducts","routeSlug":"/v1-api-reference/api/object-queries/queryproducts","metadata":{"seo":{"title":"List products","description":"Lists Product objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/products"},{"label":"Retrieve a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproductbykey","routeSlug":"/v1-api-reference/api/object-queries/queryproductbykey","metadata":{"seo":{"title":"Retrieve a product","description":"Retrieve the details of a specific Product object."}},"httpPath":"/object-query/products/{key}"},{"label":"List product rate plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproductrateplans","routeSlug":"/v1-api-reference/api/object-queries/queryproductrateplans","metadata":{"seo":{"title":"List product rate plans","description":"Lists Product Rate Plan objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/product-rate-plans"},{"label":"Retrieve a product rate plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproductrateplanbykey","routeSlug":"/v1-api-reference/api/object-queries/queryproductrateplanbykey","metadata":{"seo":{"title":"Retrieve a product rate plan","description":"Retrieve the details of a specific Product Rate Plan object."}},"httpPath":"/object-query/product-rate-plans/{key}"},{"label":"List product rate plan charges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproductrateplancharges","routeSlug":"/v1-api-reference/api/object-queries/queryproductrateplancharges","metadata":{"seo":{"title":"List product rate plan charges","description":"Lists Product Rate Plan Charge objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/product-rate-plan-charges"},{"label":"Retrieve a product rate plan charge","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproductrateplanchargebykey","routeSlug":"/v1-api-reference/api/object-queries/queryproductrateplanchargebykey","metadata":{"seo":{"title":"Retrieve a product rate plan charge","description":"Retrieve the details of a specific Product Rate Plan Charge object."}},"httpPath":"/object-query/product-rate-plan-charges/{key}"},{"label":"List product rate plan charge tiers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproductrateplanchargetiers","routeSlug":"/v1-api-reference/api/object-queries/queryproductrateplanchargetiers","metadata":{"seo":{"title":"List product rate plan charge tiers","description":"Lists Product Rate Plan Charge Tier objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/product-rate-plan-charge-tiers"},{"label":"Retrieve a product rate plan charge tier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproductrateplanchargetierbykey","routeSlug":"/v1-api-reference/api/object-queries/queryproductrateplanchargetierbykey","metadata":{"seo":{"title":"Retrieve a product rate plan charge tier","description":"Retrieve the details of a specific Product Rate Plan Charge Tier object."}},"httpPath":"/object-query/product-rate-plan-charge-tiers/{key}"},{"label":"List ramps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryramps","routeSlug":"/v1-api-reference/api/object-queries/queryramps","metadata":{"seo":{"title":"List ramps","description":"Lists Ramp objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/ramps"},{"label":"Retrieve a ramp","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrampbykey","routeSlug":"/v1-api-reference/api/object-queries/queryrampbykey","metadata":{"seo":{"title":"Retrieve a ramp","description":"Retrieve a Ramp object. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/ramps/{key}"},{"label":"List rate plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrateplans","routeSlug":"/v1-api-reference/api/object-queries/queryrateplans","metadata":{"seo":{"title":"List rate plans","description":"Lists Rate Plan objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/rate-plans"},{"label":"Retrieve a rate plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrateplanbykey","routeSlug":"/v1-api-reference/api/object-queries/queryrateplanbykey","metadata":{"seo":{"title":"Retrieve a rate plan","description":"Retrieve the details of a specific Rate Plan object."}},"httpPath":"/object-query/rate-plans/{key}"},{"label":"List rate plan charges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrateplancharges","routeSlug":"/v1-api-reference/api/object-queries/queryrateplancharges","metadata":{"seo":{"title":"List rate plan charges","description":"Lists Rate Plan Charge objects. You can use the query parameters to filter, expand, and sort the returned results.Note: You must specify a filter[] query parameter to query rate plan charges."}},"httpPath":"/object-query/rate-plan-charges"},{"label":"Retrieve a rate plan charge","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrateplanchargebykey","routeSlug":"/v1-api-reference/api/object-queries/queryrateplanchargebykey","metadata":{"seo":{"title":"Retrieve a rate plan charge","description":"Retrieve the details of a specific Rate Plan Charge object."}},"httpPath":"/object-query/rate-plan-charges/{key}"},{"label":"List rate plan charge tiers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrateplanchargetiers","routeSlug":"/v1-api-reference/api/object-queries/queryrateplanchargetiers","metadata":{"seo":{"title":"List rate plan charge tiers","description":"Lists Rate Plan Charge Tier objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/rate-plan-charge-tiers"},{"label":"Retrieve a rate plan charge tier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrateplanchargetierbykey","routeSlug":"/v1-api-reference/api/object-queries/queryrateplanchargetierbykey","metadata":{"seo":{"title":"Retrieve a rate plan charge tier","description":"Retrieve the details of a specific Rate Plan Charge Tier object."}},"httpPath":"/object-query/rate-plan-charge-tiers/{key}"},{"label":"List rating results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryratingresults","routeSlug":"/v1-api-reference/api/object-queries/queryratingresults","metadata":{"seo":{"title":"List rating results","description":"Lists Rating Result objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/rating-results"},{"label":"Retrieve a rating result","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryratingresultbykey","routeSlug":"/v1-api-reference/api/object-queries/queryratingresultbykey","metadata":{"seo":{"title":"Retrieve a rating result","description":"Retrieve the details of a specific Rating Result object."}},"httpPath":"/object-query/rating-results/{key}"},{"label":"List refunds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrefunds","routeSlug":"/v1-api-reference/api/object-queries/queryrefunds","metadata":{"seo":{"title":"List refunds","description":"Lists Refund objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/refunds"},{"label":"Retrieve a refund","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrefundbykey","routeSlug":"/v1-api-reference/api/object-queries/queryrefundbykey","metadata":{"seo":{"title":"Retrieve a refund","description":"Retrieve the details of a specific Refund object."}},"httpPath":"/object-query/refunds/{key}"},{"label":"List refund applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrefundapplications","routeSlug":"/v1-api-reference/api/object-queries/queryrefundapplications","metadata":{"seo":{"title":"List refund applications","description":"Lists Refund Application objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/refund-applications"},{"label":"Retrieve a refund application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrefundapplicationbykey","routeSlug":"/v1-api-reference/api/object-queries/queryrefundapplicationbykey","metadata":{"seo":{"title":"Retrieve a refund application","description":"Retrieve the details of a specific Refund Application object."}},"httpPath":"/object-query/refund-applications/{key}"},{"label":"List refund application items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrefundapplicationitems","routeSlug":"/v1-api-reference/api/object-queries/queryrefundapplicationitems","metadata":{"seo":{"title":"List refund application items","description":"Lists Refund Application Item objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/refund-application-items"},{"label":"Retrieve a refund application item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrefundapplicationitembykey","routeSlug":"/v1-api-reference/api/object-queries/queryrefundapplicationitembykey","metadata":{"seo":{"title":"Retrieve a refund application item","description":"Retrieve the details of a specific Refund Application Item object."}},"httpPath":"/object-query/refund-application-items/{key}"},{"label":"List summary statement runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/getsummarystatementruns","routeSlug":"/v1-api-reference/api/object-queries/getsummarystatementruns","metadata":{"seo":{"title":"List summary statement runs","description":"Lists statement runs. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/summarystatementruns"},{"label":"Retrieve a summary statement run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/getsummarystatementrun","routeSlug":"/v1-api-reference/api/object-queries/getsummarystatementrun","metadata":{"seo":{"title":"Retrieve a summary statement run","description":"Retrieves a statement run by using the statement run ID or number."}},"httpPath":"/object-query/summarystatementruns/{key}"},{"label":"List summary statements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/getsummarystatements","routeSlug":"/v1-api-reference/api/object-queries/getsummarystatements","metadata":{"seo":{"title":"List summary statements","description":"Lists summary statements."}},"httpPath":"/object-query/summarystatements"},{"label":"Retrieve a summary statement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/getsummarystatement","routeSlug":"/v1-api-reference/api/object-queries/getsummarystatement","metadata":{"seo":{"title":"Retrieve a summary statement","description":"Retrieves a statement based on the specified summary statement key."}},"httpPath":"/object-query/summarystatements/{key}"},{"label":"List subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querysubscriptions","routeSlug":"/v1-api-reference/api/object-queries/querysubscriptions","metadata":{"seo":{"title":"List subscriptions","description":"Lists Subscription objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/subscriptions"},{"label":"Retrieve a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querysubscriptionbykey","routeSlug":"/v1-api-reference/api/object-queries/querysubscriptionbykey","metadata":{"seo":{"title":"Retrieve a subscription","description":"Retrieve the details of a specific Subscription object."}},"httpPath":"/object-query/subscriptions/{key}"},{"label":"List taxation items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querytaxationitems","routeSlug":"/v1-api-reference/api/object-queries/querytaxationitems","metadata":{"seo":{"title":"List taxation items","description":"Lists Taxation Item objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/taxation-items"},{"label":"Retrieve a taxation item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querytaxationitembykey","routeSlug":"/v1-api-reference/api/object-queries/querytaxationitembykey","metadata":{"seo":{"title":"Retrieve a taxation item","description":"Retrieve the details of a specific Taxation Item object."}},"httpPath":"/object-query/taxation-items/{key}"},{"label":"List usage records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryusages","routeSlug":"/v1-api-reference/api/object-queries/queryusages","metadata":{"seo":{"title":"List usage records","description":"Lists Usage Record objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/usages"},{"label":"Retrieve a usage record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryusagebykey","routeSlug":"/v1-api-reference/api/object-queries/queryusagebykey","metadata":{"seo":{"title":"Retrieve a usage record","description":"Retrieve the details of a specific Usage Record object."}},"httpPath":"/object-query/usages/{key}"},{"label":"List validity period summaries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryvalidityperiodsummarys","routeSlug":"/v1-api-reference/api/object-queries/queryvalidityperiodsummarys","metadata":{"seo":{"title":"List validity period summaries","description":"Lists Validity Period Summary objects. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/validity-period-summaries"},{"label":"Retrieve a validity period summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryvalidityperiodsummarybykey","routeSlug":"/v1-api-reference/api/object-queries/queryvalidityperiodsummarybykey","metadata":{"seo":{"title":"Retrieve a validity period summary","description":"Retrieve the details of a specific Validity Period Summary object."}},"httpPath":"/object-query/validity-period-summaries/{key}"},{"label":"List custom object records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycustomobjects","routeSlug":"/v1-api-reference/api/object-queries/querycustomobjects","metadata":{"seo":{"title":"List custom object records","description":"Lists custom object records. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/{custom-object-name}"},{"label":"Retrieve a custom object record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycustomobjectbykey","routeSlug":"/v1-api-reference/api/object-queries/querycustomobjectbykey","metadata":{"seo":{"title":"Retrieve a custom object record","description":"Retrieve the details of a specific custom object record."}},"httpPath":"/object-query/{custom-object-name}/{key}"},{"label":"List contact snapshots","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycontactsnapshots","routeSlug":"/v1-api-reference/api/object-queries/querycontactsnapshots","metadata":{"seo":{"title":"List contact snapshots","description":"Lists contact snapshots. You can use the query parameters to filter, expand, and sort the returned results."}},"httpPath":"/object-query/contact-snapshots"},{"label":"Retrieve a contact snapshot","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycontactsnapshotbykey","routeSlug":"/v1-api-reference/api/object-queries/querycontactsnapshotbykey","metadata":{"seo":{"title":"Retrieve a contact snapshot","description":"Retrieves detailed information about a specific contact snapshot by its unique ID."}},"httpPath":"/object-query/contact-snapshots/{key}"},{"label":"List rating details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryratingdetails","routeSlug":"/v1-api-reference/api/object-queries/queryratingdetails","metadata":{"seo":{"title":"List rating details","description":"Lists rating details. Use query parameters to paginate and filter results."}},"httpPath":"/object-query/rating-details"},{"label":"Retrieve a rating detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryratingdetailbykey","routeSlug":"/v1-api-reference/api/object-queries/queryratingdetailbykey","metadata":{"seo":{"title":"Retrieve a rating detail","description":"Retrieves a single rating detail by ID."}},"httpPath":"/object-query/rating-details/{key}"}]},{"type":"separator","label":"Finance"},{"type":"group","label":"Accounting Codes","link":"/v1-api-reference/api/accounting-codes","routeSlug":"/v1-api-reference/api/accounting-codes","items":[{"label":"List all accounting codes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-codes/get_allaccountingcodes","routeSlug":"/v1-api-reference/api/accounting-codes/get_allaccountingcodes","metadata":{"seo":{"title":"List all accounting codes","description":"This reference describes how to query all accounting codes in your chart of accounts through the REST API."}},"httpPath":"/v1/accounting-codes"},{"label":"Create an accounting code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-codes/post_accountingcode","routeSlug":"/v1-api-reference/api/accounting-codes/post_accountingcode","metadata":{"seo":{"title":"Create an accounting code","description":"This reference describes how to create a new accounting code through the REST API.The accounting code will be active as soon as it has been created."}},"httpPath":"/v1/accounting-codes"},{"label":"Delete an accounting code","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-codes/delete_accountingcode","routeSlug":"/v1-api-reference/api/accounting-codes/delete_accountingcode","metadata":{"seo":{"title":"Delete an accounting code","description":"This reference describes how to delete an accounting code through the REST API."}},"httpPath":"/v1/accounting-codes/{ac-id}"},{"label":"Retrieve an accounting code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-codes/get_accountingcode","routeSlug":"/v1-api-reference/api/accounting-codes/get_accountingcode","metadata":{"seo":{"title":"Retrieve an accounting code","description":"This reference describes how to query an accounting code through the REST API."}},"httpPath":"/v1/accounting-codes/{ac-id}"},{"label":"Update an accounting code","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-codes/put_accountingcode","routeSlug":"/v1-api-reference/api/accounting-codes/put_accountingcode","metadata":{"seo":{"title":"Update an accounting code","description":"This reference describes how to update an existing accounting code through the REST API."}},"httpPath":"/v1/accounting-codes/{ac-id}"},{"label":"Activate an accounting code","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-codes/put_activateaccountingcode","routeSlug":"/v1-api-reference/api/accounting-codes/put_activateaccountingcode","metadata":{"seo":{"title":"Activate an accounting code","description":"This reference describes how to activate an accounting code through the REST API."}},"httpPath":"/v1/accounting-codes/{ac-id}/activate"},{"label":"Deactivate an accounting code","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-codes/put_deactivateaccountingcode","routeSlug":"/v1-api-reference/api/accounting-codes/put_deactivateaccountingcode","metadata":{"seo":{"title":"Deactivate an accounting code","description":"This reference describes how to deactivate an accounting code through the REST API."}},"httpPath":"/v1/accounting-codes/{ac-id}/deactivate"}]},{"type":"group","label":"Accounting Periods","link":"/v1-api-reference/api/accounting-periods","routeSlug":"/v1-api-reference/api/accounting-periods","items":[{"label":"List all accounting periods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/get_allaccountingperiods","routeSlug":"/v1-api-reference/api/accounting-periods/get_allaccountingperiods","metadata":{"seo":{"title":"List all accounting periods","description":"Retrieves all accounting periods on your tenant."}},"httpPath":"/v1/accounting-periods"},{"label":"Create an accounting period","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/post_accountingperiod","routeSlug":"/v1-api-reference/api/accounting-periods/post_accountingperiod","metadata":{"seo":{"title":"Create an accounting period","description":"Creates an accounting period.Prerequisites"}},"httpPath":"/v1/accounting-periods"},{"label":"Delete an accounting period","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/delete_accountingperiod","routeSlug":"/v1-api-reference/api/accounting-periods/delete_accountingperiod","metadata":{"seo":{"title":"Delete an accounting period","description":"Deletes an accounting period."}},"httpPath":"/v1/accounting-periods/{ap-id}"},{"label":"Retrieve an accounting period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/get_accountingperiod","routeSlug":"/v1-api-reference/api/accounting-periods/get_accountingperiod","metadata":{"seo":{"title":"Retrieve an accounting period","description":"Retrieves an accounting period."}},"httpPath":"/v1/accounting-periods/{ap-id}"},{"label":"Update an accounting period","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/put_updateaccountingperiod","routeSlug":"/v1-api-reference/api/accounting-periods/put_updateaccountingperiod","metadata":{"seo":{"title":"Update an accounting period","description":"Updates an accounting period."}},"httpPath":"/v1/accounting-periods/{ap-id}"},{"label":"Close an accounting period","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/put_closeaccountingperiod","routeSlug":"/v1-api-reference/api/accounting-periods/put_closeaccountingperiod","metadata":{"seo":{"title":"Close an accounting period","description":"Close an accounting period by accounting period ID."}},"httpPath":"/v1/accounting-periods/{ap-id}/close"},{"label":"Set an accounting period to pending close","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/put_pendingcloseaccountingperiod","routeSlug":"/v1-api-reference/api/accounting-periods/put_pendingcloseaccountingperiod","metadata":{"seo":{"title":"Set an accounting period to pending close","description":"Sets an accounting period to pending close."}},"httpPath":"/v1/accounting-periods/{ap-id}/pending-close"},{"label":"Reopen an accounting period","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/put_reopenaccountingperiod","routeSlug":"/v1-api-reference/api/accounting-periods/put_reopenaccountingperiod","metadata":{"seo":{"title":"Reopen an accounting period","description":"Re-opens an accounting period.Prerequisites"}},"httpPath":"/v1/accounting-periods/{ap-id}/reopen"},{"label":"Run trial balance","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/put_runtrialbalance","routeSlug":"/v1-api-reference/api/accounting-periods/put_runtrialbalance","metadata":{"seo":{"title":"Run trial balance","description":"Runs the trial balance for an accounting period."}},"httpPath":"/v1/accounting-periods/{ap-id}/run-trial-balance"}]},{"type":"group","label":"Summary Journal Entries","link":"/v1-api-reference/api/summary-journal-entries","routeSlug":"/v1-api-reference/api/summary-journal-entries","items":[{"label":"Create a summary journal entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-journal-entries/post_summaryjournalentry","routeSlug":"/v1-api-reference/api/summary-journal-entries/post_summaryjournalentry","metadata":{"seo":{"title":"Create a summary journal entry","description":"This REST API reference describes how to manually create a summary journal entry. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/journal-entries"},{"label":"List all summary journal entries in a journal run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-journal-entries/get_allsummaryjournalentries","routeSlug":"/v1-api-reference/api/summary-journal-entries/get_allsummaryjournalentries","metadata":{"seo":{"title":"List all summary journal entries in a journal run","description":"This REST API reference describes how to retrieve information about all summary journal entries in a journal run."}},"httpPath":"/v1/journal-entries/journal-runs/{jr-number}"},{"label":"Delete a summary journal entry","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-journal-entries/delete_summaryjournalentry","routeSlug":"/v1-api-reference/api/summary-journal-entries/delete_summaryjournalentry","metadata":{"seo":{"title":"Delete a summary journal entry","description":"This reference describes how to delete a summary journal entry using the REST API."}},"httpPath":"/v1/journal-entries/{je-number}"},{"label":"Retrieve a summary journal entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-journal-entries/get_summaryjournalentry","routeSlug":"/v1-api-reference/api/summary-journal-entries/get_summaryjournalentry","metadata":{"seo":{"title":"Retrieve a summary journal entry","description":"This REST API reference describes how to get information about a summary journal entry by its journal entry number."}},"httpPath":"/v1/journal-entries/{je-number}"},{"label":"Update a summary journal entry","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-journal-entries/put_basicsummaryjournalentry","routeSlug":"/v1-api-reference/api/summary-journal-entries/put_basicsummaryjournalentry","metadata":{"seo":{"title":"Update a summary journal entry","description":"This REST API reference describes how to update the basic information of a summary journal entry. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/journal-entries/{je-number}/basic-information"},{"label":"Cancel a summary journal entry","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-journal-entries/put_summaryjournalentry","routeSlug":"/v1-api-reference/api/summary-journal-entries/put_summaryjournalentry","metadata":{"seo":{"title":"Cancel a summary journal entry","description":"This reference describes how to cancel a summary journal entry using the REST API."}},"httpPath":"/v1/journal-entries/{je-number}/cancel"}]},{"type":"group","label":"Journal Runs","link":"/v1-api-reference/api/journal-runs","routeSlug":"/v1-api-reference/api/journal-runs","items":[{"label":"Create a journal run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/journal-runs/post_journalrun","routeSlug":"/v1-api-reference/api/journal-runs/post_journalrun","metadata":{"seo":{"title":"Create a journal run","description":"This REST API reference describes how to create a journal run. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/journal-runs"},{"label":"Delete a journal run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/journal-runs/delete_journalrun","routeSlug":"/v1-api-reference/api/journal-runs/delete_journalrun","metadata":{"seo":{"title":"Delete a journal run","description":"This reference describes how to delete a journal run using the REST API."}},"httpPath":"/v1/journal-runs/{jr-number}"},{"label":"Retrieve a journal run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/journal-runs/get_journalrun","routeSlug":"/v1-api-reference/api/journal-runs/get_journalrun","metadata":{"seo":{"title":"Retrieve a journal run","description":"This REST API reference describes how to get information about a journal run. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/journal-runs/{jr-number}"},{"label":"Cancel a journal run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/journal-runs/put_journalrun","routeSlug":"/v1-api-reference/api/journal-runs/put_journalrun","metadata":{"seo":{"title":"Cancel a journal run","description":"This reference describes how to cancel a journal run using the REST API."}},"httpPath":"/v1/journal-runs/{jr-number}/cancel"}]},{"type":"group","label":"Mass Updater","link":"/v1-api-reference/api/mass-updater","routeSlug":"/v1-api-reference/api/mass-updater","items":[{"label":"Perform a mass action","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/mass-updater/post_massupdater","routeSlug":"/v1-api-reference/api/mass-updater/post_massupdater","metadata":{"seo":{"title":"Perform a mass action","description":"Describes how to perform a mass action through the REST API."}},"httpPath":"/v1/bulk"},{"label":"List all results of a mass action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/mass-updater/get_massupdater","routeSlug":"/v1-api-reference/api/mass-updater/get_massupdater","metadata":{"seo":{"title":"List all results of a mass action","description":"Describes how to get information about the result of a mass action through the REST API."}},"httpPath":"/v1/bulk/{bulk-key}"},{"label":"Stop a mass action","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/mass-updater/put_massupdater","routeSlug":"/v1-api-reference/api/mass-updater/put_massupdater","metadata":{"seo":{"title":"Stop a mass action","description":"Describes how to stop a mass action through the REST API. You can stop a mass action when its status is Pending or Processing. After you have stopped a mass action, you can get the mass action result to see details of the mass action."}},"httpPath":"/v1/bulk/{bulk-key}/stop"}]},{"type":"separator","label":"Events and Notifications"},{"type":"group","label":"Notifications","link":"/v1-api-reference/api/notifications","routeSlug":"/v1-api-reference/api/notifications","items":[{"label":"Create a notification definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/post_create_notification_definition","routeSlug":"/v1-api-reference/api/notifications/post_create_notification_definition","metadata":{"seo":{"title":"Create a notification definition","description":"Creates a notification definition. If a filter rule is specified, it will be evaluated to see if the notification definition is qualified to handle the incoming events during runtime. If the notification is qualified, it will send the email and invoke the callout if it has an email template or a callout."}},"httpPath":"/notifications/notification-definitions"},{"label":"List notification definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/get_query_notification_definitions","routeSlug":"/v1-api-reference/api/notifications/get_query_notification_definitions","metadata":{"seo":{"title":"List notification definitions","description":"Queries notification definitions with the specified filters."}},"httpPath":"/notifications/notification-definitions"},{"label":"Retrieve a notification definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/get_get_notification_definition","routeSlug":"/v1-api-reference/api/notifications/get_get_notification_definition","metadata":{"seo":{"title":"Retrieve a notification definition","description":"Queries the notification definition of the given ID."}},"httpPath":"/notifications/notification-definitions/{id}"},{"label":"Update a notification definition","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/put_update_notification_definition","routeSlug":"/v1-api-reference/api/notifications/put_update_notification_definition","metadata":{"seo":{"title":"Update a notification definition","description":"Updates a notification definition."}},"httpPath":"/notifications/notification-definitions/{id}"},{"label":"Delete a notification definition","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/delete_delete_notification_definition","routeSlug":"/v1-api-reference/api/notifications/delete_delete_notification_definition","metadata":{"seo":{"title":"Delete a notification definition","description":"Deletes a notification definition."}},"httpPath":"/notifications/notification-definitions/{id}"},{"label":"Create or update email templates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/post_createorupdateemailtemplates","routeSlug":"/v1-api-reference/api/notifications/post_createorupdateemailtemplates","metadata":{"seo":{"title":"Create or update email templates","description":"Creates email templates for standard or custom events if you do not specify email template IDs, or updates existing email templates if you specify valid email template IDs."}},"httpPath":"/notifications/email-templates/import"},{"label":"Create an email template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/post_create_email_template","routeSlug":"/v1-api-reference/api/notifications/post_create_email_template","metadata":{"seo":{"title":"Create an email template","description":"Creates an email template."}},"httpPath":"/notifications/email-templates"},{"label":"List email templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/get_query_email_templates","routeSlug":"/v1-api-reference/api/notifications/get_query_email_templates","metadata":{"seo":{"title":"List email templates","description":"Queries email templates. This operation supports querying email templates for all event types."}},"httpPath":"/notifications/email-templates"},{"label":"Retrieve an email template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/get_get_email_template","routeSlug":"/v1-api-reference/api/notifications/get_get_email_template","metadata":{"seo":{"title":"Retrieve an email template","description":"Queries the email template based on the specified ID. This operation supports retrieving the email template for all event types."}},"httpPath":"/notifications/email-templates/{id}"},{"label":"Update an email template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/put_update_email_template","routeSlug":"/v1-api-reference/api/notifications/put_update_email_template","metadata":{"seo":{"title":"Update an email template","description":"Updates an email template. This operation supports updating the email template for all event types."}},"httpPath":"/notifications/email-templates/{id}"},{"label":"Delete an email template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/delete_delete_email_template","routeSlug":"/v1-api-reference/api/notifications/delete_delete_email_template","metadata":{"seo":{"title":"Delete an email template","description":"Deletes an email template. This operation supports deleting an email template for all event types."}},"httpPath":"/notifications/email-templates/{id}"},{"label":"Create or update callout templates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/createorupdatecallouttemplates","routeSlug":"/v1-api-reference/api/notifications/createorupdatecallouttemplates","metadata":{"seo":{"title":"Create or update callout templates","description":"Creates callout templates for standard or custom events if you do not specify callout template IDs, or updates existing callout templates if you specify valid callout template IDs."}},"httpPath":"/notifications/callout-templates/import"},{"label":"Create a callout template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/createcallouttemplate","routeSlug":"/v1-api-reference/api/notifications/createcallouttemplate","metadata":{"seo":{"title":"Create a callout template","description":"Creates a callout template."}},"httpPath":"/notifications/callout-templates"},{"label":"List callout templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/getcallouttemplates","routeSlug":"/v1-api-reference/api/notifications/getcallouttemplates","metadata":{"seo":{"title":"List callout templates","description":"Queries callout templates. This operation supports querying callout templates for all event types."}},"httpPath":"/notifications/callout-templates"},{"label":"Retrieve a callout template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/getcallouttemplte","routeSlug":"/v1-api-reference/api/notifications/getcallouttemplte","metadata":{"seo":{"title":"Retrieve a callout template","description":"Queries the callout template based on the specified ID. This operation supports retrieving the callout template for all event types."}},"httpPath":"/notifications/callout-templates/{id}"},{"label":"Update a callout template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/updatecallouttemplate","routeSlug":"/v1-api-reference/api/notifications/updatecallouttemplate","metadata":{"seo":{"title":"Update a callout template","description":"Updates a callout template. This operation supports updating the callout template for all event types."}},"httpPath":"/notifications/callout-templates/{id}"},{"label":"Delete a callout template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/deletecallouttemplate","routeSlug":"/v1-api-reference/api/notifications/deletecallouttemplate","metadata":{"seo":{"title":"Delete a callout template","description":"Deletes a callout template. This operation supports deleting a callout template for all event types."}},"httpPath":"/notifications/callout-templates/{id}"},{"label":"Create or update reusable blocks","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/createorupdatereusableblocks","routeSlug":"/v1-api-reference/api/notifications/createorupdatereusableblocks","metadata":{"seo":{"title":"Create or update reusable blocks","description":"Creates reusable blocks if you do not specify block IDs, or updates existing reusable blocks if you specify valid block IDs. All fields must be provided for each reusable block you want to update."}},"httpPath":"/notifications/reusable-blocks/import"},{"label":"Create a reusable block","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/createreusableblock","routeSlug":"/v1-api-reference/api/notifications/createreusableblock","metadata":{"seo":{"title":"Create a reusable block","description":"Creates a reusable block for email templates, such as email headers or footers."}},"httpPath":"/notifications/reusable-blocks"},{"label":"List reusable blocks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/getreusableblocks","routeSlug":"/v1-api-reference/api/notifications/getreusableblocks","metadata":{"seo":{"title":"List reusable blocks","description":"Queries reusable blocks."}},"httpPath":"/notifications/reusable-blocks"},{"label":"Retrieve a reusable block","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/getreusableblock","routeSlug":"/v1-api-reference/api/notifications/getreusableblock","metadata":{"seo":{"title":"Retrieve a reusable block","description":"Queries the reusable block based on the specified ID or name."}},"httpPath":"/notifications/reusable-blocks/{blockKey}"},{"label":"Update a reusable block","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/updatereusableblock","routeSlug":"/v1-api-reference/api/notifications/updatereusableblock","metadata":{"seo":{"title":"Update a reusable block","description":"Updates a reusable block."}},"httpPath":"/notifications/reusable-blocks/{blockKey}"},{"label":"Delete a reusable block","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/deletereusableblock","routeSlug":"/v1-api-reference/api/notifications/deletereusableblock","metadata":{"seo":{"title":"Delete a reusable block","description":"Deletes a reusable block."}},"httpPath":"/notifications/reusable-blocks/{blockKey}"},{"label":"Delete notification histories for an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/delete_delete_notification_history_for_account","routeSlug":"/v1-api-reference/api/notifications/delete_delete_notification_history_for_account","metadata":{"seo":{"title":"Delete notification histories for an account","description":"Delete all notification histories for the given account. All email and callout notifications for this account will be deleted upon successful operation."}},"httpPath":"/notifications/history"},{"label":"Retrieve a notification history deletion task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/get_get_notification_history_deletion_task","routeSlug":"/v1-api-reference/api/notifications/get_get_notification_history_deletion_task","metadata":{"seo":{"title":"Retrieve a notification history deletion task","description":"Get the notification history deletion task by ID."}},"httpPath":"/notifications/history/tasks/{id}"},{"label":"Resend callout notifications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/post_resendcalloutnotifications","routeSlug":"/v1-api-reference/api/notifications/post_resendcalloutnotifications","metadata":{"seo":{"title":"Resend callout notifications","description":"Resends callout notifications if your customers did not receive previous callout notifications."}},"httpPath":"/notifications/callout-histories/resend"},{"label":"Resend email notifications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/post_resendemailnotifications","routeSlug":"/v1-api-reference/api/notifications/post_resendemailnotifications","metadata":{"seo":{"title":"Resend email notifications","description":"Resends email notifications if your customers did not receive previous email notifications."}},"httpPath":"/notifications/email-histories/resend"},{"label":"List callout notification histories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/get_callouthistory","routeSlug":"/v1-api-reference/api/notifications/get_callouthistory","metadata":{"seo":{"title":"List callout notification histories","description":"Describes how to get a notification history for callouts."}},"httpPath":"/v1/notification-history/callout"},{"label":"List email notification histories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/get_emailhistory","routeSlug":"/v1-api-reference/api/notifications/get_emailhistory","metadata":{"seo":{"title":"List email notification histories","description":"Describes how to get a notification history for notification emails."}},"httpPath":"/v1/notification-history/email"}]},{"type":"group","label":"Custom Event Triggers","link":"/v1-api-reference/api/custom-event-triggers","routeSlug":"/v1-api-reference/api/custom-event-triggers","items":[{"label":"Create an event trigger","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-event-triggers/post_eventtrigger","routeSlug":"/v1-api-reference/api/custom-event-triggers/post_eventtrigger","metadata":{"seo":{"title":"Create an event trigger","description":"When you create an event trigger, you must specify the base object and define the trigger condition."}},"httpPath":"/events/event-triggers"},{"label":"List event triggers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-event-triggers/get_eventtriggers","routeSlug":"/v1-api-reference/api/custom-event-triggers/get_eventtriggers","metadata":{"seo":{"title":"List event triggers","description":"List event triggers"}},"httpPath":"/events/event-triggers"},{"label":"Retrieve an event trigger","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-event-triggers/get_eventtrigger","routeSlug":"/v1-api-reference/api/custom-event-triggers/get_eventtrigger","metadata":{"seo":{"title":"Retrieve an event trigger","description":"Retrieve an event trigger"}},"httpPath":"/events/event-triggers/{id}"},{"label":"Update an event trigger","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-event-triggers/put_eventtrigger","routeSlug":"/v1-api-reference/api/custom-event-triggers/put_eventtrigger","metadata":{"seo":{"title":"Update an event trigger","description":"Update an event trigger"}},"httpPath":"/events/event-triggers/{id}"},{"label":"Delete an event trigger","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-event-triggers/delete_eventtrigger","routeSlug":"/v1-api-reference/api/custom-event-triggers/delete_eventtrigger","metadata":{"seo":{"title":"Delete an event trigger","description":"Delete an event trigger"}},"httpPath":"/events/event-triggers/{id}"}]},{"type":"group","label":"Custom Scheduled Events","link":"/v1-api-reference/api/custom-scheduled-events","routeSlug":"/v1-api-reference/api/custom-scheduled-events","items":[{"label":"Create a scheduled event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-scheduled-events/post_scheduledevent","routeSlug":"/v1-api-reference/api/custom-scheduled-events/post_scheduledevent","metadata":{"seo":{"title":"Create a scheduled event","description":"To create a custom scheduled event, you must specify the base object, the base field and the scheduled time."}},"httpPath":"/events/scheduled-events"},{"label":"List all scheduled events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-scheduled-events/get_scheduledevents","routeSlug":"/v1-api-reference/api/custom-scheduled-events/get_scheduledevents","metadata":{"seo":{"title":"List all scheduled events","description":"List all scheduled events"}},"httpPath":"/events/scheduled-events"},{"label":"Retrieve a scheduled event by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-scheduled-events/get_scheduledeventbyid","routeSlug":"/v1-api-reference/api/custom-scheduled-events/get_scheduledeventbyid","metadata":{"seo":{"title":"Retrieve a scheduled event by ID","description":"Retrieve a scheduled event by ID"}},"httpPath":"/events/scheduled-events/{id}"},{"label":"Update a scheduled event by ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-scheduled-events/update_scheduledeventbyid","routeSlug":"/v1-api-reference/api/custom-scheduled-events/update_scheduledeventbyid","metadata":{"seo":{"title":"Update a scheduled event by ID","description":"Update a scheduled event by ID"}},"httpPath":"/events/scheduled-events/{id}"},{"label":"Delete a scheduled event by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-scheduled-events/delete_scheduledeventbyid","routeSlug":"/v1-api-reference/api/custom-scheduled-events/delete_scheduledeventbyid","metadata":{"seo":{"title":"Delete a scheduled event by ID","description":"Delete a scheduled event by ID"}},"httpPath":"/events/scheduled-events/{id}"}]},{"type":"separator","label":"Custom Objects"},{"type":"group","label":"Custom Object Definitions","link":"/v1-api-reference/api/custom-object-definitions","routeSlug":"/v1-api-reference/api/custom-object-definitions","items":[{"type":"link","label":"Error handling","link":"/v1-api-reference/api/custom-object-definitions/error-handling","routeSlug":"/v1-api-reference/api/custom-object-definitions/error-handling"},{"label":"Create custom object definitions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-definitions/post_customobjectdefinitions","routeSlug":"/v1-api-reference/api/custom-object-definitions/post_customobjectdefinitions","metadata":{"seo":{"title":"Create custom object definitions","description":"You can post custom object definitions with the request body schema described below."}},"httpPath":"/objects/definitions/default"},{"label":"List custom object definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-definitions/get_allcustomobjectdefinitionsinnamespace","routeSlug":"/v1-api-reference/api/custom-object-definitions/get_allcustomobjectdefinitionsinnamespace","metadata":{"seo":{"title":"List custom object definitions","description":"Get all custom objects definitions for a given tenant. If you want to copy all the existing custom objects from an old tenant to a new tenant, you can call this operation in your old tenant and then use its response directly as the request of the Create custom object definitions call in the new tenant to import all the custom objects from the old tenant."}},"httpPath":"/objects/definitions/default"},{"label":"Update an object definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-definitions/updateobjectdefinition","routeSlug":"/v1-api-reference/api/custom-object-definitions/updateobjectdefinition","metadata":{"seo":{"title":"Update an object definition","description":"Updates custom object definitions or custom field definitions for standard and custom objects."}},"httpPath":"/objects/migrations"},{"label":"Retrieve a custom object definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-definitions/get_customobjectdefinitionbytype","routeSlug":"/v1-api-reference/api/custom-object-definitions/get_customobjectdefinitionbytype","metadata":{"seo":{"title":"Retrieve a custom object definition","description":"Retrieves the custom object definition by type for the given tenant."}},"httpPath":"/objects/definitions/default/{object}"},{"label":"Delete a custom object definition","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-definitions/delete_customobjectdefinitionbytype","routeSlug":"/v1-api-reference/api/custom-object-definitions/delete_customobjectdefinitionbytype","metadata":{"seo":{"title":"Delete a custom object definition","description":"Deletes the custom object definition for the provided type."}},"httpPath":"/objects/definitions/default/{object}"}]},{"type":"group","label":"Custom Object Records","link":"/v1-api-reference/api/custom-object-records","routeSlug":"/v1-api-reference/api/custom-object-records","items":[{"type":"link","label":"Error handling","link":"/v1-api-reference/api/custom-object-records/error-handling","routeSlug":"/v1-api-reference/api/custom-object-records/error-handling"},{"label":"Create custom object records","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-records/post_customobjectrecords","routeSlug":"/v1-api-reference/api/custom-object-records/post_customobjectrecords","metadata":{"seo":{"title":"Create custom object records","description":"Creates custom object records with the given type."}},"httpPath":"/objects/records/default/{object}"},{"label":"List records for a custom object","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-records/get_allrecordsforcustomobjecttype","routeSlug":"/v1-api-reference/api/custom-object-records/get_allrecordsforcustomobjecttype","metadata":{"seo":{"title":"List records for a custom object","description":"Lists all object records of the given type. You can also use the q query parameter to filter the output records."}},"httpPath":"/objects/records/default/{object}"},{"label":"Retrieve a custom object record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-records/get_customobjectrecordbyid","routeSlug":"/v1-api-reference/api/custom-object-records/get_customobjectrecordbyid","metadata":{"seo":{"title":"Retrieve a custom object record","description":"Retrieves a record of a given type by ID."}},"httpPath":"/objects/records/default/{object}/{id}"},{"label":"Update a custom object record","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-records/put_customobjectrecord","routeSlug":"/v1-api-reference/api/custom-object-records/put_customobjectrecord","metadata":{"seo":{"title":"Update a custom object record","description":"Updates a record of the given type and ID."}},"httpPath":"/objects/records/default/{object}/{id}"},{"label":"Partially update a custom object record","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-records/patch_partialupdatecustomobjectrecord","routeSlug":"/v1-api-reference/api/custom-object-records/patch_partialupdatecustomobjectrecord","metadata":{"seo":{"title":"Partially update a custom object record","description":"Updates one or many fields of a custom object record. Patch update uses JSON Merge Patch as specified in RFC 7386."}},"httpPath":"/objects/records/default/{object}/{id}"},{"label":"Delete a custom object record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-records/delete_customobjectrecordbyid","routeSlug":"/v1-api-reference/api/custom-object-records/delete_customobjectrecordbyid","metadata":{"seo":{"title":"Delete a custom object record","description":"Deletes a custom object record of the given type and ID."}},"httpPath":"/objects/records/default/{object}/{id}"},{"label":"Update or delete custom object records","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-records/post_customobjectrecordsbatchupdateordelete","routeSlug":"/v1-api-reference/api/custom-object-records/post_customobjectrecordsbatchupdateordelete","metadata":{"seo":{"title":"Update or delete custom object records","description":"Makes a batch update or delete of custom object records."}},"httpPath":"/objects/batch/default/{object}"}]},{"type":"group","label":"Custom Object Jobs","link":"/v1-api-reference/api/custom-object-jobs","routeSlug":"/v1-api-reference/api/custom-object-jobs","items":[{"type":"link","label":"Error handling","link":"/v1-api-reference/api/custom-object-jobs/error-handling","routeSlug":"/v1-api-reference/api/custom-object-jobs/error-handling"},{"label":"Submit a custom object bulk job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-jobs/post_customobjectbulkjob","routeSlug":"/v1-api-reference/api/custom-object-jobs/post_customobjectbulkjob","metadata":{"seo":{"title":"Submit a custom object bulk job","description":"Submits a bulk job request for a bulk operation on the specified custom object records. A succcessful call returns a newly created bulk job. The job ID can be used to poll the job status or upload the CSV file if it is a create or update job."}},"httpPath":"/objects/jobs"},{"label":"List all custom object bulk jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-jobs/get_allcustomobjectbulkjobs","routeSlug":"/v1-api-reference/api/custom-object-jobs/get_allcustomobjectbulkjobs","metadata":{"seo":{"title":"List all custom object bulk jobs","description":"Lists all custom object bulk jobs submitted by your tenant."}},"httpPath":"/objects/jobs"},{"label":"Retrieve a custom object bulk job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-jobs/get_customobjectbulkjob","routeSlug":"/v1-api-reference/api/custom-object-jobs/get_customobjectbulkjob","metadata":{"seo":{"title":"Retrieve a custom object bulk job","description":"Retrieves the custom object bulk job details by job ID."}},"httpPath":"/objects/jobs/{id}"},{"label":"Upload a file for a custom object bulk job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-jobs/post_uploadfileforcustomobjectbulkjob","routeSlug":"/v1-api-reference/api/custom-object-jobs/post_uploadfileforcustomobjectbulkjob","metadata":{"seo":{"title":"Upload a file for a custom object bulk job","description":"Uploads a .csv file for a custom object bulk job to create or update custom object records. The job must be in pending status. Only one file is allowed per job. Each file supports only one type of operation, with an id column required for update operations. The job will start once the upload is finished."}},"httpPath":"/objects/jobs/{id}/files"},{"label":"List all errors for a custom object bulk job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-jobs/get_customobjectbulkjoberrors","routeSlug":"/v1-api-reference/api/custom-object-jobs/get_customobjectbulkjoberrors","metadata":{"seo":{"title":"List all errors for a custom object bulk job","description":"Lists all errors for a custom object bulk job."}},"httpPath":"/objects/jobs/{id}/errors"},{"label":"Cancel a custom object bulk job","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-jobs/patch_customobjectbulkjob","routeSlug":"/v1-api-reference/api/custom-object-jobs/patch_customobjectbulkjob","metadata":{"seo":{"title":"Cancel a custom object bulk job","description":"Cancel a custom object bulk job. Note that you can cancel a custom object bulk job only if the job status is accepted or pending."}},"httpPath":"/objects/jobs/{id}/cancel"}]},{"type":"separator","label":"System Health"},{"type":"group","label":"API Health","link":"/v1-api-reference/api/api-health","routeSlug":"/v1-api-reference/api/api-health","items":[{"label":"List API volume summary records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/api-health/get_systemhealthapivolumesummary","routeSlug":"/v1-api-reference/api/api-health/get_systemhealthapivolumesummary","metadata":{"seo":{"title":"List API volume summary records","description":"Returns volume summary of API usage that generated by your Zuora tenant within a specified time range."}},"httpPath":"/system-health/api-requests/volume-summary"},{"label":"List API failure records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/api-health/getsystemhealthapifailurerecords","routeSlug":"/v1-api-reference/api/api-health/getsystemhealthapifailurerecords","metadata":{"seo":{"title":"List API failure records","description":"Returns failure records of API usage that are generated by your Zuora tenant within a specified time range."}},"httpPath":"/system-health/api-requests/failures"},{"label":"List API usage detail records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/api-health/getsystemhealthapiperformancerecords","routeSlug":"/v1-api-reference/api/api-health/getsystemhealthapiperformancerecords","metadata":{"seo":{"title":"List API usage detail records","description":"Returns records of API usage that are generated by your Zuora tenant within a specified time range."}},"httpPath":"/system-health/api-requests/details"}]},{"type":"group","label":"Bill Run Health","link":"/v1-api-reference/api/bill-run-health","routeSlug":"/v1-api-reference/api/bill-run-health","items":[{"label":"List billing document volume summary records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bill-run-health/get_systemhealthbillingdocvolumesummary","routeSlug":"/v1-api-reference/api/bill-run-health/get_systemhealthbillingdocvolumesummary","metadata":{"seo":{"title":"List billing document volume summary records","description":"Returns a summary of billing documents generated within a specified time range, including invoices and credit memos, and the total number of accounts that failed to process."}},"httpPath":"/system-health/billing-documents/volume-summary"}]},{"type":"group","label":"Electronic Payments Health","link":"/v1-api-reference/api/electronic-payments-health","routeSlug":"/v1-api-reference/api/electronic-payments-health","items":[{"label":"List payment volume summary records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/electronic-payments-health/get_systemhealthpaymentvolumesummary","routeSlug":"/v1-api-reference/api/electronic-payments-health/get_systemhealthpaymentvolumesummary","metadata":{"seo":{"title":"List payment volume summary records","description":"Returns a summary of electronic payments handled by your Zuora tenant within a specified time range."}},"httpPath":"/system-health/payments/volume-summary"},{"label":"List payment system health records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/electronic-payments-health/getsystemhealthpaymentrecords","routeSlug":"/v1-api-reference/api/electronic-payments-health/getsystemhealthpaymentrecords","metadata":{"seo":{"title":"List payment system health records","description":"Returns System Health Electronic Payments records that are generated by your Zuora tenant within a specified time range."}},"httpPath":"/system-health/payments/details"}]},{"type":"group","label":"Tax Health","link":"/v1-api-reference/api/tax-health","routeSlug":"/v1-api-reference/api/tax-health","items":[{"label":"List tax system health records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/tax-health/getsystemhealthtaxrecords","routeSlug":"/v1-api-reference/api/tax-health/getsystemhealthtaxrecords","metadata":{"seo":{"title":"List tax system health records","description":"Returns System Health Electronic records that are generated by your Zuora tenant within a specified time range."}},"httpPath":"/system-health/tax/details"}]},{"type":"separator","label":"Workflow"},{"type":"group","label":"Workflows","link":"/v1-api-reference/api/workflows","routeSlug":"/v1-api-reference/api/workflows","items":[{"label":"Create an authentication provider for workflows","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/createauthproviderworkflows","routeSlug":"/v1-api-reference/api/workflows/createauthproviderworkflows","metadata":{"seo":{"title":"Create an authentication provider for workflows","description":"Creates an authentication provider for reuse in Workflow tasks and supported integrations."}},"httpPath":"/auth_providers"},{"label":"Update an authentication provider for workflows","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/updateauthproviderworkflows","routeSlug":"/v1-api-reference/api/workflows/updateauthproviderworkflows","metadata":{"seo":{"title":"Update an authentication provider for workflows","description":"Updates an authentication provider that is used for Workflow tasks and supported integrations. Only supplied fields are changed. The auth_type field cannot be changed after creation."}},"httpPath":"/auth_providers/{provider_id}"},{"label":"Delete an authentication provider for workflows","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/deleteauthproviderworkflows","routeSlug":"/v1-api-reference/api/workflows/deleteauthproviderworkflows","metadata":{"seo":{"title":"Delete an authentication provider for workflows","description":"Deletes an authentication provider that is used for Workflow tasks and supported integrations."}},"httpPath":"/auth_providers/{provider_id}"},{"label":"Delete a workflow version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/delete_workflowversion","routeSlug":"/v1-api-reference/api/workflows/delete_workflowversion","metadata":{"seo":{"title":"Delete a workflow version","description":"Delete a workflow version based on the version id."}},"httpPath":"/workflows/versions/{version_id}"},{"label":"List workflows","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflows","routeSlug":"/v1-api-reference/api/workflows/get_workflows","metadata":{"seo":{"title":"List workflows","description":"Retrieves a list of workflow definitions available in your Zuora tenant."}},"httpPath":"/workflows"},{"label":"Import a workflow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/post_workflowimport","routeSlug":"/v1-api-reference/api/workflows/post_workflowimport","metadata":{"seo":{"title":"Import a workflow","description":"Create a new workflow definition and its first version using the exported JSON document of an existing workflow version."}},"httpPath":"/workflows/import"},{"label":"Retrieve workflow task usage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflowsusages","routeSlug":"/v1-api-reference/api/workflows/get_workflowsusages","metadata":{"seo":{"title":"Retrieve workflow task usage","description":"Gets workflow task usage sorted by day within a specified time frame."}},"httpPath":"/workflows/metrics.json"},{"label":"List workflow tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflowstasks","routeSlug":"/v1-api-reference/api/workflows/get_workflowstasks","metadata":{"seo":{"title":"List workflow tasks","description":"Retrieves a list of workflow tasks available in your Zuora tenant."}},"httpPath":"/workflows/tasks"},{"label":"Update workflow tasks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/put_workflowstasksupdate","routeSlug":"/v1-api-reference/api/workflows/put_workflowstasksupdate","metadata":{"seo":{"title":"Update workflow tasks","description":"Updates a group of workflow tasks."}},"httpPath":"/workflows/tasks/batch_update"},{"label":"Retrieve a workflow task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflowstask","routeSlug":"/v1-api-reference/api/workflows/get_workflowstask","metadata":{"seo":{"title":"Retrieve a workflow task","description":"Retrieves a specific workflow task by its ID."}},"httpPath":"/workflows/tasks/{task_id}"},{"label":"Rerun a workflow task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/post_workflowstaskrerun","routeSlug":"/v1-api-reference/api/workflows/post_workflowstaskrerun","metadata":{"seo":{"title":"Rerun a workflow task","description":"Reruns a specific workflow task by its ID."}},"httpPath":"/workflows/tasks/{task_id}/rerun"},{"label":"Retrieve a workflow run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflow_run","routeSlug":"/v1-api-reference/api/workflows/get_workflow_run","metadata":{"seo":{"title":"Retrieve a workflow run","description":"Retrieves information about a specific workflow run by its ID."}},"httpPath":"/workflows/workflow_runs/{workflow_run_id}"},{"label":"Delete a workflow","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/delete_workflow","routeSlug":"/v1-api-reference/api/workflows/delete_workflow","metadata":{"seo":{"title":"Delete a workflow","description":"Deletes a specific workflow by its ID."}},"httpPath":"/workflows/{workflow_id}"},{"label":"Retrieve a workflow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflow","routeSlug":"/v1-api-reference/api/workflows/get_workflow","metadata":{"seo":{"title":"Retrieve a workflow","description":"Retrieves information about a specific workflow by its ID."}},"httpPath":"/workflows/{workflow_id}"},{"label":"Update a workflow","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/patch_updateworkflow","routeSlug":"/v1-api-reference/api/workflows/patch_updateworkflow","metadata":{"seo":{"title":"Update a workflow","description":"Updates a specific workflow by its ID, which allows you to configure the settings of a workflow via API."}},"httpPath":"/workflows/{workflow_id}"},{"label":"Export a workflow version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflowexport","routeSlug":"/v1-api-reference/api/workflows/get_workflowexport","metadata":{"seo":{"title":"Export a workflow version","description":"Exports a workflow version into a JSON file. This file can be used to create a copy of this workflow version."}},"httpPath":"/workflows/{workflow_id}/export"},{"label":"Run a workflow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/post_run_workflow","routeSlug":"/v1-api-reference/api/workflows/post_run_workflow","metadata":{"seo":{"title":"Run a workflow","description":"Run a specified workflow. In the request body, you can include parameters that you want to pass to the workflow. For the parameters to be recognized and picked up by tasks in the workflow, you need to define the parameters first."}},"httpPath":"/workflows/{workflow_id}/run"},{"label":"List all versions of a workflow definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflowversions","routeSlug":"/v1-api-reference/api/workflows/get_workflowversions","metadata":{"seo":{"title":"List all versions of a workflow definition","description":"Return a list of all workflow versions under a workflow definition"}},"httpPath":"/workflows/{workflow_id}/versions"},{"label":"Import a workflow version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/post_workflowversionsimport","routeSlug":"/v1-api-reference/api/workflows/post_workflowversionsimport","metadata":{"seo":{"title":"Import a workflow version","description":"Create a new workflow version under a workflow definition using the exported JSON document of an existing workflow version."}},"httpPath":"/workflows/{workflow_id}/versions/import"},{"label":"Stop a workflow run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/put_stopworkflowrun","routeSlug":"/v1-api-reference/api/workflows/put_stopworkflowrun","metadata":{"seo":{"title":"Stop a workflow run","description":"Stop a specific workflow run by its ID."}},"httpPath":"/workflows/workflow_runs/{workflow_run_id}/stop"}]},{"type":"separator","label":"Data Query"},{"type":"group","label":"Data Queries","link":"/v1-api-reference/api/data-queries","routeSlug":"/v1-api-reference/api/data-queries","items":[{"label":"List data query jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-queries/get_dataqueryjobs","routeSlug":"/v1-api-reference/api/data-queries/get_dataqueryjobs","metadata":{"seo":{"title":"List data query jobs","description":"Returns a list of data query jobs that have been created in your Zuora tenant. You can filter the list by status."}},"httpPath":"/query/jobs"},{"label":"Submit a data query","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-queries/post_dataqueryjob","routeSlug":"/v1-api-reference/api/data-queries/post_dataqueryjob","metadata":{"seo":{"title":"Submit a data query","description":"Submits a data query to be executed by Zuora, creating a new query job. Use the Retrieve a data query job endpoint to monitor the job status and access the results once complete."}},"httpPath":"/query/jobs"},{"label":"Cancel a data query job","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-queries/delete_dataqueryjob","routeSlug":"/v1-api-reference/api/data-queries/delete_dataqueryjob","metadata":{"seo":{"title":"Cancel a data query job","description":"Cancels a data query job, which prevents Zuora from performing the query. This operation is only applicable if the status of the query job is accepted or in_progress."}},"httpPath":"/query/jobs/{job-id}"},{"label":"Retrieve a data query job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-queries/get_dataqueryjob","routeSlug":"/v1-api-reference/api/data-queries/get_dataqueryjob","metadata":{"seo":{"title":"Retrieve a data query job","description":"Retrieves a data query job. You can use this operation to track the status of the query job and obtain the URL of the query results."}},"httpPath":"/query/jobs/{job-id}"}]},{"type":"separator","label":"AQuA"},{"type":"group","label":"Aggregate Queries","link":"/v1-api-reference/api/aggregate-queries","routeSlug":"/v1-api-reference/api/aggregate-queries","items":[{"label":"Submit an aggregate query job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/aggregate-queries/post_batchqueryjob","routeSlug":"/v1-api-reference/api/aggregate-queries/post_batchqueryjob","metadata":{"seo":{"title":"Submit an aggregate query job","description":"Submits an AQuA job that contains an aggregated list of ZOQL and Export ZOQL queries."}},"httpPath":"/v1/batch-query"},{"label":"Retrieve the last completed aggregate query job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/aggregate-queries/get_lastbatchqueryjob","routeSlug":"/v1-api-reference/api/aggregate-queries/get_lastbatchqueryjob","metadata":{"seo":{"title":"Retrieve the last completed aggregate query job","description":"Returns the details of the last completed job."}},"httpPath":"/v1/batch-query/jobs/partner/{partner}/project/{project}"},{"label":"Cancel a running aggregate query job","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/aggregate-queries/delete_batchqueryjob","routeSlug":"/v1-api-reference/api/aggregate-queries/delete_batchqueryjob","metadata":{"seo":{"title":"Cancel a running aggregate query job","description":"Cancels the current AQuA job, only if the job is not complete. If the job is complete, an error is thrown."}},"httpPath":"/v1/batch-query/jobs/{jobid}"},{"label":"Retrieve an aggregate query job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/aggregate-queries/get_batchqueryjob","routeSlug":"/v1-api-reference/api/aggregate-queries/get_batchqueryjob","metadata":{"seo":{"title":"Retrieve an aggregate query job","description":"Retrieves an aggregate query using the Job ID."}},"httpPath":"/v1/batch-query/jobs/{jobid}"}]},{"type":"separator","label":"Deployment Manager"},{"type":"group","label":"Configuration Templates","link":"/v1-api-reference/api/configuration-templates","routeSlug":"/v1-api-reference/api/configuration-templates","items":[{"label":"Download a template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/get_downloaddeploymenttemplate","routeSlug":"/v1-api-reference/api/configuration-templates/get_downloaddeploymenttemplate","metadata":{"seo":{"title":"Download a template","description":"Download a template for migration in the Deployment manager from the source tenant to the target tenant."}},"httpPath":"/deployment-manager/deployment_artifacts"},{"label":"Compare settings between a source tenant and a target tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/post_comparetemplate","routeSlug":"/v1-api-reference/api/configuration-templates/post_comparetemplate","metadata":{"seo":{"title":"Compare settings between a source tenant and a target tenant","description":"To Compare the configurations from the template downloaded and used in deployment manager for migration which is available in source and target tenant."}},"httpPath":"/deployment-manager/deployment_artifacts/compare"},{"label":"Migrate settings from source tenant to target tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/post_migratetenantsettings","routeSlug":"/v1-api-reference/api/configuration-templates/post_migratetenantsettings","metadata":{"seo":{"title":"Migrate settings from source tenant to target tenant","description":"To migrate the selected configuration of a tenant in Deployment Manager migration while using template from the compare screen."}},"httpPath":"/deployment-manager/deployment_artifacts/deploy"},{"label":"List all details of source components","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/get_sourcecomponentdetails","routeSlug":"/v1-api-reference/api/configuration-templates/get_sourcecomponentdetails","metadata":{"seo":{"title":"List all details of source components","description":"When the advanced option is clicked, get the details/metadata of the components, such as settings, notifications, workflow, etc."}},"httpPath":"/deployment-manager/deployment_artifacts/retrieve-settings"},{"label":"List all templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/get_templates","routeSlug":"/v1-api-reference/api/configuration-templates/get_templates","metadata":{"seo":{"title":"List all templates","description":"Retrieves all the templates and their details which are created already."}},"httpPath":"/deployment-manager/deployment_templates"},{"label":"Create a deployment template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/post_deploymenttemplate","routeSlug":"/v1-api-reference/api/configuration-templates/post_deploymenttemplate","metadata":{"seo":{"title":"Create a deployment template","description":"Creates templates based on user preference.There are 2 ways to select components."}},"httpPath":"/deployment-manager/deployment_templates"},{"label":"Delete a template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/delete_deploymenttemplate","routeSlug":"/v1-api-reference/api/configuration-templates/delete_deploymenttemplate","metadata":{"seo":{"title":"Delete a template","description":"Deletes a specific template by passing the ID."}},"httpPath":"/deployment-manager/deployment_templates/{id}"},{"label":"List all details of a template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/get_deploymenttemplatedetail","routeSlug":"/v1-api-reference/api/configuration-templates/get_deploymenttemplatedetail","metadata":{"seo":{"title":"List all details of a template","description":"Returns the detailed information of a specific template by passing its template ID."}},"httpPath":"/deployment-manager/deployment_templates/{id}"},{"label":"Sync a deployment template with latest changes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/syncdeploymenttemplate","routeSlug":"/v1-api-reference/api/configuration-templates/syncdeploymenttemplate","metadata":{"seo":{"title":"Sync a deployment template with latest changes","description":"Synchronizes an existing deployment template with the latest changes in the source tenant."}},"httpPath":"/deployment-manager/deployment_templates/sync"}]},{"type":"group","label":"Metadata Deployment","link":"/v1-api-reference/api/metadata-deployment","routeSlug":"/v1-api-reference/api/metadata-deployment","items":[{"label":"Compare and deploy a source tenant to a target tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata-deployment/comparedeploytenant","routeSlug":"/v1-api-reference/api/metadata-deployment/comparedeploytenant","metadata":{"seo":{"title":"Compare and deploy a source tenant to a target tenant","description":"Compare and deploy a source tenant to a target tenant."}},"httpPath":"/deployment-manager/deployments/tenants"},{"label":"Compare and deploy a template to a tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata-deployment/comparedeploytemplate","routeSlug":"/v1-api-reference/api/metadata-deployment/comparedeploytemplate","metadata":{"seo":{"title":"Compare and deploy a template to a tenant","description":"Compare and deploy a template to a tenant."}},"httpPath":"/deployment-manager/deployments/templates"},{"label":"Revert a deployment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata-deployment/revertdeployment","routeSlug":"/v1-api-reference/api/metadata-deployment/revertdeployment","metadata":{"seo":{"title":"Revert a deployment","description":"Revert a deployment."}},"httpPath":"/deployment-manager/deployments/{migrationId}/revert"},{"label":"Retrieve a deployment log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata-deployment/fetchdeploymentlogs","routeSlug":"/v1-api-reference/api/metadata-deployment/fetchdeploymentlogs","metadata":{"seo":{"title":"Retrieve a deployment log","description":"Retrieve a deployment log."}},"httpPath":"/deployment-manager/deployments/{migrationId}"},{"label":"Compare and deploy the product catalog of a tenant to a target tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata-deployment/comparedeploytenantproductcatalog","routeSlug":"/v1-api-reference/api/metadata-deployment/comparedeploytenantproductcatalog","metadata":{"seo":{"title":"Compare and deploy the product catalog of a tenant to a target tenant","description":"Compare and deploy the product catalog of a tenant to a target tenant."}},"httpPath":"/deployment-manager/deployments/tenant/product_catalog"},{"label":"Compare and deploy a template for product catalog to a tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata-deployment/comparedeploytemplateproductcatalog","routeSlug":"/v1-api-reference/api/metadata-deployment/comparedeploytemplateproductcatalog","metadata":{"seo":{"title":"Compare and deploy a template for product catalog to a tenant","description":"Compare and deploy a template for product catalog to a tenant."}},"httpPath":"/deployment-manager/deployments/template/product_catalog"}]},{"type":"separator","label":"Data Loader"},{"type":"group","label":"Bulk Data","link":"/v1-api-reference/api/bulk-data","routeSlug":"/v1-api-reference/api/bulk-data","items":[{"label":"Create a bulk job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/createbulkjob","routeSlug":"/v1-api-reference/api/bulk-data/createbulkjob","metadata":{"seo":{"title":"Create a bulk job","description":"Creates a new bulk job. The job type can be one of Import, Delete, Update, or Cancel.The response includes the job ID and information needed to upload your data file to S3."}},"httpPath":"/bulk-data/bulk-jobs"},{"label":"Submit a bulk job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/submitbulkjob","routeSlug":"/v1-api-reference/api/bulk-data/submitbulkjob","metadata":{"seo":{"title":"Submit a bulk job","description":"Submits a previously created bulk job for processing."}},"httpPath":"/bulk-data/bulk-jobs/{id}/submissions"},{"label":"Retrieve the summary of a bulk job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/getbulkjobsummary","routeSlug":"/v1-api-reference/api/bulk-data/getbulkjobsummary","metadata":{"seo":{"title":"Retrieve the summary of a bulk job","description":"Get the summary of a specific job by its ID. This operation returns a summary of the specified bulk job."}},"httpPath":"/bulk-data/bulk-jobs/{id}/summary"},{"label":"Cancel a bulk job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/cancelbulkjob","routeSlug":"/v1-api-reference/api/bulk-data/cancelbulkjob","metadata":{"seo":{"title":"Cancel a bulk job","description":"Cancels an existing bulk job."}},"httpPath":"/bulk-data/bulk-jobs/{id}/cancellations"},{"label":"Abort a bulk job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/deleteabortjob","routeSlug":"/v1-api-reference/api/bulk-data/deleteabortjob","metadata":{"seo":{"title":"Abort a bulk job","description":"Aborts an existing job by sending a POST request to this URI. The request URI identifies the job to abort. When a job is aborted, no more records are processed."}},"httpPath":"/bulk-data/bulk-jobs/{id}/aborts"},{"label":"List download links for a bulk job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/getdownloadlinksforjob","routeSlug":"/v1-api-reference/api/bulk-data/getdownloadlinksforjob","metadata":{"seo":{"title":"List download links for a bulk job","description":"Retrieves the download links for the files associated with a completed job. These files include success rows, error rows, and logs."}},"httpPath":"/bulk-data/bulk-jobs/{id}/downloads"},{"label":"List job summaries for bulk jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/getbulkjobsummaries","routeSlug":"/v1-api-reference/api/bulk-data/getbulkjobsummaries","metadata":{"seo":{"title":"List job summaries for bulk jobs","description":"Lists summaries for bulk jobs. You can filter the results using query parameters."}},"httpPath":"/bulk-data/bulk-jobs/summaries"},{"label":"List mappings for a bulk job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/getmappingsforjob","routeSlug":"/v1-api-reference/api/bulk-data/getmappingsforjob","metadata":{"seo":{"title":"List mappings for a bulk job","description":"Retrieves the mappings for an existing bulk job. The mappings define how columns in the source file correspond to fields in the object type template."}},"httpPath":"/bulk-data/bulk-jobs/{id}/mappings"}]},{"type":"separator","label":"OneID"},{"type":"group","label":"SCIM","link":"/v1-api-reference/api/scim","routeSlug":"/v1-api-reference/api/scim","items":[{"type":"link","label":"Prerequisites","link":"/v1-api-reference/api/scim/prerequisites","routeSlug":"/v1-api-reference/api/scim/prerequisites"},{"type":"link","label":"Steps to generate the bearer token","link":"/v1-api-reference/api/scim/steps-to-generate-the-bearer-token","routeSlug":"/v1-api-reference/api/scim/steps-to-generate-the-bearer-token"},{"label":"List groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/getlistgroups","routeSlug":"/v1-api-reference/api/scim/getlistgroups","metadata":{"seo":{"title":"List groups","description":"Returns a paginated list of groups, ten groups per page by default. Use the startIndex and count (max 100) query parameters to paginate long lists of groups. It's possible to return a list of specific types of groups using the filter parameter."}},"httpPath":"/scim/v2/Groups"},{"label":"Create a group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/createanewgroup","routeSlug":"/v1-api-reference/api/scim/createanewgroup","metadata":{"seo":{"title":"Create a group","description":"Creates a new group. Must include the displayName attribute. Users can be added to the group during creation by supplying the user ID values in the members array attribute."}},"httpPath":"/scim/v2/Groups"},{"label":"Bulk create groups","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/postbulkcreategroups","routeSlug":"/v1-api-reference/api/scim/postbulkcreategroups","metadata":{"seo":{"title":"Bulk create groups","description":"Creates multiple Groups within an organization."}},"httpPath":"/scim/v2/Groups/bulk"},{"label":"Bulk update groups","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/patchbulkpatchgroups","routeSlug":"/v1-api-reference/api/scim/patchbulkpatchgroups","metadata":{"seo":{"title":"Bulk update groups","description":"Updates an existing group resource, allowing individual (or groups of) users to be added or removed from the group with a single operation."}},"httpPath":"/scim/v2/Groups/bulk"},{"label":"Bulk delete groups","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/postbulkdeletegroups","routeSlug":"/v1-api-reference/api/scim/postbulkdeletegroups","metadata":{"seo":{"title":"Bulk delete groups","description":"Permanently removes groups from an organization (members are not deleted, only the group)."}},"httpPath":"/scim/v2/Groups/delete"},{"label":"Retrieve a group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/getaspecificgroup","routeSlug":"/v1-api-reference/api/scim/getaspecificgroup","metadata":{"seo":{"title":"Retrieve a group","description":"Retrieves a single group resource."}},"httpPath":"/scim/v2/Groups/{id}"},{"label":"Update a group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/updateaspecificgroup","routeSlug":"/v1-api-reference/api/scim/updateaspecificgroup","metadata":{"seo":{"title":"Update a group","description":"Updates an existing group resource, overwriting all values for a group even if an attribute is empty or not provided. PUT will replace all members of a group with those members provided via the members attribute. If an attribute that had been set previously is left blank during a PUT operation, the new value will be blank in accordance with the data type of the attribute and the storage provider."}},"httpPath":"/scim/v2/Groups/{id}"},{"label":"Delete a group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/deleteaspecificgroup","routeSlug":"/v1-api-reference/api/scim/deleteaspecificgroup","metadata":{"seo":{"title":"Delete a group","description":"Permanently removes a group (members are not deleted, only the group)."}},"httpPath":"/scim/v2/Groups/{id}"},{"label":"Partially update a group","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/partiallyupdateaspecificgroup","routeSlug":"/v1-api-reference/api/scim/partiallyupdateaspecificgroup","metadata":{"seo":{"title":"Partially update a group","description":"Updates an existing group resource, allowing individual (or groups of) users to be added or removed from the group with a single operation. Setting the operation attribute of a member object to delete will remove members from a group; add is the default operation for PATCH."}},"httpPath":"/scim/v2/Groups/{id}"},{"label":"List all resource types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/gettheressourcetype","routeSlug":"/v1-api-reference/api/scim/gettheressourcetype","metadata":{"seo":{"title":"List all resource types","description":"Retrieves all Resource Types managed by OneId. Resource Types define the resource name, endpoint URL, schemas, and other metadata that indicate where a resource is managed and how it is composed, e.g., \"User\" or \"Group\"."}},"httpPath":"/scim/v2/ResourceTypes"},{"label":"Retrieve a resource type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/getaspecificresourcetype","routeSlug":"/v1-api-reference/api/scim/getaspecificresourcetype","metadata":{"seo":{"title":"Retrieve a resource type","description":"Get related information on a single resource type."}},"httpPath":"/scim/v2/ResourceTypes/{id}"},{"label":"List all schemas of resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/getschemaofscim","routeSlug":"/v1-api-reference/api/scim/getschemaofscim","metadata":{"seo":{"title":"List all schemas of resources","description":"Lists all schemas for all supported resources. A schema is a collection of attribute definitions that describe the contents of an entire or partial resource, e.g., \"urn:ietf:params:scim:schemas:core:2.0:User\"."}},"httpPath":"/scim/v2/Schemas"},{"label":"List schemas of a resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/gettheschemaofspecificscim","routeSlug":"/v1-api-reference/api/scim/gettheschemaofspecificscim","metadata":{"seo":{"title":"List schemas of a resource","description":"Gets a specific resource schema by ID."}},"httpPath":"/scim/v2/Schemas/{id}"},{"label":"Retrieve the service provider configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/gettheserviceproviderconfig","routeSlug":"/v1-api-reference/api/scim/gettheserviceproviderconfig","metadata":{"seo":{"title":"Retrieve the service provider configuration","description":"Returns Zuora’s service provider configuration."}},"httpPath":"/scim/v2/ServiceProviderConfig"},{"label":"List users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/getlistofusers","routeSlug":"/v1-api-reference/api/scim/getlistofusers","metadata":{"seo":{"title":"List users","description":"Returns a paginated list of users, 100 users per page by default.When querying larger instances, reduce the count parameter to 1,000 or less, and use the startIndex parameter to paginate through users.It's possible to return a list of specific types of users with the filter parameter.Examples:"}},"httpPath":"/scim/v2/Users"},{"label":"Create a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/createauser","routeSlug":"/v1-api-reference/api/scim/createauser","metadata":{"seo":{"title":"Create a user","description":"Creates a user. Must include the userName attribute and an email address. User will be created as an SSO user by default and a federated ID must be provided for the user."}},"httpPath":"/scim/v2/Users"},{"label":"Bulk create users","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/bulkcreateusers","routeSlug":"/v1-api-reference/api/scim/bulkcreateusers","metadata":{"seo":{"title":"Bulk create users","description":"Creates multiple users within an organization."}},"httpPath":"/scim/v2/Users/bulk"},{"label":"Bulk update users","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/bulkupdateusers","routeSlug":"/v1-api-reference/api/scim/bulkupdateusers","metadata":{"seo":{"title":"Bulk update users","description":"Updates an existing multiple user resource, overwriting values for specified attributes."}},"httpPath":"/scim/v2/Users/bulk"},{"label":"Delete a list of users","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/deletealistofusers","routeSlug":"/v1-api-reference/api/scim/deletealistofusers","metadata":{"seo":{"title":"Delete a list of users","description":"Sets multiple users to deactivate.The value of the id should be the user's corresponding user ID."}},"httpPath":"/scim/v2/Users/delete"},{"label":"Retrieve a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/getaspecificuser","routeSlug":"/v1-api-reference/api/scim/getaspecificuser","metadata":{"seo":{"title":"Retrieve a user","description":"Retrieves a single user resource.The value of the  should be the user's corresponding user ID."}},"httpPath":"/scim/v2/Users/{id}"},{"label":"Update a user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/updateaspecificuser","routeSlug":"/v1-api-reference/api/scim/updateaspecificuser","metadata":{"seo":{"title":"Update a user","description":"Updates an existing user resource, overwriting all values for a user even if an attribute is empty or not provided.If an attribute that had been set previously is left blank during a PUT operation, the new value will be blank in accordance with the data type of the attribute and the storage provider.Deactivated users can be re-enabled by setting the active attribute to true. The value of the  should be the user's corresponding user ID."}},"httpPath":"/scim/v2/Users/{id}"},{"label":"Delete a user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/deleteaspecificuser","routeSlug":"/v1-api-reference/api/scim/deleteaspecificuser","metadata":{"seo":{"title":"Delete a user","description":"Deactivates a specific user identified by the user ID."}},"httpPath":"/scim/v2/Users/{id}"},{"label":"Partially update a user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/partialupdateaspecificuser","routeSlug":"/v1-api-reference/api/scim/partialupdateaspecificuser","metadata":{"seo":{"title":"Partially update a user","description":"Updates an existing user resource, overwriting values for specified attributes.The value of the {id} should be the user's corresponding user ID. Attributes that are not provided in the request will remain unchanged. Updating a value to \" \" will clear and remove the field from the user's profile."}},"httpPath":"/scim/v2/Users/{id}"}]},{"type":"group","label":"Audit Logs","link":"/v1-api-reference/api/audit-logs","routeSlug":"/v1-api-reference/api/audit-logs","items":[{"label":"Search global login events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-logs/searchgloballogins","routeSlug":"/v1-api-reference/api/audit-logs/searchgloballogins","metadata":{"seo":{"title":"Search global login events","description":"Searches for global login events with page-number based pagination. Returns totalPages and totalElements for direct page navigation. No filter is required for global login queries."}},"httpPath":"/admin/audit/v2/global-logins"},{"label":"Search global setting change events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-logs/searchglobalsettings","routeSlug":"/v1-api-reference/api/audit-logs/searchglobalsettings","metadata":{"seo":{"title":"Search global setting change events","description":"Searches for global setting change events with page-number based pagination. Returns totalPages and totalElements for direct page navigation. No filter is required for global setting queries."}},"httpPath":"/admin/audit/v2/global-settings"},{"label":"Search tenant login events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-logs/searchtenantlogins","routeSlug":"/v1-api-reference/api/audit-logs/searchtenantlogins","metadata":{"seo":{"title":"Search tenant login events","description":"Searches for tenant-level login events with page-number based pagination. Requires a tenantId filter in filter.must. Returns totalPages and totalElements for direct page navigation."}},"httpPath":"/admin/audit/v2/tenant-logins"},{"label":"Search tenant setting change events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-logs/searchtenantsettings","routeSlug":"/v1-api-reference/api/audit-logs/searchtenantsettings","metadata":{"seo":{"title":"Search tenant setting change events","description":"Searches for tenant-level setting change events with page-number based pagination. Requires a tenantId filter in filter.must. Returns totalPages and totalElements for direct page navigation."}},"httpPath":"/admin/audit/v2/tenant-settings"},{"label":"Search tenant object change events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-logs/searchtenantobjects","routeSlug":"/v1-api-reference/api/audit-logs/searchtenantobjects","metadata":{"seo":{"title":"Search tenant object change events","description":"Searches for tenant-level object change events with page-number based pagination. Requires a tenantId filter in filter.must. Optionally accepts an objectType filter with values such as USER, ROLE, and PERMISSION. Returns totalPages and totalElements for direct page navigation."}},"httpPath":"/admin/audit/v2/tenant-objects"}]},{"type":"group","label":"Admin Integrations","link":"/v1-api-reference/api/admin-integrations","routeSlug":"/v1-api-reference/api/admin-integrations","items":[{"label":"List global users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/admin-integrations/getglobalusersdata","routeSlug":"/v1-api-reference/api/admin-integrations/getglobalusersdata","metadata":{"seo":{"title":"List global users","description":"Returns paginated global user data for an organization. Supports filtering by status and standard Spring pagination parameters."}},"httpPath":"/admin/integrations/data/global-users"},{"label":"List global roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/admin-integrations/getglobalrolesdata","routeSlug":"/v1-api-reference/api/admin-integrations/getglobalrolesdata","metadata":{"seo":{"title":"List global roles","description":"Returns paginated global roles at the organization level. Supports standard Spring pagination parameters."}},"httpPath":"/admin/integrations/data/global-roles"},{"label":"List tenant-specific roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/admin-integrations/gettenantrolesdata","routeSlug":"/v1-api-reference/api/admin-integrations/gettenantrolesdata","metadata":{"seo":{"title":"List tenant-specific roles","description":"Returns paginated roles for a specific tenant entity. Supports standard Spring pagination parameters."}},"httpPath":"/admin/integrations/data/tenant-roles"},{"label":"List tenant-specific roles with permissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/admin-integrations/gettenantrolespermissionsdata","routeSlug":"/v1-api-reference/api/admin-integrations/gettenantrolespermissionsdata","metadata":{"seo":{"title":"List tenant-specific roles with permissions","description":"Returns paginated tenant roles with their full permission details. Supports standard Spring pagination parameters."}},"httpPath":"/admin/integrations/data/tenant-roles-permissions"}]},{"type":"separator","label":"Multiple Organizations"},{"type":"group","label":"Data Labeling","link":"/v1-api-reference/api/data-labeling","routeSlug":"/v1-api-reference/api/data-labeling","items":[{"type":"link","label":"General guidelines","link":"/v1-api-reference/api/data-labeling/general-guidelines","routeSlug":"/v1-api-reference/api/data-labeling/general-guidelines"},{"type":"link","label":"Order of object labeling","link":"/v1-api-reference/api/data-labeling/order-of-object-labeling","routeSlug":"/v1-api-reference/api/data-labeling/order-of-object-labeling"},{"type":"link","label":"Caveats⚠️","link":"/v1-api-reference/api/data-labeling/caveats","routeSlug":"/v1-api-reference/api/data-labeling/caveats"},{"label":"Submit a data labeling job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-labeling/post_datalabelingjob","routeSlug":"/v1-api-reference/api/data-labeling/post_datalabelingjob","metadata":{"seo":{"title":"Submit a data labeling job","description":"Submits a data labeling job."}},"httpPath":"/v1/multi-organizations/data-labeling-job"},{"label":"Retrieve a data labeling job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-labeling/get_datalabelingjob","routeSlug":"/v1-api-reference/api/data-labeling/get_datalabelingjob","metadata":{"seo":{"title":"Retrieve a data labeling job","description":"Retrieves a data labeling job. You can use this operation to track the status of the data labeling job."}},"httpPath":"/v1/multi-organizations/data-labeling-job/{job-id}"}]},{"type":"separator","label":"Order to Revenue"},{"type":"group","label":"Data Backfill","link":"/v1-api-reference/api/data-backfill","routeSlug":"/v1-api-reference/api/data-backfill","items":[{"label":"Create a booking date backfill job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/post_createbookingdatebackfilljob","routeSlug":"/v1-api-reference/api/data-backfill/post_createbookingdatebackfilljob","metadata":{"seo":{"title":"Create a booking date backfill job","description":"Creates a booking date backfill job to update the booking date with your charge's original created-on date."}},"httpPath":"/v1/uno/data-backfill/bookingdate/jobs"},{"label":"List all booking date backfill jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/get_listbookingdatebackfilljobs","routeSlug":"/v1-api-reference/api/data-backfill/get_listbookingdatebackfilljobs","metadata":{"seo":{"title":"List all booking date backfill jobs","description":"Use this operation to list all booking date backfill jobs."}},"httpPath":"/v1/uno/data-backfill/bookingdate/jobs"},{"label":"Retrieve a booking date backfill job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/get_bookingdatebackfilljobbyid","routeSlug":"/v1-api-reference/api/data-backfill/get_bookingdatebackfilljobbyid","metadata":{"seo":{"title":"Retrieve a booking date backfill job","description":"Use this operation to retrieve a specific booking date backfill job."}},"httpPath":"/v1/uno/data-backfill/bookingdate/jobs/{jobId}"},{"label":"Stop a booking date backfill job","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/put_stopbookingdatebackfilljobbyid","routeSlug":"/v1-api-reference/api/data-backfill/put_stopbookingdatebackfilljobbyid","metadata":{"seo":{"title":"Stop a booking date backfill job","description":"Use this operation to stop a booking date backfill job."}},"httpPath":"/v1/uno/data-backfill/bookingdate/jobs/{jobId}"},{"label":"Create a data backfill job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/post_createdatabackfilljob","routeSlug":"/v1-api-reference/api/data-backfill/post_createdatabackfilljob","metadata":{"seo":{"title":"Create a data backfill job","description":"Use this operation to perform the following types of data backfill actions. Also, you need to upload a corresponding file to perform a data backfill action."}},"httpPath":"/v1/uno/data-backfill/jobs"},{"label":"Retrieve a data backfill job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/get_databackfilljobbyid","routeSlug":"/v1-api-reference/api/data-backfill/get_databackfilljobbyid","metadata":{"seo":{"title":"Retrieve a data backfill job","description":"Returns a single Data Backfill job"}},"httpPath":"/v1/uno/data-backfill/jobs/{jobId}"},{"label":"Stop a data backfill job","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/put_stopdatabackfilljobbyid","routeSlug":"/v1-api-reference/api/data-backfill/put_stopdatabackfilljobbyid","metadata":{"seo":{"title":"Stop a data backfill job","description":"Use this operation to stop a data backfill job."}},"httpPath":"/v1/uno/data-backfill/jobs/{jobId}"},{"label":"List all data backfill jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/get_listdatabackfilljobs","routeSlug":"/v1-api-reference/api/data-backfill/get_listdatabackfilljobs","metadata":{"seo":{"title":"List all data backfill jobs","description":"List all data backfill jobs"}},"httpPath":"/v1/uno/data-backfill/listjobs"},{"label":"Download a data backfill template file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/get_databackfilltemplate","routeSlug":"/v1-api-reference/api/data-backfill/get_databackfilltemplate","metadata":{"seo":{"title":"Download a data backfill template file","description":"Use this operation to download a data backfill template file of the specific type."}},"httpPath":"/v1/uno/data-backfill/jobs/{type}/template"},{"label":"List all auto backfill jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/get_listautobackfilljob","routeSlug":"/v1-api-reference/api/data-backfill/get_listautobackfilljob","metadata":{"seo":{"title":"List all auto backfill jobs","description":"Use this operation to list all auto backfill jobs."}},"httpPath":"/v1/uno/data-backfill/propagation/jobs"},{"label":"Create an auto backfill job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/post_createautobackfilljob","routeSlug":"/v1-api-reference/api/data-backfill/post_createautobackfilljob","metadata":{"seo":{"title":"Create an auto backfill job","description":"Creates an autobackfill job to update the rate plan charge and order line item with product rate plan charge."}},"httpPath":"/v1/uno/data-backfill/propagation/jobs"},{"label":"Retrieve an auto backfill job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/get_autobackfilljobbyid","routeSlug":"/v1-api-reference/api/data-backfill/get_autobackfilljobbyid","metadata":{"seo":{"title":"Retrieve an auto backfill job","description":"Use this operation to retrieve a specific auto backfill job."}},"httpPath":"/v1/uno/data-backfill/propagation/jobs/{jobId}"},{"label":"Stop an auto backfill job","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/put_stopautobackfilljobbyid","routeSlug":"/v1-api-reference/api/data-backfill/put_stopautobackfilljobbyid","metadata":{"seo":{"title":"Stop an auto backfill job","description":"Use this operation to stop an auto backfill job."}},"httpPath":"/v1/uno/data-backfill/propagation/jobs/{jobId}"}]},{"type":"group","label":"Regenerate","link":"/v1-api-reference/api/regenerate","routeSlug":"/v1-api-reference/api/regenerate","items":[{"label":"Regenerate booking transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/regenerate/post_regeneratebookingtransaction","routeSlug":"/v1-api-reference/api/regenerate/post_regeneratebookingtransaction","metadata":{"seo":{"title":"Regenerate booking transactions","description":"Use this operation to generate booking transactions. This call is useful in the following two use cases:"}},"httpPath":"/v1/uno-regenerate/booking-transaction"},{"label":"Regenerate billing transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/regenerate/post_regeneratebillingtransaction","routeSlug":"/v1-api-reference/api/regenerate/post_regeneratebillingtransaction","metadata":{"seo":{"title":"Regenerate billing transactions","description":"Use this operation to generate billing transactions. This call is useful in the following two use cases:"}},"httpPath":"/v1/uno-regenerate/billing-transaction"},{"label":"Regenerate revenue recognition events transactions for Delivery Schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/regenerate/post_createrevrecevents","routeSlug":"/v1-api-reference/api/regenerate/post_createrevrecevents","metadata":{"seo":{"title":"Regenerate revenue recognition events transactions for Delivery Schedule","description":"Use this operation to generate Delivery Schedule based revenue recognition events transactions."}},"httpPath":"/v1/uno-regenerate/rev-rec-events"},{"label":"Regenerate revenue recognition events transactions for Daily Consumption","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/regenerate/post_generaterevreceventsfordailyconsumption","routeSlug":"/v1-api-reference/api/regenerate/post_generaterevreceventsfordailyconsumption","metadata":{"seo":{"title":"Regenerate revenue recognition events transactions for Daily Consumption","description":"Use this operation to generate Daily Consumption based revenue recognition events transactions when the Prepaid with Drawdown feature is enabled."}},"httpPath":"/v1/uno-regenerate/rev-rec-events/daily-consumption"}]},{"type":"separator","label":"Test Environments"},{"type":"group","label":"Test Environments","link":"/v1-api-reference/api/test-environments","routeSlug":"/v1-api-reference/api/test-environments","items":[{"label":"List all test environments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environments/getalltestenvironments","routeSlug":"/v1-api-reference/api/test-environments/getalltestenvironments","metadata":{"seo":{"title":"List all test environments","description":"Use this operation to retrieves a list of all Test Environments.It returns an ArrayResponse containing TestEnvironmentResponse objects,representing the available Test Environments in the system."}},"httpPath":"/test-environments"},{"label":"Retrieve a test environment response","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environments/gettestenvironment","routeSlug":"/v1-api-reference/api/test-environments/gettestenvironment","metadata":{"seo":{"title":"Retrieve a test environment response","description":"Use this operation to retrieves a specific Test Environment by its unique identifier.It returns a TestEnvironmentResponse object if the environment is found. If the specifiedTest Environment does not exist, it returns a 404 error."}},"httpPath":"/test-environments/{id}"}]},{"type":"group","label":"Test Environment Jobs","link":"/v1-api-reference/api/test-environment-jobs","routeSlug":"/v1-api-reference/api/test-environment-jobs","items":[{"label":"Create a test environment job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-jobs/createtestenvironmentjob","routeSlug":"/v1-api-reference/api/test-environment-jobs/createtestenvironmentjob","metadata":{"seo":{"title":"Create a test environment job","description":"Use this operation to create a new job for a specific Test Environment.It handles HTTP POST requests to the /test-environments/{id}/jobs endpoint,accepting a JobRequest object in the request body. Upon successful creation,it returns a JobResponse object and sets the Location header to the pollingURL for the created job."}},"httpPath":"/test-environments/{id}/jobs"},{"label":"List all jobs of a test environment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-jobs/getalljobsoftestenvironment","routeSlug":"/v1-api-reference/api/test-environment-jobs/getalljobsoftestenvironment","metadata":{"seo":{"title":"List all jobs of a test environment","description":"Use this operation to retrieve a list of job responses associatedwith a specific Test Environment. It handles HTTP GET requests tothe /test-environments/{id}/jobs endpoint and returns an ArrayResponsecontaining JobResponse objects. This method is documented in Swagger,including possible responses for successful retrieval and bad requests."}},"httpPath":"/test-environments/{id}/jobs"},{"label":"Retrieve a job of a test environment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-jobs/getjoboftestenvironment","routeSlug":"/v1-api-reference/api/test-environment-jobs/getjoboftestenvironment","metadata":{"seo":{"title":"Retrieve a job of a test environment","description":"Use this operation to retrieve a specific job associatedwith a Test Environment by its unique job ID. It handlesHTTP GET requests to the /test-environments/{id}/jobs/{jobId}endpoint and returns a JobResponse object if the job is found.If the specified job does not exist, it returns a 404 error."}},"httpPath":"/test-environments/{id}/jobs/{jobId}"},{"label":"Perform an action on a test environment job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-jobs/performactionofjob","routeSlug":"/v1-api-reference/api/test-environment-jobs/performactionofjob","metadata":{"seo":{"title":"Perform an action on a test environment job","description":"Use this operation to perform a specified actionon a Test Environment job. It handles HTTP POSTrequests to the /test-environments/{id}/jobs/{jobId}/actionsendpoint, accepting a JobActionRequest object in therequest body. Upon successful execution, it returns aJobResponse object reflecting the updated job state."}},"httpPath":"/test-environments/{id}/jobs/{jobId}/actions"}]},{"type":"group","label":"Test Environment Notifications","link":"/v1-api-reference/api/test-environment-notifications","routeSlug":"/v1-api-reference/api/test-environment-notifications","items":[{"label":"Create a test environment notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-notifications/createtestenvironmentnotification","routeSlug":"/v1-api-reference/api/test-environment-notifications/createtestenvironmentnotification","metadata":{"seo":{"title":"Create a test environment notification","description":"Use this operation to create a new notificationfor a specific Test Environment. It handles HTTPPOST requests to the /test-environments/{id}/notificationsendpoint, accepting a TestEnvironmentNotificationRequestobject in the request body. Upon successful creation,it returns a TestEnvironmentNotificationResponse objectand sets the Location header to the URL of the creatednotification."}},"httpPath":"/test-environments/{id}/notifications"},{"label":"List all email notifications of a test environment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-notifications/getallemailnotificationoftestenv","routeSlug":"/v1-api-reference/api/test-environment-notifications/getallemailnotificationoftestenv","metadata":{"seo":{"title":"List all email notifications of a test environment","description":"Use this operation to retrieve all notifications associatedwith a specific Test Environment. It handles HTTP GETrequests to the /test-environments/{id}/notificationsendpoint and returns an ArrayResponse containingTestEnvironmentNotificationResponse objects."}},"httpPath":"/test-environments/{id}/notifications"},{"label":"Retrieve a notification response of a test environment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-notifications/gettestenvironmentnotification","routeSlug":"/v1-api-reference/api/test-environment-notifications/gettestenvironmentnotification","metadata":{"seo":{"title":"Retrieve a notification response of a test environment","description":"Use this operation to retrieve a specific notification associatedwith a Test Environment by its unique notification ID. It handlesHTTP GET requests to the /test-environments/{id}/notifications/{notificationId}endpoint and returns a TestEnvironmentNotificationResponse objectif the notification is found. If the specified notification doesnot exist, it returns a 404 error."}},"httpPath":"/test-environments/{id}/notifications/{notificationId}"},{"label":"Update a test environment notification","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-notifications/updatetestenvironmentnotification","routeSlug":"/v1-api-reference/api/test-environment-notifications/updatetestenvironmentnotification","metadata":{"seo":{"title":"Update a test environment notification","description":"Use this operation to update an existing notificationfor a specific Test Environment. It handles HTTP PATCHrequests to the /test-environments/{id}/notifications/{notificationId}endpoint, accepting a TestEnvironmentNotificationRequestobject in the request body. Upon successful update, itreturns a TestEnvironmentNotificationResponse object."}},"httpPath":"/test-environments/{id}/notifications/{notificationId}"},{"label":"Delete a notification of a test environment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-notifications/deletetestenvironmentnotification","routeSlug":"/v1-api-reference/api/test-environment-notifications/deletetestenvironmentnotification","metadata":{"seo":{"title":"Delete a notification of a test environment","description":"Use this operation to delete a specific notification associatedwith a Test Environment. It handles HTTP DELETE requests to the/test-environments/{id}/notifications/{notificationId} endpointand returns a TestEnvironmentNotificationResponse object for thedeleted notification. If the specified notification does not exist,it returns a 404 error."}},"httpPath":"/test-environments/{id}/notifications/{notificationId}"}]},{"type":"separator","label":"General-Purpose Operations"},{"type":"group","label":"Actions","link":"/v1-api-reference/api/actions","routeSlug":"/v1-api-reference/api/actions","items":[{"label":"Create","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/actions/action_postcreate","routeSlug":"/v1-api-reference/api/actions/action_postcreate","metadata":{"seo":{"title":"Create","description":"Use the create call to create one or more objects of a specific type. You can specify different types in different create calls, but each create call must apply to only one type of object."}},"httpPath":"/v1/action/create"},{"label":"Delete","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/actions/action_postdelete","routeSlug":"/v1-api-reference/api/actions/action_postdelete","metadata":{"seo":{"title":"Delete","description":"Deletes one or more objects of the same type. You can specify different types in different delete calls, but each delete call must apply only to one type of object."}},"httpPath":"/v1/action/delete"},{"label":"Query","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/actions/action_postquery","routeSlug":"/v1-api-reference/api/actions/action_postquery","metadata":{"seo":{"title":"Query","description":"The query call sends a query expression by specifying the object to query, the fields to retrieve from that object, and any filters to determine whether a given object should be queried."}},"httpPath":"/v1/action/query"},{"label":"QueryMore","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/actions/action_postquerymore","routeSlug":"/v1-api-reference/api/actions/action_postquerymore","metadata":{"seo":{"title":"QueryMore","description":"Use queryMore to request additional results from a previous query call. If your initial query call returns more than 2000 results, you can use queryMore to query for the additional results."}},"httpPath":"/v1/action/queryMore"},{"label":"Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/actions/action_postupdate","routeSlug":"/v1-api-reference/api/actions/action_postupdate","metadata":{"seo":{"title":"Update","description":"Updates the information in one or more objects of the same type. You can specify different types of objects in different update calls, but each specific update call must apply to only one type of object."}},"httpPath":"/v1/action/update"}]},{"type":"group","label":"Settings","link":"/v1-api-reference/api/settings","routeSlug":"/v1-api-reference/api/settings","items":[{"label":"Submit settings requests","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/settings/post_processsettingsbatchrequest","routeSlug":"/v1-api-reference/api/settings/post_processsettingsbatchrequest","metadata":{"seo":{"title":"Submit settings requests","description":"Submit a batch of settings requests by this single API operation."}},"httpPath":"/settings/batch-requests"},{"label":"List all settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/settings/get_listallsettings","routeSlug":"/v1-api-reference/api/settings/get_listallsettings","metadata":{"seo":{"title":"List all settings","description":"Get a list of all available settings in your tenant."}},"httpPath":"/settings/listing"}]},{"type":"group","label":"Files","link":"/v1-api-reference/api/files","routeSlug":"/v1-api-reference/api/files","items":[{"label":"Retrieve a file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/files/get_files","routeSlug":"/v1-api-reference/api/files/get_files","metadata":{"seo":{"title":"Retrieve a file","description":"Retrieve files such as export results, invoices, and accounting period reports."}},"httpPath":"/v1/files/{file-id}"},{"label":"Restore a file","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/files/put_files","routeSlug":"/v1-api-reference/api/files/put_files","metadata":{"seo":{"title":"Restore a file","description":"Restores a previously archived file to its RESTORED status. Once a file is archived, it cannot be used directly until the file is restored using this API."}},"httpPath":"/v1/files/{file-id}/restore"},{"label":"Retrieve file status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/files/get_filestatus","routeSlug":"/v1-api-reference/api/files/get_filestatus","metadata":{"seo":{"title":"Retrieve file status","description":"Retrieves the status of the file."}},"httpPath":"/v1/files/{file-id}/status"}]},{"type":"group","label":"Imports","link":"/v1-api-reference/api/imports","routeSlug":"/v1-api-reference/api/imports","items":[{"label":"CRUD: Create an import","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/imports/object_postimport","routeSlug":"/v1-api-reference/api/imports/object_postimport","metadata":{"seo":{"title":"CRUD: Create an import","description":"Creates a data import."}},"httpPath":"/v1/object/import"},{"label":"CRUD: Retrieve an import","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/imports/object_getimport","routeSlug":"/v1-api-reference/api/imports/object_getimport","metadata":{"seo":{"title":"CRUD: Retrieve an import","description":"Retrieve an data import job."}},"httpPath":"/v1/object/import/{id}"}]},{"type":"group","label":"Custom Exchange Rates","link":"/v1-api-reference/api/custom-exchange-rates","routeSlug":"/v1-api-reference/api/custom-exchange-rates","items":[{"label":"List custom exchange rates by currency","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-exchange-rates/get_customexchangerates","routeSlug":"/v1-api-reference/api/custom-exchange-rates/get_customexchangerates","metadata":{"seo":{"title":"List custom exchange rates by currency","description":"This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support."}},"httpPath":"/v1/custom-exchange-rates/{currency}"}]},{"type":"group","label":"Attachments","link":"/v1-api-reference/api/attachments","routeSlug":"/v1-api-reference/api/attachments","items":[{"label":"Create an attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/attachments/post_attachments","routeSlug":"/v1-api-reference/api/attachments/post_attachments","metadata":{"seo":{"title":"Create an attachment","description":"Use the Add Attachment REST request with a multipart/form-data to attach a document file to an Account, a Subscription, an Invoice, a Credit Memo, or a Debit Memo."}},"httpPath":"/v1/attachments"},{"label":"Delete an attachment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/attachments/delete_attachments","routeSlug":"/v1-api-reference/api/attachments/delete_attachments","metadata":{"seo":{"title":"Delete an attachment","description":"Use the Delete Attachment REST request to delete an attachment from a Zuora object."}},"httpPath":"/v1/attachments/{attachment-id}"},{"label":"Retrieve an attachment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/attachments/get_attachments","routeSlug":"/v1-api-reference/api/attachments/get_attachments","metadata":{"seo":{"title":"Retrieve an attachment","description":"Use the View Attachment REST request to retrieve information about an attachment document."}},"httpPath":"/v1/attachments/{attachment-id}"},{"label":"Update an attachment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/attachments/put_attachments","routeSlug":"/v1-api-reference/api/attachments/put_attachments","metadata":{"seo":{"title":"Update an attachment","description":"Use the Edit Attachment REST request to make changes to the descriptive fields of an attachment, such as the description and the file name. You cannot change the actual content of the attached file in Zuora. If you need to change the actual content, you need to delete the attachment and add the updated file as a new attachment."}},"httpPath":"/v1/attachments/{attachment-id}"},{"label":"List attachments by object type and key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/attachments/get_attachmentslist","routeSlug":"/v1-api-reference/api/attachments/get_attachmentslist","metadata":{"seo":{"title":"List attachments by object type and key","description":"Use the View Attachment REST request to get a list of attachments on an account, an invoice, a subscription, a credit memo, or a debit memo."}},"httpPath":"/v1/attachments/{object-type}/{object-key}"}]},{"type":"group","label":"Metadata","link":"/v1-api-reference/api/metadata","routeSlug":"/v1-api-reference/api/metadata","items":[{"label":"List available metadata objects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata/listmetadataobjects","routeSlug":"/v1-api-reference/api/metadata/listmetadataobjects","metadata":{"seo":{"title":"List available metadata objects","description":"Returns all available objects for the specified metadata context."}},"httpPath":"/object-metadata"},{"label":"Retrieve metadata object schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata/retrievemetadataobjectschema","routeSlug":"/v1-api-reference/api/metadata/retrievemetadataobjectschema","metadata":{"seo":{"title":"Retrieve metadata object schema","description":"Returns the complete JSON Schema for the specified object."}},"httpPath":"/object-metadata/{objectName}"}]},{"type":"group","label":"Describe","link":"/v1-api-reference/api/describe","routeSlug":"/v1-api-reference/api/describe","items":[{"label":"Describe an object","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/describe/get_describe","routeSlug":"/v1-api-reference/api/describe/get_describe","metadata":{"seo":{"title":"Describe an object","description":"Provides a reference listing of each object that is available in your Zuora tenant."}},"httpPath":"/v1/describe/{object}"}]},{"type":"separator","label":"Legacy v1 Products"},{"type":"group","label":"Products","link":"/v1-api-reference/api/products","routeSlug":"/v1-api-reference/api/products","items":[{"label":"CRUD: Create a product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/products/object_postproduct","routeSlug":"/v1-api-reference/api/products/object_postproduct","metadata":{"seo":{"title":"CRUD: Create a product","description":"CRUD: Create a product"}},"httpPath":"/v1/object/product"},{"label":"CRUD: Retrieve a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/products/object_getproduct","routeSlug":"/v1-api-reference/api/products/object_getproduct","metadata":{"seo":{"title":"CRUD: Retrieve a product","description":"Retrieve a specific product."}},"httpPath":"/v1/object/product/{id}"},{"label":"CRUD: Update a product","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/products/object_putproduct","routeSlug":"/v1-api-reference/api/products/object_putproduct","metadata":{"seo":{"title":"CRUD: Update a product","description":"Updates a Product object."}},"httpPath":"/v1/object/product/{id}"},{"label":"CRUD: Delete a product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/products/object_deleteproduct","routeSlug":"/v1-api-reference/api/products/object_deleteproduct","metadata":{"seo":{"title":"CRUD: Delete a product","description":"Deletes a specific product."}},"httpPath":"/v1/object/product/{id}"}]},{"type":"group","label":"Catalog","link":"/v1-api-reference/api/catalog","routeSlug":"/v1-api-reference/api/catalog","items":[{"label":"List all products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/catalog/get_catalog","routeSlug":"/v1-api-reference/api/catalog/get_catalog","metadata":{"seo":{"title":"List all products","description":"Retrieves the entire product catalog, including all products, features, and their corresponding product rate plans, charges. Products are returned in reverse chronological order on the UpdatedDate field."}},"httpPath":"/v1/catalog/products"},{"label":"Retrieve a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/catalog/get_product","routeSlug":"/v1-api-reference/api/catalog/get_product","metadata":{"seo":{"title":"Retrieve a product","description":"Retrieves detailed information about a specific product, including information about its product rate plans and charges."}},"httpPath":"/v1/catalog/products/{product-key}"}]},{"type":"group","label":"Catalog Groups","link":"/v1-api-reference/api/catalog-groups","routeSlug":"/v1-api-reference/api/catalog-groups","items":[{"label":"Create a catalog group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/catalog-groups/post_createcataloggroup","routeSlug":"/v1-api-reference/api/catalog-groups/post_createcataloggroup","metadata":{"seo":{"title":"Create a catalog group","description":"Note: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support."}},"httpPath":"/v1/catalog-groups"},{"label":"List all catalog groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/catalog-groups/get_listallcataloggroups","routeSlug":"/v1-api-reference/api/catalog-groups/get_listallcataloggroups","metadata":{"seo":{"title":"List all catalog groups","description":"Note: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support."}},"httpPath":"/v1/catalog-groups"},{"label":"Retrieve a catalog group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/catalog-groups/get_retrievecataloggroup","routeSlug":"/v1-api-reference/api/catalog-groups/get_retrievecataloggroup","metadata":{"seo":{"title":"Retrieve a catalog group","description":"Note: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support."}},"httpPath":"/v1/catalog-groups/{catalog-group-key}"},{"label":"Update a catalog group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/catalog-groups/put_updatecataloggroup","routeSlug":"/v1-api-reference/api/catalog-groups/put_updatecataloggroup","metadata":{"seo":{"title":"Update a catalog group","description":"Note: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support."}},"httpPath":"/v1/catalog-groups/{catalog-group-key}"},{"label":"Delete a catalog group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/catalog-groups/delete_cataloggroup","routeSlug":"/v1-api-reference/api/catalog-groups/delete_cataloggroup","metadata":{"seo":{"title":"Delete a catalog group","description":"Note: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support."}},"httpPath":"/v1/catalog-groups/{catalog-group-key}"}]},{"type":"group","label":"Product Rate Plans","link":"/v1-api-reference/api/product-rate-plans","routeSlug":"/v1-api-reference/api/product-rate-plans","items":[{"label":"List all product rate plans of a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plans/get_productrateplans","routeSlug":"/v1-api-reference/api/product-rate-plans/get_productrateplans","metadata":{"seo":{"title":"List all product rate plans of a product","description":"Retrieves information about all product rate plans of a specific product."}},"httpPath":"/v1/products/{product-key}/product-rate-plans"},{"label":"Retrieve a product rate plan by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plans/get_productrateplan","routeSlug":"/v1-api-reference/api/product-rate-plans/get_productrateplan","metadata":{"seo":{"title":"Retrieve a product rate plan by ID","description":"Retrieves a product rate plan by its ID."}},"httpPath":"/v1/product-rate-plans/{id}"},{"label":"List product rate plans by external ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plans/get_productrateplansbyexternalid","routeSlug":"/v1-api-reference/api/product-rate-plans/get_productrateplansbyexternalid","metadata":{"seo":{"title":"List product rate plans by external ID","description":"Retrieves information about one or multiple product rate plans by external ID."}},"httpPath":"/v1/product-rate-plans/external-id/{id}"},{"label":"CRUD: Create a product rate plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plans/object_postproductrateplan","routeSlug":"/v1-api-reference/api/product-rate-plans/object_postproductrateplan","metadata":{"seo":{"title":"CRUD: Create a product rate plan","description":"Retrieves a product rate plan."}},"httpPath":"/v1/object/product-rate-plan"},{"label":"CRUD: Retrieve a product rate plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plans/object_getproductrateplan","routeSlug":"/v1-api-reference/api/product-rate-plans/object_getproductrateplan","metadata":{"seo":{"title":"CRUD: Retrieve a product rate plan","description":"Retrieves a product rate plan."}},"httpPath":"/v1/object/product-rate-plan/{id}"},{"label":"CRUD: Update a product rate plan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plans/object_putproductrateplan","routeSlug":"/v1-api-reference/api/product-rate-plans/object_putproductrateplan","metadata":{"seo":{"title":"CRUD: Update a product rate plan","description":"Updates a product rate plan."}},"httpPath":"/v1/object/product-rate-plan/{id}"},{"label":"CRUD: Delete a product rate plan","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plans/object_deleteproductrateplan","routeSlug":"/v1-api-reference/api/product-rate-plans/object_deleteproductrateplan","metadata":{"seo":{"title":"CRUD: Delete a product rate plan","description":"Deletes a product rate plan."}},"httpPath":"/v1/object/product-rate-plan/{id}"}]},{"type":"group","label":"Product Rate Plan Definitions","link":"/v1-api-reference/api/product-rate-plan-definitions","routeSlug":"/v1-api-reference/api/product-rate-plan-definitions","items":[{"label":"Create a product rate plan definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-definitions/post_createproductrateplandefinition","routeSlug":"/v1-api-reference/api/product-rate-plan-definitions/post_createproductrateplandefinition","metadata":{"seo":{"title":"Create a product rate plan definition","description":"Creates a product rate plan definition to use a charge in a product rate plan."}},"httpPath":"/v1/product-rateplan-definitions"},{"label":"List product rate plan definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-definitions/get_retrieveproductrateplandefinitions","routeSlug":"/v1-api-reference/api/product-rate-plan-definitions/get_retrieveproductrateplandefinitions","metadata":{"seo":{"title":"List product rate plan definitions","description":"Retrieves basic information about the product rate plan definitions for a product rate plan."}},"httpPath":"/v1/product-rateplan-definitions"},{"label":"Retrieve a product rate plan definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-definitions/get_retrieveproductrateplandefinition","routeSlug":"/v1-api-reference/api/product-rate-plan-definitions/get_retrieveproductrateplandefinition","metadata":{"seo":{"title":"Retrieve a product rate plan definition","description":"Retrieves basic information about a product rate plan definition."}},"httpPath":"/v1/product-rateplan-definitions/{product-rateplan-definition-key}"},{"label":"Delete a product rate plan definition","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-definitions/delete_productrateplandefnition","routeSlug":"/v1-api-reference/api/product-rate-plan-definitions/delete_productrateplandefnition","metadata":{"seo":{"title":"Delete a product rate plan definition","description":"Deletes a product rate plan definition."}},"httpPath":"/v1/product-rateplan-definitions/{product-rateplan-definition-key}"}]},{"type":"group","label":"Product Rate Plan Charges","link":"/v1-api-reference/api/product-rate-plan-charges","routeSlug":"/v1-api-reference/api/product-rate-plan-charges","items":[{"label":"Retrieve a product rate plan charge","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-charges/get_retrieveproductrateplancharge","routeSlug":"/v1-api-reference/api/product-rate-plan-charges/get_retrieveproductrateplancharge","metadata":{"seo":{"title":"Retrieve a product rate plan charge","description":"Retrieves basic information about a product rate plan charge."}},"httpPath":"/v1/product-rate-plan-charges/{product-rate-plan-charge-key}"},{"label":"CRUD: Create a product rate plan charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-charges/object_postproductrateplancharge","routeSlug":"/v1-api-reference/api/product-rate-plan-charges/object_postproductrateplancharge","metadata":{"seo":{"title":"CRUD: Create a product rate plan charge","description":"Creates a product rate plan charge for a specified rate plan charge.Product rate plan charges can be of three types, one-time fees, recurring fees, and usage fees."}},"httpPath":"/v1/object/product-rate-plan-charge"},{"label":"CRUD: Retrieve a product rate plan charge","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-charges/object_getproductrateplancharge","routeSlug":"/v1-api-reference/api/product-rate-plan-charges/object_getproductrateplancharge","metadata":{"seo":{"title":"CRUD: Retrieve a product rate plan charge","description":"Retrieves a specific product rate plan charge.Note: To use the enhanced unit-based Prepaid with Drawdown fields, set theX-Zuora-WSDL-Version request header to a value greater than 155.0."}},"httpPath":"/v1/object/product-rate-plan-charge/{id}"},{"label":"CRUD: Update a product rate plan charge","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-charges/object_putproductrateplancharge","routeSlug":"/v1-api-reference/api/product-rate-plan-charges/object_putproductrateplancharge","metadata":{"seo":{"title":"CRUD: Update a product rate plan charge","description":"Updates the information about a product rate plan charge."}},"httpPath":"/v1/object/product-rate-plan-charge/{id}"},{"label":"CRUD: Delete a product rate plan charge","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-charges/object_deleteproductrateplancharge","routeSlug":"/v1-api-reference/api/product-rate-plan-charges/object_deleteproductrateplancharge","metadata":{"seo":{"title":"CRUD: Delete a product rate plan charge","description":"Deletes a product rate plan charge."}},"httpPath":"/v1/object/product-rate-plan-charge/{id}"}]},{"type":"group","label":"Product Charge Definitions","link":"/v1-api-reference/api/product-charge-definitions","routeSlug":"/v1-api-reference/api/product-charge-definitions","items":[{"label":"Create a product charge definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-charge-definitions/post_createproductchargedefinition","routeSlug":"/v1-api-reference/api/product-charge-definitions/post_createproductchargedefinition","metadata":{"seo":{"title":"Create a product charge definition","description":"Creates a product charge definition for a charge. You can create as many product charge definitions as needed for one charge."}},"httpPath":"/v1/product-charge-definitions"},{"label":"List product charge definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-charge-definitions/get_retrieveproductchargedefinitions","routeSlug":"/v1-api-reference/api/product-charge-definitions/get_retrieveproductchargedefinitions","metadata":{"seo":{"title":"List product charge definitions","description":"Retrieves basic information about the product charge definitions."}},"httpPath":"/v1/product-charge-definitions"},{"label":"Create product charge definitions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-charge-definitions/post_createproductchargedefinitionbulk","routeSlug":"/v1-api-reference/api/product-charge-definitions/post_createproductchargedefinitionbulk","metadata":{"seo":{"title":"Create product charge definitions","description":"Bulk creates product charge definitions for a charge. You can create up to 1000 product charge definitions at a given time for a specific charge."}},"httpPath":"/v1/product-charge-definitions/bulk"},{"label":"Update product charge definitions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-charge-definitions/put_updateproductchargedefinitionbulk","routeSlug":"/v1-api-reference/api/product-charge-definitions/put_updateproductchargedefinitionbulk","metadata":{"seo":{"title":"Update product charge definitions","description":"Bulk updates multiple product charge definitions."}},"httpPath":"/v1/product-charge-definitions/bulk"},{"label":"Retrieve a product charge definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-charge-definitions/get_retrieveproductchargedefinition","routeSlug":"/v1-api-reference/api/product-charge-definitions/get_retrieveproductchargedefinition","metadata":{"seo":{"title":"Retrieve a product charge definition","description":"Retrieves basic information about a product charge definition."}},"httpPath":"/v1/product-charge-definitions/{product-charge-definition-key}"},{"label":"Update a product charge definition","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-charge-definitions/put_updateproductchargedefinition","routeSlug":"/v1-api-reference/api/product-charge-definitions/put_updateproductchargedefinition","metadata":{"seo":{"title":"Update a product charge definition","description":"Update a product charge definition."}},"httpPath":"/v1/product-charge-definitions/{product-charge-definition-key}"},{"label":"Delete a product charge definition","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-charge-definitions/delete_productchargedefnition","routeSlug":"/v1-api-reference/api/product-charge-definitions/delete_productchargedefnition","metadata":{"seo":{"title":"Delete a product charge definition","description":"Deletes a product charge definition."}},"httpPath":"/v1/product-charge-definitions/{product-charge-definition-key}"}]},{"type":"group","label":"Product Rate Plan Charge Tiers","link":"/v1-api-reference/api/product-rate-plan-charge-tiers","routeSlug":"/v1-api-reference/api/product-rate-plan-charge-tiers","items":[{"label":"CRUD: Retrieve a product rate plan charge tier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-charge-tiers/object_getproductrateplanchargetier","routeSlug":"/v1-api-reference/api/product-rate-plan-charge-tiers/object_getproductrateplanchargetier","metadata":{"seo":{"title":"CRUD: Retrieve a product rate plan charge tier","description":"Retrieves a specific product rate plan charge tier."}},"httpPath":"/v1/object/product-rate-plan-charge-tier/{id}"},{"label":"CRUD: Update a product rate plan charge tier","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-charge-tiers/object_putproductrateplanchargetier","routeSlug":"/v1-api-reference/api/product-rate-plan-charge-tiers/object_putproductrateplanchargetier","metadata":{"seo":{"title":"CRUD: Update a product rate plan charge tier","description":"Updates the price of a product rate plan charge tier."}},"httpPath":"/v1/object/product-rate-plan-charge-tier/{id}"}]},{"type":"group","label":"Zuora Revenue Integration","link":"/v1-api-reference/api/zuora-revenue-integration","routeSlug":"/v1-api-reference/api/zuora-revenue-integration","items":[{"label":"Update a Zuora Revenue accounting code","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/zuora-revenue-integration/put_revproaccountingcodes","routeSlug":"/v1-api-reference/api/zuora-revenue-integration/put_revproaccountingcodes","metadata":{"seo":{"title":"Update a Zuora Revenue accounting code","description":"Update the Zuora Revenue accounting code that corresponds to a specific Product Rate Plan Charge Id in Zuora Billing."}},"httpPath":"/v1/revpro-accounting-codes"}]}],"expanded":"true"},{"type":"group","label":"Legacy API Reference","items":[{"type":"link","label":"Older API Reference","link":"/v1-api-reference/older-api","routeSlug":"/v1-api-reference/older-api"},{"type":"group","label":"Actions","link":"/v1-api-reference/older-api/actions","routeSlug":"/v1-api-reference/older-api/actions","items":[{"label":"Amend","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/actions/action_postamend","routeSlug":"/v1-api-reference/older-api/actions/action_postamend","metadata":{"seo":{"title":"Amend","description":"Modifies a subscription by creating Amendment objects. However, to modify a subscription, Zuora recommends that you use the Create an order operation instead of this action."}},"httpPath":"/v1/action/amend"},{"label":"Execute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/actions/action_postexecute","routeSlug":"/v1-api-reference/older-api/actions/action_postexecute","metadata":{"seo":{"title":"Execute","description":"Use the execute call to execute a process to split an invoice into multiple invoices. The original invoice must be in draft status. The resulting invoices are called split invoices."}},"httpPath":"/v1/action/execute"},{"label":"Generate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/actions/action_postgenerate","routeSlug":"/v1-api-reference/older-api/actions/action_postgenerate","metadata":{"seo":{"title":"Generate","description":"Generates an on-demand invoice for a specific customer. This is similar to creating an ad-hoc bill run for a specific customer account in the Zuora UI."}},"httpPath":"/v1/action/generate"},{"label":"Subscribe","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/actions/action_postsubscribe","routeSlug":"/v1-api-reference/older-api/actions/action_postsubscribe","metadata":{"seo":{"title":"Subscribe","description":"This call performs many actions.  Use the subscribe call to bundle information required to create at least one new subscription.The call takes in an array of SubscribeRequests. Because it takes an array, you can submit a batch of subscription requests at once. You can create up to 50 different subscriptions in a single subscribe call.This is a combined call that you can use to perform all of the following tasks in a single call:"}},"httpPath":"/v1/action/subscribe"}]},{"type":"group","label":"Accounts","link":"/v1-api-reference/older-api/accounts","routeSlug":"/v1-api-reference/older-api/accounts","items":[{"label":"CRUD: Create an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/accounts/object_postaccount","routeSlug":"/v1-api-reference/older-api/accounts/object_postaccount","metadata":{"seo":{"title":"CRUD: Create an account","description":"Creates an account without creating any associated objects such as subscriptions."}},"httpPath":"/v1/object/account"},{"label":"CRUD: Retrieve an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/accounts/object_getaccount","routeSlug":"/v1-api-reference/older-api/accounts/object_getaccount","metadata":{"seo":{"title":"CRUD: Retrieve an account","description":"Retrieves the information about one specific account."}},"httpPath":"/v1/object/account/{id}"},{"label":"CRUD: Update an account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/accounts/object_putaccount","routeSlug":"/v1-api-reference/older-api/accounts/object_putaccount","metadata":{"seo":{"title":"CRUD: Update an account","description":"Updates an account."}},"httpPath":"/v1/object/account/{id}"},{"label":"CRUD: Delete an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/accounts/object_deleteaccount","routeSlug":"/v1-api-reference/older-api/accounts/object_deleteaccount","metadata":{"seo":{"title":"CRUD: Delete an account","description":"Deletes a specific account asynchronously."}},"httpPath":"/v1/object/account/{id}"}]},{"type":"group","label":"Amendments","link":"/v1-api-reference/older-api/amendments","routeSlug":"/v1-api-reference/older-api/amendments","items":[{"label":"Retrieve an amendment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/amendments/get_amendmentsbykey","routeSlug":"/v1-api-reference/older-api/amendments/get_amendmentsbykey","metadata":{"seo":{"title":"Retrieve an amendment","description":"Retrieves detailed information about the specified subscription amendment."}},"httpPath":"/v1/amendments/{amendment-key}"},{"label":"Retrieve the last amendment of a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/amendments/get_amendmentsbysubscriptionid","routeSlug":"/v1-api-reference/older-api/amendments/get_amendmentsbysubscriptionid","metadata":{"seo":{"title":"Retrieve the last amendment of a subscription","description":"Retrieves detailed information about the last amendment of the specified subscription."}},"httpPath":"/v1/amendments/subscriptions/{subscription-id}"},{"label":"CRUD: Retrieve an amendment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/amendments/object_getamendment","routeSlug":"/v1-api-reference/older-api/amendments/object_getamendment","metadata":{"seo":{"title":"CRUD: Retrieve an amendment","description":"CRUD: Retrieve an amendment"}},"httpPath":"/v1/object/amendment/{id}"},{"label":"CRUD: Update an amendment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/amendments/object_putamendment","routeSlug":"/v1-api-reference/older-api/amendments/object_putamendment","metadata":{"seo":{"title":"CRUD: Update an amendment","description":"CRUD: Update an amendment"}},"httpPath":"/v1/object/amendment/{id}"},{"label":"CRUD: Delete an amendment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/amendments/object_deleteamendment","routeSlug":"/v1-api-reference/older-api/amendments/object_deleteamendment","metadata":{"seo":{"title":"CRUD: Delete an amendment","description":"Invoiced amendments cannot usually be deleted. One exception to this rule is auto-renew amendments. You can delete the last auto-renew amendment even if an invoice has been generated."}},"httpPath":"/v1/object/amendment/{id}"}]},{"type":"group","label":"Bill Runs","link":"/v1-api-reference/older-api/bill-runs","routeSlug":"/v1-api-reference/older-api/bill-runs","items":[{"label":"CRUD: Create a bill run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/bill-runs/object_postbillrun","routeSlug":"/v1-api-reference/older-api/bill-runs/object_postbillrun","metadata":{"seo":{"title":"CRUD: Create a bill run","description":"Creates an ad hoc bill run or a single account or multiple customer accounts."}},"httpPath":"/v1/object/bill-run"},{"label":"CRUD: Retrieve a bill run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/bill-runs/object_getbillrun","routeSlug":"/v1-api-reference/older-api/bill-runs/object_getbillrun","metadata":{"seo":{"title":"CRUD: Retrieve a bill run","description":"Retrieves information about a bill run."}},"httpPath":"/v1/object/bill-run/{id}"},{"label":"CRUD: Post or cancel a bill run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/bill-runs/object_putbillrun","routeSlug":"/v1-api-reference/older-api/bill-runs/object_putbillrun","metadata":{"seo":{"title":"CRUD: Post or cancel a bill run","description":"Posts or cancels a bill run."}},"httpPath":"/v1/object/bill-run/{id}"},{"label":"CRUD: Delete a bill run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/bill-runs/object_deletebillrun","routeSlug":"/v1-api-reference/older-api/bill-runs/object_deletebillrun","metadata":{"seo":{"title":"CRUD: Delete a bill run","description":"Deletes a bill run."}},"httpPath":"/v1/object/bill-run/{id}"}]},{"type":"group","label":"Contacts","link":"/v1-api-reference/older-api/contacts","routeSlug":"/v1-api-reference/older-api/contacts","items":[{"label":"CRUD: Create a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/contacts/object_postcontact","routeSlug":"/v1-api-reference/older-api/contacts/object_postcontact","metadata":{"seo":{"title":"CRUD: Create a contact","description":"Creates a contact for a specified account."}},"httpPath":"/v1/object/contact"},{"label":"CRUD: Retrieve a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/contacts/object_getcontact","routeSlug":"/v1-api-reference/older-api/contacts/object_getcontact","metadata":{"seo":{"title":"CRUD: Retrieve a contact","description":"Retrieves detailed information about a specific contact."}},"httpPath":"/v1/object/contact/{id}"},{"label":"CRUD: Update a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/contacts/object_putcontact","routeSlug":"/v1-api-reference/older-api/contacts/object_putcontact","metadata":{"seo":{"title":"CRUD: Update a contact","description":"Updates a contact for a specified account."}},"httpPath":"/v1/object/contact/{id}"},{"label":"CRUD: Delete a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/contacts/object_deletecontact","routeSlug":"/v1-api-reference/older-api/contacts/object_deletecontact","metadata":{"seo":{"title":"CRUD: Delete a contact","description":"Deletes a contact."}},"httpPath":"/v1/object/contact/{id}"}]},{"type":"group","label":"Catalog","link":"/v1-api-reference/older-api/catalog","routeSlug":"/v1-api-reference/older-api/catalog","items":[{"label":"Multi-entity: Share a product with an entity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/catalog/post_catalog","routeSlug":"/v1-api-reference/older-api/catalog/post_catalog","metadata":{"seo":{"title":"Multi-entity: Share a product with an entity","description":"Shares a product with a target entity. Zuora synchronizes the shared products to the target entity after sharing. For more information about product sharing, see Products Sharing Across Entities."}},"httpPath":"/v1/catalog/products/{product-id}/share"}]},{"type":"group","label":"Charge Metrics","link":"/v1-api-reference/older-api/charge-metrics","routeSlug":"/v1-api-reference/older-api/charge-metrics","items":[{"label":"List charge metrics by time range","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/charge-metrics/get_chargemetrics","routeSlug":"/v1-api-reference/older-api/charge-metrics/get_chargemetrics","metadata":{"seo":{"title":"List charge metrics by time range","description":"Retrieves key charge metrics about rate plan charges that have changes in a specified time range."}},"httpPath":"/charge-metrics/data/charge-metrics"},{"label":"List discount allocation details by time range","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/charge-metrics/get_chargemetricsdiscountallocationdetails","routeSlug":"/v1-api-reference/older-api/charge-metrics/get_chargemetricsdiscountallocationdetails","metadata":{"seo":{"title":"List discount allocation details by time range","description":"Retrieves discount allocation details about rate plan charges that have changes in a specified time range."}},"httpPath":"/charge-metrics/data/charge-metrics-discount-allocation-detail"}]},{"type":"group","label":"Charge Revenue Summaries","link":"/v1-api-reference/older-api/charge-revenue-summaries","routeSlug":"/v1-api-reference/older-api/charge-revenue-summaries","items":[{"label":"List all details of a charge revenue summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/charge-revenue-summaries/get_crsbycrsnumber","routeSlug":"/v1-api-reference/older-api/charge-revenue-summaries/get_crsbycrsnumber","metadata":{"seo":{"title":"List all details of a charge revenue summary","description":"Retrieves the details of a charge revenue summary by specifying the charge revenue summary number. The response includes all revenue items associated with the charge revenue summary."}},"httpPath":"/v1/charge-revenue-summaries/{crs-number}"},{"label":"Retrieve a charge revenue summary by charge ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/charge-revenue-summaries/get_crsbychargeid","routeSlug":"/v1-api-reference/older-api/charge-revenue-summaries/get_crsbychargeid","metadata":{"seo":{"title":"Retrieve a charge revenue summary by charge ID","description":"Retrieves the details of a charge revenue summary by specifying the subscription charge ID. This response retrieves all revenue items associated with a charge revenue summary."}},"httpPath":"/v1/charge-revenue-summaries/subscription-charges/{charge-key}"}]},{"type":"group","label":"Communication Profiles","link":"/v1-api-reference/older-api/communication-profiles","routeSlug":"/v1-api-reference/older-api/communication-profiles","items":[{"label":"CRUD: Retrieve a communication profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/communication-profiles/object_getcommunicationprofile","routeSlug":"/v1-api-reference/older-api/communication-profiles/object_getcommunicationprofile","metadata":{"seo":{"title":"CRUD: Retrieve a communication profile","description":"CRUD: Retrieve a communication profile"}},"httpPath":"/v1/object/communication-profile/{id}"}]},{"type":"group","label":"Connections","link":"/v1-api-reference/older-api/connections","routeSlug":"/v1-api-reference/older-api/connections","items":[{"label":"Establish a connection to Zuora REST API","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/connections/post_connections","routeSlug":"/v1-api-reference/older-api/connections/post_connections","metadata":{"seo":{"title":"Establish a connection to Zuora REST API","description":"Establishes a connection to the Zuora REST API service based on a valid user credentials."}},"httpPath":"/v1/connections"}]},{"type":"group","label":"Credit Balance Adjustments","link":"/v1-api-reference/older-api/credit-balance-adjustments","routeSlug":"/v1-api-reference/older-api/credit-balance-adjustments","items":[{"label":"CRUD: Create a credit balance adjustment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/credit-balance-adjustments/object_postcreditbalanceadjustment","routeSlug":"/v1-api-reference/older-api/credit-balance-adjustments/object_postcreditbalanceadjustment","metadata":{"seo":{"title":"CRUD: Create a credit balance adjustment","description":"CRUD: Create a credit balance adjustment"}},"httpPath":"/v1/object/credit-balance-adjustment"},{"label":"CRUD: Retrieve a credit balance adjustment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/credit-balance-adjustments/object_getcreditbalanceadjustment","routeSlug":"/v1-api-reference/older-api/credit-balance-adjustments/object_getcreditbalanceadjustment","metadata":{"seo":{"title":"CRUD: Retrieve a credit balance adjustment","description":"CRUD: Retrieve a credit balance adjustment"}},"httpPath":"/v1/object/credit-balance-adjustment/{id}"},{"label":"CRUD: Update a credit balance adjustment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/credit-balance-adjustments/object_putcreditbalanceadjustment","routeSlug":"/v1-api-reference/older-api/credit-balance-adjustments/object_putcreditbalanceadjustment","metadata":{"seo":{"title":"CRUD: Update a credit balance adjustment","description":"CRUD: Update a credit balance adjustment"}},"httpPath":"/v1/object/credit-balance-adjustment/{id}"}]},{"type":"group","label":"Document Properties","link":"/v1-api-reference/older-api/document-properties","routeSlug":"/v1-api-reference/older-api/document-properties","items":[{"label":"Create document properties","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/document-properties/post_documentproperties","routeSlug":"/v1-api-reference/older-api/document-properties/post_documentproperties","metadata":{"seo":{"title":"Create document properties","description":"Note: This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support."}},"httpPath":"/v1/document-properties"},{"label":"List all properties of a billing document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/document-properties/get_documentproperties","routeSlug":"/v1-api-reference/older-api/document-properties/get_documentproperties","metadata":{"seo":{"title":"List all properties of a billing document","description":"Note: This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support."}},"httpPath":"/v1/document-properties/{documentType}/{documentKey}"},{"label":"Update document properties","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/document-properties/put_documentproperties","routeSlug":"/v1-api-reference/older-api/document-properties/put_documentproperties","metadata":{"seo":{"title":"Update document properties","description":"Note: This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support."}},"httpPath":"/v1/document-properties/{documentPropertiesId}"},{"label":"Delete document properties","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/document-properties/delete_documentproperties","routeSlug":"/v1-api-reference/older-api/document-properties/delete_documentproperties","metadata":{"seo":{"title":"Delete document properties","description":"Note: This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support."}},"httpPath":"/v1/document-properties/{documentPropertiesId}"}]},{"type":"group","label":"Entities","link":"/v1-api-reference/older-api/entities","routeSlug":"/v1-api-reference/older-api/entities","items":[{"label":"Multi-entity: Create an entity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/entities/post_entities","routeSlug":"/v1-api-reference/older-api/entities/post_entities","metadata":{"seo":{"title":"Multi-entity: Create an entity","description":"Creates an entity in a multi-entity hierarchy."}},"httpPath":"/v1/entities"},{"label":"Multi-entity: List entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/entities/get_entities","routeSlug":"/v1-api-reference/older-api/entities/get_entities","metadata":{"seo":{"title":"Multi-entity: List entities","description":"Retrieves detailed information of certain entities in a multi-entity hierarchy."}},"httpPath":"/v1/entities"},{"label":"Multi-entity: Update an entity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/entities/put_entities","routeSlug":"/v1-api-reference/older-api/entities/put_entities","metadata":{"seo":{"title":"Multi-entity: Update an entity","description":"Edits the following information about an unprovisioned entity:"}},"httpPath":"/v1/entities/{id}"},{"label":"Multi-entity: Retrieve an entity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/entities/get_entitybyid","routeSlug":"/v1-api-reference/older-api/entities/get_entitybyid","metadata":{"seo":{"title":"Multi-entity: Retrieve an entity","description":"Retrieves detailed information about a specified entity."}},"httpPath":"/v1/entities/{id}"},{"label":"Multi-entity: Delete an entity","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/entities/delete_entities","routeSlug":"/v1-api-reference/older-api/entities/delete_entities","metadata":{"seo":{"title":"Multi-entity: Delete an entity","description":"Removes an entity and its sub-entities from a multi-entity hierarchy. You can only remove unprovisioned entities. An error occurred when you remove a provisioned entity."}},"httpPath":"/v1/entities/{id}"},{"label":"Multi-entity: Provision an entity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/entities/put_provisionentity","routeSlug":"/v1-api-reference/older-api/entities/put_provisionentity","metadata":{"seo":{"title":"Multi-entity: Provision an entity","description":"Provisions an entity. You can only provision an entity if its parent entity is provisioned."}},"httpPath":"/v1/entities/{id}/provision"}]},{"type":"group","label":"Entity Connections","link":"/v1-api-reference/older-api/entity-connections","routeSlug":"/v1-api-reference/older-api/entity-connections","items":[{"label":"Multi-entity: List connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/entity-connections/get_entityconnections","routeSlug":"/v1-api-reference/older-api/entity-connections/get_entityconnections","metadata":{"seo":{"title":"Multi-entity: List connections","description":"Retrieves information about certain connections for a specified entity. You can specify the entity to retrieve in the Zuora-Entity-Ids request header."}},"httpPath":"/v1/entity-connections"},{"label":"Multi-entity: Initiate a connection request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/entity-connections/post_entityconnections","routeSlug":"/v1-api-reference/older-api/entity-connections/post_entityconnections","metadata":{"seo":{"title":"Multi-entity: Initiate a connection request","description":"Initiates a connection request from a source entity to a target entity."}},"httpPath":"/v1/entity-connections"},{"label":"Multi-entity: Accept a connection request","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/entity-connections/put_entityconnectionsaccept","routeSlug":"/v1-api-reference/older-api/entity-connections/put_entityconnectionsaccept","metadata":{"seo":{"title":"Multi-entity: Accept a connection request","description":"Accepts a connection request."}},"httpPath":"/v1/entity-connections/{connection-id}/accept"},{"label":"Multi-entity: Deny a connection request","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/entity-connections/put_entityconnectionsdeny","routeSlug":"/v1-api-reference/older-api/entity-connections/put_entityconnectionsdeny","metadata":{"seo":{"title":"Multi-entity: Deny a connection request","description":"Denies a connection request."}},"httpPath":"/v1/entity-connections/{connection-id}/deny"},{"label":"Multi-entity: Disconnect a connection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/entity-connections/put_entityconnectionsdisconnect","routeSlug":"/v1-api-reference/older-api/entity-connections/put_entityconnectionsdisconnect","metadata":{"seo":{"title":"Multi-entity: Disconnect a connection","description":"Disconnects an established connection. If you have shared objects from a global entity to a target entity, disconnecting the connection will break the mapping relationship between these entities and cannot be recovered later."}},"httpPath":"/v1/entity-connections/{connection-id}/disconnect"}]},{"type":"group","label":"Exports","link":"/v1-api-reference/older-api/exports","routeSlug":"/v1-api-reference/older-api/exports","items":[{"label":"CRUD: Create an export","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/exports/object_postexport","routeSlug":"/v1-api-reference/older-api/exports/object_postexport","metadata":{"seo":{"title":"CRUD: Create an export","description":"Use this operation to create a data source export. After you have created a data source export, use CRUD: Retrieve an export to check the status of the data source export and access the exported data."}},"httpPath":"/v1/object/export"},{"label":"CRUD: Retrieve an export","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/exports/object_getexport","routeSlug":"/v1-api-reference/older-api/exports/object_getexport","metadata":{"seo":{"title":"CRUD: Retrieve an export","description":"Use this operation to check the status of a data source export and access the exported data."}},"httpPath":"/v1/object/export/{id}"}]},{"type":"group","label":"Features","link":"/v1-api-reference/older-api/features","routeSlug":"/v1-api-reference/older-api/features","items":[{"label":"CRUD: Create a feature","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/features/object_postfeature","routeSlug":"/v1-api-reference/older-api/features/object_postfeature","metadata":{"seo":{"title":"CRUD: Create a feature","description":"CRUD: Create a feature"}},"httpPath":"/v1/object/feature"},{"label":"CRUD: Retrieve a feature","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/features/object_getfeature","routeSlug":"/v1-api-reference/older-api/features/object_getfeature","metadata":{"seo":{"title":"CRUD: Retrieve a feature","description":"CRUD: Retrieve a feature"}},"httpPath":"/v1/object/feature/{id}"},{"label":"CRUD: Update a feature","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/features/object_putfeature","routeSlug":"/v1-api-reference/older-api/features/object_putfeature","metadata":{"seo":{"title":"CRUD: Update a feature","description":"CRUD: Update a feature"}},"httpPath":"/v1/object/feature/{id}"},{"label":"CRUD: Delete a feature","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/features/object_deletefeature","routeSlug":"/v1-api-reference/older-api/features/object_deletefeature","metadata":{"seo":{"title":"CRUD: Delete a feature","description":"CRUD: Delete a feature"}},"httpPath":"/v1/object/feature/{id}"}]},{"type":"group","label":"HMAC Signatures","link":"/v1-api-reference/older-api/hmac-signatures","routeSlug":"/v1-api-reference/older-api/hmac-signatures","items":[{"label":"Generate an HMAC signature","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/hmac-signatures/post_hmacsignatures","routeSlug":"/v1-api-reference/older-api/hmac-signatures/post_hmacsignatures","metadata":{"seo":{"title":"Generate an HMAC signature","description":"This REST API reference describes how to return unique signature and token values that used to process a CORS enabled API call."}},"httpPath":"/v1/hmac-signatures"}]},{"type":"group","label":"Invoice Adjustments","link":"/v1-api-reference/older-api/invoice-adjustments","routeSlug":"/v1-api-reference/older-api/invoice-adjustments","items":[{"label":"CRUD: Create an invoice adjustment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoice-adjustments/object_postinvoiceadjustment","routeSlug":"/v1-api-reference/older-api/invoice-adjustments/object_postinvoiceadjustment","metadata":{"seo":{"title":"CRUD: Create an invoice adjustment","description":"CRUD: Create an invoice adjustment"}},"httpPath":"/v1/object/invoice-adjustment"},{"label":"CRUD: Retrieve an invoice adjustment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoice-adjustments/object_getinvoiceadjustment","routeSlug":"/v1-api-reference/older-api/invoice-adjustments/object_getinvoiceadjustment","metadata":{"seo":{"title":"CRUD: Retrieve an invoice adjustment","description":"CRUD: Retrieve an invoice adjustment"}},"httpPath":"/v1/object/invoice-adjustment/{id}"},{"label":"CRUD: Update an invoice adjustment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoice-adjustments/object_putinvoiceadjustment","routeSlug":"/v1-api-reference/older-api/invoice-adjustments/object_putinvoiceadjustment","metadata":{"seo":{"title":"CRUD: Update an invoice adjustment","description":"CRUD: Update an invoice adjustment"}},"httpPath":"/v1/object/invoice-adjustment/{id}"},{"label":"CRUD: Delete an invoice adjustment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoice-adjustments/object_deleteinvoiceadjustment","routeSlug":"/v1-api-reference/older-api/invoice-adjustments/object_deleteinvoiceadjustment","metadata":{"seo":{"title":"CRUD: Delete an invoice adjustment","description":"CRUD: Delete an invoice adjustment"}},"httpPath":"/v1/object/invoice-adjustment/{id}"}]},{"type":"group","label":"Invoice Item Adjustments","link":"/v1-api-reference/older-api/invoice-item-adjustments","routeSlug":"/v1-api-reference/older-api/invoice-item-adjustments","items":[{"label":"CRUD: Create an invoice item adjustment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoice-item-adjustments/object_postinvoiceitemadjustment","routeSlug":"/v1-api-reference/older-api/invoice-item-adjustments/object_postinvoiceitemadjustment","metadata":{"seo":{"title":"CRUD: Create an invoice item adjustment","description":"CRUD: Create an invoice item adjustment"}},"httpPath":"/v1/object/invoice-item-adjustment"},{"label":"CRUD: Retrieve an invoice item adjustment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoice-item-adjustments/object_getinvoiceitemadjustment","routeSlug":"/v1-api-reference/older-api/invoice-item-adjustments/object_getinvoiceitemadjustment","metadata":{"seo":{"title":"CRUD: Retrieve an invoice item adjustment","description":"CRUD: Retrieve an invoice item adjustment"}},"httpPath":"/v1/object/invoice-item-adjustment/{id}"},{"label":"CRUD: Update an invoice item adjustment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoice-item-adjustments/object_putinvoiceitemadjustment","routeSlug":"/v1-api-reference/older-api/invoice-item-adjustments/object_putinvoiceitemadjustment","metadata":{"seo":{"title":"CRUD: Update an invoice item adjustment","description":"CRUD: Update an invoice item adjustment"}},"httpPath":"/v1/object/invoice-item-adjustment/{id}"},{"label":"CRUD: Delete an invoice item adjustment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoice-item-adjustments/object_deleteinvoiceitemadjustment","routeSlug":"/v1-api-reference/older-api/invoice-item-adjustments/object_deleteinvoiceitemadjustment","metadata":{"seo":{"title":"CRUD: Delete an invoice item adjustment","description":"CRUD: Delete an invoice item adjustment"}},"httpPath":"/v1/object/invoice-item-adjustment/{id}"}]},{"type":"group","label":"Invoice Items","link":"/v1-api-reference/older-api/invoice-items","routeSlug":"/v1-api-reference/older-api/invoice-items","items":[{"label":"CRUD: Retrieve an invoice item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoice-items/object_getinvoiceitem","routeSlug":"/v1-api-reference/older-api/invoice-items/object_getinvoiceitem","metadata":{"seo":{"title":"CRUD: Retrieve an invoice item","description":"CRUD: Retrieve an invoice item"}},"httpPath":"/v1/object/invoice-item/{id}"}]},{"type":"group","label":"Invoice Payments","link":"/v1-api-reference/older-api/invoice-payments","routeSlug":"/v1-api-reference/older-api/invoice-payments","items":[{"label":"CRUD: Create an invoice payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoice-payments/object_postinvoicepayment","routeSlug":"/v1-api-reference/older-api/invoice-payments/object_postinvoicepayment","metadata":{"seo":{"title":"CRUD: Create an invoice payment","description":"CRUD: Create an invoice payment"}},"httpPath":"/v1/object/invoice-payment"},{"label":"CRUD: Retrieve an invoice payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoice-payments/object_getinvoicepayment","routeSlug":"/v1-api-reference/older-api/invoice-payments/object_getinvoicepayment","metadata":{"seo":{"title":"CRUD: Retrieve an invoice payment","description":"CRUD: Retrieve an invoice payment"}},"httpPath":"/v1/object/invoice-payment/{id}"},{"label":"CRUD: Update an invoice payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoice-payments/object_putinvoicepayment","routeSlug":"/v1-api-reference/older-api/invoice-payments/object_putinvoicepayment","metadata":{"seo":{"title":"CRUD: Update an invoice payment","description":"CRUD: Update an invoice payment"}},"httpPath":"/v1/object/invoice-payment/{id}"}]},{"type":"group","label":"Invoice Split Items","link":"/v1-api-reference/older-api/invoice-split-items","routeSlug":"/v1-api-reference/older-api/invoice-split-items","items":[{"label":"CRUD: Retrieve an invoice split item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoice-split-items/object_getinvoicesplititem","routeSlug":"/v1-api-reference/older-api/invoice-split-items/object_getinvoicesplititem","metadata":{"seo":{"title":"CRUD: Retrieve an invoice split item","description":"CRUD: Retrieve an invoice split item"}},"httpPath":"/v1/object/invoice-split-item/{id}"}]},{"type":"group","label":"Invoice Splits","link":"/v1-api-reference/older-api/invoice-splits","routeSlug":"/v1-api-reference/older-api/invoice-splits","items":[{"label":"CRUD: Retrieve an invoice split","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoice-splits/object_getinvoicesplit","routeSlug":"/v1-api-reference/older-api/invoice-splits/object_getinvoicesplit","metadata":{"seo":{"title":"CRUD: Retrieve an invoice split","description":"CRUD: Retrieve an invoice split"}},"httpPath":"/v1/object/invoice-split/{id}"}]},{"type":"group","label":"Invoices","link":"/v1-api-reference/older-api/invoices","routeSlug":"/v1-api-reference/older-api/invoices","items":[{"label":"CRUD: Update an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoices/object_putinvoice","routeSlug":"/v1-api-reference/older-api/invoices/object_putinvoice","metadata":{"seo":{"title":"CRUD: Update an invoice","description":"CRUD: Update an invoice"}},"httpPath":"/v1/object/invoice/{id}"},{"label":"CRUD: Retrieve an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoices/object_getinvoice","routeSlug":"/v1-api-reference/older-api/invoices/object_getinvoice","metadata":{"seo":{"title":"CRUD: Retrieve an invoice","description":"CRUD: Retrieve an invoice"}},"httpPath":"/v1/object/invoice/{id}"},{"label":"CRUD: Delete an invoice","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/invoices/object_deleteinvoice","routeSlug":"/v1-api-reference/older-api/invoices/object_deleteinvoice","metadata":{"seo":{"title":"CRUD: Delete an invoice","description":"CRUD: Delete an invoice"}},"httpPath":"/v1/object/invoice/{id}"}]},{"type":"group","label":"Orders","link":"/v1-api-reference/older-api/orders","routeSlug":"/v1-api-reference/older-api/orders","items":[{"label":"List subscription terms","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/orders/get_subscriptionterminfo","routeSlug":"/v1-api-reference/older-api/orders/get_subscriptionterminfo","metadata":{"seo":{"title":"List subscription terms","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"httpPath":"/v1/orders/term/{subscriptionNumber}"},{"label":"List order metrics for an evergreen subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/orders/get_ordermetricsforevergreensubscription","routeSlug":"/v1-api-reference/older-api/orders/get_ordermetricsforevergreensubscription","metadata":{"seo":{"title":"List order metrics for an evergreen subscription","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"httpPath":"/v1/orders/{orderNumber}/evergreenMetrics/{subscriptionNumber}"}]},{"type":"group","label":"Payment Gateway Transaction Logs","link":"/v1-api-reference/older-api/payment-gateway-transaction-logs","routeSlug":"/v1-api-reference/older-api/payment-gateway-transaction-logs","items":[{"label":"Retrieve a payment gateway transaction log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/payment-gateway-transaction-logs/get_paymentgatewaytransactionlog","routeSlug":"/v1-api-reference/older-api/payment-gateway-transaction-logs/get_paymentgatewaytransactionlog","metadata":{"seo":{"title":"Retrieve a payment gateway transaction log","description":"Retrieves transaction log information passed through your custom payment gateway."}},"httpPath":"/v1/payment-gateway-transaction-log/{paymentOrRefundOrPaymentMethod-id}"}]},{"type":"group","label":"Payment Methods","link":"/v1-api-reference/older-api/payment-methods","routeSlug":"/v1-api-reference/older-api/payment-methods","items":[{"label":"Create a credit card payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/payment-methods/post_paymentmethodscreditcard","routeSlug":"/v1-api-reference/older-api/payment-methods/post_paymentmethodscreditcard","metadata":{"seo":{"title":"Create a credit card payment method","description":"Note: This legacy API operation is no longer under active development. For more features, it is strongly recommended to use the Create a payment method operation."}},"httpPath":"/v1/payment-methods/credit-cards"},{"label":"Update a credit card payment method","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/payment-methods/put_paymentmethodscreditcard","routeSlug":"/v1-api-reference/older-api/payment-methods/put_paymentmethodscreditcard","metadata":{"seo":{"title":"Update a credit card payment method","description":"Updates an existing credit card payment method."}},"httpPath":"/v1/payment-methods/credit-cards/{payment-method-id}"},{"label":"List all credit card payment methods of an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/payment-methods/get_paymentmethodscreditcard","routeSlug":"/v1-api-reference/older-api/payment-methods/get_paymentmethodscreditcard","metadata":{"seo":{"title":"List all credit card payment methods of an account","description":"This REST API reference describes how to retrieve all credit cardinformation for the specified customer account."}},"httpPath":"/v1/payment-methods/credit-cards/accounts/{account-key}"},{"label":"CRUD: Create a payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/payment-methods/object_postpaymentmethod","routeSlug":"/v1-api-reference/older-api/payment-methods/object_postpaymentmethod","metadata":{"seo":{"title":"CRUD: Create a payment method","description":"Use this operation to create either a payment method associated with a specific customer account, or an orphan payment method that is not associated with any customer account."}},"httpPath":"/v1/object/payment-method"},{"label":"CRUD: Retrieve a payment method","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/payment-methods/object_getpaymentmethod","routeSlug":"/v1-api-reference/older-api/payment-methods/object_getpaymentmethod","metadata":{"seo":{"title":"CRUD: Retrieve a payment method","description":"CRUD: Retrieve a payment method"}},"httpPath":"/v1/object/payment-method/{id}"},{"label":"CRUD: Update a payment method","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/payment-methods/object_putpaymentmethod","routeSlug":"/v1-api-reference/older-api/payment-methods/object_putpaymentmethod","metadata":{"seo":{"title":"CRUD: Update a payment method","description":"Updates a payment method."}},"httpPath":"/v1/object/payment-method/{id}"},{"label":"CRUD: Delete a payment method","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/payment-methods/object_deletepaymentmethod","routeSlug":"/v1-api-reference/older-api/payment-methods/object_deletepaymentmethod","metadata":{"seo":{"title":"CRUD: Delete a payment method","description":"CRUD: Delete a payment method"}},"httpPath":"/v1/object/payment-method/{id}"}]},{"type":"group","label":"Payments","link":"/v1-api-reference/older-api/payments","routeSlug":"/v1-api-reference/older-api/payments","items":[{"label":"CRUD: Create a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/payments/object_postpayment","routeSlug":"/v1-api-reference/older-api/payments/object_postpayment","metadata":{"seo":{"title":"CRUD: Create a payment","description":"Creates a payment for one or multiple invoices."}},"httpPath":"/v1/object/payment"},{"label":"CRUD: Retrieve a payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/payments/object_getpayment","routeSlug":"/v1-api-reference/older-api/payments/object_getpayment","metadata":{"seo":{"title":"CRUD: Retrieve a payment","description":"Retrieves the information about one specific payment."}},"httpPath":"/v1/object/payment/{id}"},{"label":"CRUD: Update a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/payments/object_putpayment","routeSlug":"/v1-api-reference/older-api/payments/object_putpayment","metadata":{"seo":{"title":"CRUD: Update a payment","description":"Updates a payment."}},"httpPath":"/v1/object/payment/{id}"},{"label":"CRUD: Delete a payment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/payments/object_deletepayment","routeSlug":"/v1-api-reference/older-api/payments/object_deletepayment","metadata":{"seo":{"title":"CRUD: Delete a payment","description":"Deletes a payment. Only payments with the Cancelled status can be deleted."}},"httpPath":"/v1/object/payment/{id}"}]},{"type":"group","label":"Product Features","link":"/v1-api-reference/older-api/product-features","routeSlug":"/v1-api-reference/older-api/product-features","items":[{"label":"CRUD: Retrieve a product feature","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/product-features/object_getproductfeature","routeSlug":"/v1-api-reference/older-api/product-features/object_getproductfeature","metadata":{"seo":{"title":"CRUD: Retrieve a product feature","description":"CRUD: Retrieve a product feature"}},"httpPath":"/v1/object/product-feature/{id}"},{"label":"CRUD: Delete a product feature","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/product-features/object_deleteproductfeature","routeSlug":"/v1-api-reference/older-api/product-features/object_deleteproductfeature","metadata":{"seo":{"title":"CRUD: Delete a product feature","description":"CRUD: Delete a product feature"}},"httpPath":"/v1/object/product-feature/{id}"}]},{"type":"group","label":"Quotes Document","link":"/v1-api-reference/older-api/quotes-document","routeSlug":"/v1-api-reference/older-api/quotes-document","items":[{"label":"Generate a quote document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/quotes-document/post_quotesdocument","routeSlug":"/v1-api-reference/older-api/quotes-document/post_quotesdocument","metadata":{"seo":{"title":"Generate a quote document","description":"The document call generates a quote document and returns the generated document URL. You can directly access the generated quote file through the returned URL."}},"httpPath":"/v1/quotes/document"}]},{"type":"group","label":"Rate Plan Charge Tiers","link":"/v1-api-reference/older-api/rate-plan-charge-tiers","routeSlug":"/v1-api-reference/older-api/rate-plan-charge-tiers","items":[{"label":"CRUD: Retrieve a rate plan charge tier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/rate-plan-charge-tiers/object_getrateplanchargetier","routeSlug":"/v1-api-reference/older-api/rate-plan-charge-tiers/object_getrateplanchargetier","metadata":{"seo":{"title":"CRUD: Retrieve a rate plan charge tier","description":"CRUD: Retrieve a rate plan charge tier"}},"httpPath":"/v1/object/rate-plan-charge-tier/{id}"}]},{"type":"group","label":"Rate Plan Charges","link":"/v1-api-reference/older-api/rate-plan-charges","routeSlug":"/v1-api-reference/older-api/rate-plan-charges","items":[{"label":"CRUD: Retrieve a rate plan charge","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/rate-plan-charges/object_getrateplancharge","routeSlug":"/v1-api-reference/older-api/rate-plan-charges/object_getrateplancharge","metadata":{"seo":{"title":"CRUD: Retrieve a rate plan charge","description":"CRUD: Retrieve a rate plan charge"}},"httpPath":"/v1/object/rate-plan-charge/{id}"},{"label":"CRUD: Update a rate plan charge","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/rate-plan-charges/object_putrateplancharge","routeSlug":"/v1-api-reference/older-api/rate-plan-charges/object_putrateplancharge","metadata":{"seo":{"title":"CRUD: Update a rate plan charge","description":"CRUD: Update a rate plan charge"}},"httpPath":"/v1/object/rate-plan-charge/{id}"}]},{"type":"group","label":"Rate Plans","link":"/v1-api-reference/older-api/rate-plans","routeSlug":"/v1-api-reference/older-api/rate-plans","items":[{"label":"CRUD: Retrieve a rate plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/rate-plans/object_getrateplan","routeSlug":"/v1-api-reference/older-api/rate-plans/object_getrateplan","metadata":{"seo":{"title":"CRUD: Retrieve a rate plan","description":"CRUD: Retrieve a rate plan"}},"httpPath":"/v1/object/rate-plan/{id}"}]},{"type":"group","label":"Refund Invoice Payments","link":"/v1-api-reference/older-api/refund-invoice-payments","routeSlug":"/v1-api-reference/older-api/refund-invoice-payments","items":[{"label":"CRUD: Retrieve a refund invoice payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/refund-invoice-payments/object_getrefundinvoicepayment","routeSlug":"/v1-api-reference/older-api/refund-invoice-payments/object_getrefundinvoicepayment","metadata":{"seo":{"title":"CRUD: Retrieve a refund invoice payment","description":"CRUD: Retrieve a refund invoice payment"}},"httpPath":"/v1/object/refund-invoice-payment/{id}"}]},{"type":"group","label":"Refund Transaction Logs","link":"/v1-api-reference/older-api/refund-transaction-logs","routeSlug":"/v1-api-reference/older-api/refund-transaction-logs","items":[{"label":"CRUD: Retrieve a refund transaction log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/refund-transaction-logs/object_getrefundtransactionlog","routeSlug":"/v1-api-reference/older-api/refund-transaction-logs/object_getrefundtransactionlog","metadata":{"seo":{"title":"CRUD: Retrieve a refund transaction log","description":"CRUD: Retrieve a refund transaction log"}},"httpPath":"/v1/object/refund-transaction-log/{id}"}]},{"type":"group","label":"Refunds","link":"/v1-api-reference/older-api/refunds","routeSlug":"/v1-api-reference/older-api/refunds","items":[{"label":"CRUD: Create a refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/refunds/object_postrefund","routeSlug":"/v1-api-reference/older-api/refunds/object_postrefund","metadata":{"seo":{"title":"CRUD: Create a refund","description":"Creates a refund."}},"httpPath":"/v1/object/refund"},{"label":"CRUD: Retrieve a refund","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/refunds/object_getrefund","routeSlug":"/v1-api-reference/older-api/refunds/object_getrefund","metadata":{"seo":{"title":"CRUD: Retrieve a refund","description":"CRUD: Retrieve a refund"}},"httpPath":"/v1/object/refund/{id}"},{"label":"CRUD: Update a refund","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/refunds/object_putrefund","routeSlug":"/v1-api-reference/older-api/refunds/object_putrefund","metadata":{"seo":{"title":"CRUD: Update a refund","description":"CRUD: Update a refund"}},"httpPath":"/v1/object/refund/{id}"},{"label":"CRUD: Delete a refund","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/refunds/object_deleterefund","routeSlug":"/v1-api-reference/older-api/refunds/object_deleterefund","metadata":{"seo":{"title":"CRUD: Delete a refund","description":"CRUD: Delete a refund"}},"httpPath":"/v1/object/refund/{id}"}]},{"type":"group","label":"Reporting","link":"/v1-api-reference/older-api/reporting","routeSlug":"/v1-api-reference/older-api/reporting","items":[{"label":"Retrieve a report run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/reporting/get_reportrun","routeSlug":"/v1-api-reference/older-api/reporting/get_reportrun","metadata":{"seo":{"title":"Retrieve a report run","description":"Retrieves details of the specific report run."}},"httpPath":"/reporting/api/rest/v1/reportruns/{reportRunId}"},{"label":"Cancel a report run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/reporting/delete_reportrun","routeSlug":"/v1-api-reference/older-api/reporting/delete_reportrun","metadata":{"seo":{"title":"Cancel a report run","description":"Stops the specified report run."}},"httpPath":"/reporting/api/rest/v1/reportruns/{reportRunId}"},{"label":"Run a report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/reporting/post_reportrun","routeSlug":"/v1-api-reference/older-api/reporting/post_reportrun","metadata":{"seo":{"title":"Run a report","description":"Starts a new report run and returns the ID of the report run."}},"httpPath":"/reporting/api/rest/v1/reports/{ReportId}/reportrun"},{"label":"Search reports by name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/reporting/get_reportsbyname","routeSlug":"/v1-api-reference/older-api/reporting/get_reportsbyname","metadata":{"seo":{"title":"Search reports by name","description":"Retrieves all reports that match a query based on the report name, description, or data source name."}},"httpPath":"/reporting/api/rest/v1/reports/search"},{"label":"Retrieve the last completed report run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/reporting/get_latestreportrun","routeSlug":"/v1-api-reference/older-api/reporting/get_latestreportrun","metadata":{"seo":{"title":"Retrieve the last completed report run","description":"Retieves the ID of the last completed run of a report by the current user in the last 60 days."}},"httpPath":"/reporting/api/rest/v1/reports/{reportId}/reportruns/latest"},{"label":"Retrieve report data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/reporting/get_reportdata","routeSlug":"/v1-api-reference/older-api/reporting/get_reportdata","metadata":{"seo":{"title":"Retrieve report data","description":"Returns the report run results for the specified report run."}},"httpPath":"/reporting/api/rest/v1/reportruns/reportdata/{ReportRunId}"},{"label":"Export results of a report run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/reporting/get_exportreportrun","routeSlug":"/v1-api-reference/older-api/reporting/get_exportreportrun","metadata":{"seo":{"title":"Export results of a report run","description":"Retrieves report run results as comma separated values."}},"httpPath":"/reporting/api/rest/v1/reportruns/export/{ReportRunId}"},{"label":"Transfer report ownership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/reporting/transferreportownership","routeSlug":"/v1-api-reference/older-api/reporting/transferreportownership","metadata":{"seo":{"title":"Transfer report ownership","description":"Transfers ownership of one or more reports to a different user."}},"httpPath":"/reporting/api/rest/v1/reports/transfer-ownership"}]},{"type":"group","label":"Revenue Events","link":"/v1-api-reference/older-api/revenue-events","routeSlug":"/v1-api-reference/older-api/revenue-events","items":[{"label":"Retrieve a revenue event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-events/get_revenueeventdetails","routeSlug":"/v1-api-reference/older-api/revenue-events/get_revenueeventdetails","metadata":{"seo":{"title":"Retrieve a revenue event","description":"This REST API reference describes how to get revenue event details by specifying the revenue event number. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/revenue-events/{event-number}"},{"label":"List all revenue events of a revenue schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-events/get_revenueeventforrevenueschedule","routeSlug":"/v1-api-reference/older-api/revenue-events/get_revenueeventforrevenueschedule","metadata":{"seo":{"title":"List all revenue events of a revenue schedule","description":"This REST API reference describes how to get all revenue events in a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/revenue-events/revenue-schedules/{rs-number}"}]},{"type":"group","label":"Revenue Items","link":"/v1-api-reference/older-api/revenue-items","routeSlug":"/v1-api-reference/older-api/revenue-items","items":[{"label":"List revenue items by charge revenue summary number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-items/get_revenueitemsbychargerevenuesummarynumber","routeSlug":"/v1-api-reference/older-api/revenue-items/get_revenueitemsbychargerevenuesummarynumber","metadata":{"seo":{"title":"List revenue items by charge revenue summary number","description":"This REST API reference describes how to get the details for each revenue item in a charge revenue summary by specifying the charge revenue summary number. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/revenue-items/charge-revenue-summaries/{crs-number}"},{"label":"List revenue items by revenue event number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-items/get_revenueitemsbychargerevenueeventnumber","routeSlug":"/v1-api-reference/older-api/revenue-items/get_revenueitemsbychargerevenueeventnumber","metadata":{"seo":{"title":"List revenue items by revenue event number","description":"This REST API reference describes how to get the details of each revenue item in a revenue event by specifying the revenue event number. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/revenue-items/revenue-events/{event-number}"},{"label":"Update custom fields on revenue items by revenue event number","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-items/put_customfieldsonrevenueitemsbyrevenueevent","routeSlug":"/v1-api-reference/older-api/revenue-items/put_customfieldsonrevenueitemsbyrevenueevent","metadata":{"seo":{"title":"Update custom fields on revenue items by revenue event number","description":"This REST API reference describes how to update custom fields on revenue items by specifying the revenue event number. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/revenue-items/revenue-events/{event-number}"},{"label":"List all revenue items of a revenue schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-items/get_revenueitemsbyrevenueschedule","routeSlug":"/v1-api-reference/older-api/revenue-items/get_revenueitemsbyrevenueschedule","metadata":{"seo":{"title":"List all revenue items of a revenue schedule","description":"This REST API reference describes how to get the details for each revenue items in a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/revenue-items/revenue-schedules/{rs-number}"},{"label":"Update custom fields on revenue items by revenue schedule number","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-items/put_customfieldsonrevenueitemsbyrevenueschedule","routeSlug":"/v1-api-reference/older-api/revenue-items/put_customfieldsonrevenueitemsbyrevenueschedule","metadata":{"seo":{"title":"Update custom fields on revenue items by revenue schedule number","description":"This REST API reference describes how to update custom fields on revenue Items by specifying the revenue schedule number. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/revenue-items/revenue-schedules/{rs-number}"}]},{"type":"group","label":"Revenue Rules","link":"/v1-api-reference/older-api/revenue-rules","routeSlug":"/v1-api-reference/older-api/revenue-rules","items":[{"label":"Retrieve a revenue recognition rule by product rate plan charge ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-rules/get_revenuerecrulebyproductrateplancharge","routeSlug":"/v1-api-reference/older-api/revenue-rules/get_revenuerecrulebyproductrateplancharge","metadata":{"seo":{"title":"Retrieve a revenue recognition rule by product rate plan charge ID","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/revenue-recognition-rules/product-charges/{charge-key}"},{"label":"Retrieve a revenue recognition rule by subscription charge ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-rules/get_revenuerecrules","routeSlug":"/v1-api-reference/older-api/revenue-rules/get_revenuerecrules","metadata":{"seo":{"title":"Retrieve a revenue recognition rule by subscription charge ID","description":"Retrieves the revenue recognition rule associated with a subscription charge by specifying the charge ID. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/revenue-recognition-rules/subscription-charges/{charge-key}"},{"label":"Retrieve a revenue automation start date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-rules/get_revenueautomationstartdate","routeSlug":"/v1-api-reference/older-api/revenue-rules/get_revenueautomationstartdate","metadata":{"seo":{"title":"Retrieve a revenue automation start date","description":"Describes how to get the revenue automation start date. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/settings/finance/revenue-automation-start-date"}]},{"type":"group","label":"Revenue Schedules","link":"/v1-api-reference/older-api/revenue-schedules","routeSlug":"/v1-api-reference/older-api/revenue-schedules","items":[{"label":"Create a revenue schedule for a credit memo item (manual distribution)\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/post_rsforcreditmemoitem_manualdistribution","routeSlug":"/v1-api-reference/older-api/revenue-schedules/post_rsforcreditmemoitem_manualdistribution","metadata":{"seo":{"title":"Create a revenue schedule for a credit memo item (manual distribution)\n","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/revenue-schedules/credit-memo-items/{cmi-id}"},{"label":"Retrieve a revenue schedule by credit memo item ID\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/get_rsbycreditmemoitem","routeSlug":"/v1-api-reference/older-api/revenue-schedules/get_rsbycreditmemoitem","metadata":{"seo":{"title":"Retrieve a revenue schedule by credit memo item ID\n","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/revenue-schedules/credit-memo-items/{cmi-id}"},{"label":"Create a revenue schedule for a credit memo item (distribute by date range)\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/post_rsforcreditmemoitem_distributebydaterange","routeSlug":"/v1-api-reference/older-api/revenue-schedules/post_rsforcreditmemoitem_distributebydaterange","metadata":{"seo":{"title":"Create a revenue schedule for a credit memo item (distribute by date range)\n","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/revenue-schedules/credit-memo-items/{cmi-id}/distribute-revenue-with-date-range"},{"label":"Create a revenue schedule for a debit memo item (manual distribution)\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/post_rsfordebitmemoitem_manualdistribution","routeSlug":"/v1-api-reference/older-api/revenue-schedules/post_rsfordebitmemoitem_manualdistribution","metadata":{"seo":{"title":"Create a revenue schedule for a debit memo item (manual distribution)\n","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/revenue-schedules/debit-memo-items/{dmi-id}"},{"label":"Retrieve a revenue schedule by debit memo item ID\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/get_rsbydebitmemoitem","routeSlug":"/v1-api-reference/older-api/revenue-schedules/get_rsbydebitmemoitem","metadata":{"seo":{"title":"Retrieve a revenue schedule by debit memo item ID\n","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/revenue-schedules/debit-memo-items/{dmi-id}"},{"label":"Create a revenue schedule for a debit memo item (distribute by date range)\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/post_rsfordebitmemoitem_distributebydaterange","routeSlug":"/v1-api-reference/older-api/revenue-schedules/post_rsfordebitmemoitem_distributebydaterange","metadata":{"seo":{"title":"Create a revenue schedule for a debit memo item (distribute by date range)\n","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/revenue-schedules/debit-memo-items/{dmi-id}/distribute-revenue-with-date-range"},{"label":"Retrieve a revenue schedule by invoice item adjustment key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/get_rsbyinvoiceitemadjustment","routeSlug":"/v1-api-reference/older-api/revenue-schedules/get_rsbyinvoiceitemadjustment","metadata":{"seo":{"title":"Retrieve a revenue schedule by invoice item adjustment key","description":"Retrieves the details of a revenue schedule by specifying a valid invoice item adjustment identifier. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key}"},{"label":"Create a revenue schedule for an invoice item adjustment (manual distribution)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/post_rsforinvoiceitemadjustment_manualdistribution","routeSlug":"/v1-api-reference/older-api/revenue-schedules/post_rsforinvoiceitemadjustment_manualdistribution","metadata":{"seo":{"title":"Create a revenue schedule for an invoice item adjustment (manual distribution)","description":"Creates a revenue schedule for an Invoice Item Adjustment and manually distribute the revenue."}},"httpPath":"/v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key}"},{"label":"Create a revenue schedule for an invoice item adjustment (distribute by date range)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/post_rsforinvoiceitemadjustment_distributebydaterange","routeSlug":"/v1-api-reference/older-api/revenue-schedules/post_rsforinvoiceitemadjustment_distributebydaterange","metadata":{"seo":{"title":"Create a revenue schedule for an invoice item adjustment (distribute by date range)","description":"Creates a revenue schedule for an Invoice Item Adjustment and distribute the revenue by specifying the recognition start and end dates."}},"httpPath":"/v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key}/distribute-revenue-with-date-range"},{"label":"Create a revenue schedule for an invoice item (manual distribution)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/post_rsforinvoiceitem_manualdistribution","routeSlug":"/v1-api-reference/older-api/revenue-schedules/post_rsforinvoiceitem_manualdistribution","metadata":{"seo":{"title":"Create a revenue schedule for an invoice item (manual distribution)","description":"Creates a revenue schedule for an Invoice Item and manually distribute the revenue."}},"httpPath":"/v1/revenue-schedules/invoice-items/{invoice-item-id}"},{"label":"Retrieve a revenue schedule by invoice item ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/get_rsbyinvoiceitem","routeSlug":"/v1-api-reference/older-api/revenue-schedules/get_rsbyinvoiceitem","metadata":{"seo":{"title":"Retrieve a revenue schedule by invoice item ID","description":"Retrieves the details of a revenue schedule by specifying the invoice item ID."}},"httpPath":"/v1/revenue-schedules/invoice-items/{invoice-item-id}"},{"label":"Create a revenue schedule for an invoice item (distribute by date range)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/post_rsforinvoiceitem_distributebydaterange","routeSlug":"/v1-api-reference/older-api/revenue-schedules/post_rsforinvoiceitem_distributebydaterange","metadata":{"seo":{"title":"Create a revenue schedule for an invoice item (distribute by date range)","description":"Creates a revenue schedule for an Invoice Item and distribute the revenue by specifying the recognition start and end dates."}},"httpPath":"/v1/revenue-schedules/invoice-items/{invoice-item-id}/distribute-revenue-with-date-range"},{"label":"List revenue schedules of a product charge by charge ID and account key\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/get_rsbyproductchargeandbillingaccount","routeSlug":"/v1-api-reference/older-api/revenue-schedules/get_rsbyproductchargeandbillingaccount","metadata":{"seo":{"title":"List revenue schedules of a product charge by charge ID and account key\n","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"httpPath":"/v1/revenue-schedules/product-charges/{charge-key}/{account-key}"},{"label":"List all details of a revenue schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/get_rs","routeSlug":"/v1-api-reference/older-api/revenue-schedules/get_rs","metadata":{"seo":{"title":"List all details of a revenue schedule","description":"Retrieves the details of a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/revenue-schedules/{rs-number}"},{"label":"Delete a revenue schedule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/delete_rs","routeSlug":"/v1-api-reference/older-api/revenue-schedules/delete_rs","metadata":{"seo":{"title":"Delete a revenue schedule","description":"Deletes a revenue schedule by specifying its revenue schedule number"}},"httpPath":"/v1/revenue-schedules/{rs-number}"},{"label":"Update a revenue schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/put_rsbasicinfo","routeSlug":"/v1-api-reference/older-api/revenue-schedules/put_rsbasicinfo","metadata":{"seo":{"title":"Update a revenue schedule","description":"Retrieves basic information of a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/revenue-schedules/{rs-number}/basic-information"},{"label":"Distribute revenue across accounting periods","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/put_revenueacrossap","routeSlug":"/v1-api-reference/older-api/revenue-schedules/put_revenueacrossap","metadata":{"seo":{"title":"Distribute revenue across accounting periods","description":"Distributes revenue by specifying the revenue schedule number. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/revenue-schedules/{rs-number}/distribute-revenue-across-accounting-periods"},{"label":"Distribute revenue on a specific date","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/put_revenuespecificdate","routeSlug":"/v1-api-reference/older-api/revenue-schedules/put_revenuespecificdate","metadata":{"seo":{"title":"Distribute revenue on a specific date","description":"Distributes revenue on a specific recognition date. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/revenue-schedules/{rs-number}/distribute-revenue-on-specific-date"},{"label":"Distribute revenue in a recognition period","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/put_revenuebyrecognitionstartandenddates","routeSlug":"/v1-api-reference/older-api/revenue-schedules/put_revenuebyrecognitionstartandenddates","metadata":{"seo":{"title":"Distribute revenue in a recognition period","description":"Distributes revenue by specifying the recognition start and end dates. Request and response field descriptions and sample code are provided."}},"httpPath":"/v1/revenue-schedules/{rs-number}/distribute-revenue-with-date-range"},{"label":"Create a revenue schedule by subscription charge key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/post_rsforsubsccharge","routeSlug":"/v1-api-reference/older-api/revenue-schedules/post_rsforsubsccharge","metadata":{"seo":{"title":"Create a revenue schedule by subscription charge key","description":"Creates a revenue schedule by specifying the subscription charge. This method is for custom unlimited revenue recognition only."}},"httpPath":"/v1/revenue-schedules/subscription-charges/{charge-key}"},{"label":"List revenue schedules by subscription charge key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/revenue-schedules/get_rsforsubsccharge","routeSlug":"/v1-api-reference/older-api/revenue-schedules/get_rsforsubsccharge","metadata":{"seo":{"title":"List revenue schedules by subscription charge key","description":"Retrieves the revenue schedule details by specifying subscription charge ID. Request and response field descriptions and sample code are provided"}},"httpPath":"/v1/revenue-schedules/subscription-charges/{charge-key}"}]},{"type":"group","label":"Subscription Product Features","link":"/v1-api-reference/older-api/subscription-product-features","routeSlug":"/v1-api-reference/older-api/subscription-product-features","items":[{"label":"CRUD: Retrieve a subscription product feature","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/subscription-product-features/object_getsubscriptionproductfeature","routeSlug":"/v1-api-reference/older-api/subscription-product-features/object_getsubscriptionproductfeature","metadata":{"seo":{"title":"CRUD: Retrieve a subscription product feature","description":"CRUD: Retrieve a subscription product feature"}},"httpPath":"/v1/object/subscription-product-feature/{id}"}]},{"type":"group","label":"Subscriptions","link":"/v1-api-reference/older-api/subscriptions","routeSlug":"/v1-api-reference/older-api/subscriptions","items":[{"label":"CRUD: Retrieve a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/subscriptions/object_getsubscription","routeSlug":"/v1-api-reference/older-api/subscriptions/object_getsubscription","metadata":{"seo":{"title":"CRUD: Retrieve a subscription","description":"CRUD: Retrieve a subscription"}},"httpPath":"/v1/object/subscription/{id}"},{"label":"CRUD: Update a subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/subscriptions/object_putsubscription","routeSlug":"/v1-api-reference/older-api/subscriptions/object_putsubscription","metadata":{"seo":{"title":"CRUD: Update a subscription","description":"CRUD: Update a subscription"}},"httpPath":"/v1/object/subscription/{id}"},{"label":"CRUD: Delete a subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/subscriptions/object_deletesubscription","routeSlug":"/v1-api-reference/older-api/subscriptions/object_deletesubscription","metadata":{"seo":{"title":"CRUD: Delete a subscription","description":"CRUD: Delete a subscription"}},"httpPath":"/v1/object/subscription/{id}"}]},{"type":"group","label":"Taxation Items","link":"/v1-api-reference/older-api/taxation-items","routeSlug":"/v1-api-reference/older-api/taxation-items","items":[{"label":"CRUD: Retrieve a taxation item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/taxation-items/object_gettaxationitem","routeSlug":"/v1-api-reference/older-api/taxation-items/object_gettaxationitem","metadata":{"seo":{"title":"CRUD: Retrieve a taxation item","description":"CRUD: Retrieve a taxation item"}},"httpPath":"/v1/object/taxation-item/{id}"},{"label":"CRUD: Update a taxation item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/taxation-items/object_puttaxationitem","routeSlug":"/v1-api-reference/older-api/taxation-items/object_puttaxationitem","metadata":{"seo":{"title":"CRUD: Update a taxation item","description":"CRUD: Update a taxation item"}},"httpPath":"/v1/object/taxation-item/{id}"},{"label":"CRUD: Delete a taxation item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/taxation-items/object_deletetaxationitem","routeSlug":"/v1-api-reference/older-api/taxation-items/object_deletetaxationitem","metadata":{"seo":{"title":"CRUD: Delete a taxation item","description":"CRUD: Delete a taxation item"}},"httpPath":"/v1/object/taxation-item/{id}"}]},{"type":"group","label":"Transactions","link":"/v1-api-reference/older-api/transactions","routeSlug":"/v1-api-reference/older-api/transactions","items":[{"label":"List all invoices for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/transactions/get_transactioninvoice","routeSlug":"/v1-api-reference/older-api/transactions/get_transactioninvoice","metadata":{"seo":{"title":"List all invoices for an account","description":"Retrieves invoices for a specified account.Invoices are returned in reverse chronological order by updatedDate."}},"httpPath":"/v1/transactions/invoices/accounts/{account-key}"},{"label":"List all payments for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/transactions/get_transactionpayment","routeSlug":"/v1-api-reference/older-api/transactions/get_transactionpayment","metadata":{"seo":{"title":"List all payments for an account","description":"Retrieves payments for a specified account. Payments are returned inreverse chronological order by updatedDate."}},"httpPath":"/v1/transactions/payments/accounts/{account-key}"}]},{"type":"group","label":"Unit Of Measure","link":"/v1-api-reference/older-api/unit-of-measure","routeSlug":"/v1-api-reference/older-api/unit-of-measure","items":[{"label":"CRUD: Create a unit of measure","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/unit-of-measure/object_postunitofmeasure","routeSlug":"/v1-api-reference/older-api/unit-of-measure/object_postunitofmeasure","metadata":{"seo":{"title":"CRUD: Create a unit of measure","description":"CRUD: Create a unit of measure"}},"httpPath":"/v1/object/unit-of-measure"},{"label":"CRUD: Retrieve a unit of measure","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/unit-of-measure/object_getunitofmeasure","routeSlug":"/v1-api-reference/older-api/unit-of-measure/object_getunitofmeasure","metadata":{"seo":{"title":"CRUD: Retrieve a unit of measure","description":"CRUD: Retrieve a unit of measure"}},"httpPath":"/v1/object/unit-of-measure/{id}"},{"label":"CRUD: Update a unit of measure","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/unit-of-measure/object_putunitofmeasure","routeSlug":"/v1-api-reference/older-api/unit-of-measure/object_putunitofmeasure","metadata":{"seo":{"title":"CRUD: Update a unit of measure","description":"CRUD: Update a unit of measure"}},"httpPath":"/v1/object/unit-of-measure/{id}"},{"label":"CRUD: Delete a unit of measure","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/unit-of-measure/object_deleteunitofmeasure","routeSlug":"/v1-api-reference/older-api/unit-of-measure/object_deleteunitofmeasure","metadata":{"seo":{"title":"CRUD: Delete a unit of measure","description":"CRUD: Delete a unit of measure"}},"httpPath":"/v1/object/unit-of-measure/{id}"}]},{"type":"group","label":"Usage","link":"/v1-api-reference/older-api/usage","routeSlug":"/v1-api-reference/older-api/usage","items":[{"label":"Retrieve a usage record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/usage/get_usage","routeSlug":"/v1-api-reference/older-api/usage/get_usage","metadata":{"seo":{"title":"Retrieve a usage record","description":"Describes how to retrieve usage details for an account. Usage data is returned in reverse chronological order."}},"httpPath":"/v1/usage/accounts/{account-key}"}]},{"type":"group","label":"Users","link":"/v1-api-reference/older-api/users","routeSlug":"/v1-api-reference/older-api/users","items":[{"label":"Multi-entity: Send user access requests","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/users/put_senduseraccessrequests","routeSlug":"/v1-api-reference/older-api/users/put_senduseraccessrequests","metadata":{"seo":{"title":"Multi-entity: Send user access requests","description":"Sends access requests to the entities that a user wants to access."}},"httpPath":"/v1/users/{username}/request-access"},{"label":"Multi-entity: Accept user access","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/users/put_acceptuseraccess","routeSlug":"/v1-api-reference/older-api/users/put_acceptuseraccess","metadata":{"seo":{"title":"Multi-entity: Accept user access","description":"Accepts user access to an entity."}},"httpPath":"/v1/users/{username}/accept-access"},{"label":"Multi-entity: Deny user access","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/users/put_denyuseraccess","routeSlug":"/v1-api-reference/older-api/users/put_denyuseraccess","metadata":{"seo":{"title":"Multi-entity: Deny user access","description":"Denies a user access to an entity."}},"httpPath":"/v1/users/{username}/deny-access"},{"label":"Multi-entity: List all entities that a user can access","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/older-api/users/get_entitiesuseraccessible","routeSlug":"/v1-api-reference/older-api/users/get_entitiesuseraccessible","metadata":{"seo":{"title":"Multi-entity: List all entities that a user can access","description":"Retrieves detailed information about all the entities that a user has permission to access."}},"httpPath":"/v1/users/{username}/accessible-entities"}]}]}]}