{ "opencollection": "1.0.0", "info": { "name": "API Reference", "version": "2023-12-15" }, "items": [ { "info": { "name": "Accounting Codes", "type": "folder" }, "items": [ { "info": { "name": "List all accounting codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/accounting-codes", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" } ] }, "docs": "This reference describes how to query all accounting codes in your chart of accounts through the REST API." }, { "info": { "name": "Create an accounting code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/accounting-codes", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "This reference describes how to create a new accounting code through the REST API. \nThe accounting code will be active as soon as it has been created.\n\n### Prerequisites\n If you have Zuora Finance enabled on your tenant, you must have the Configure Accounting Codes permission. \n" }, { "info": { "name": "Activate an accounting code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/accounting-codes/:ac-id/activate", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ac-id", "value": "", "type": "path", "description": "ID of the accounting code you want to activate." } ] }, "docs": "This reference describes how to activate an accounting code through the REST API.\n\nPrerequisites\n-------------\nIf you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission. \n" }, { "info": { "name": "Deactivate an accounting code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/accounting-codes/:ac-id/deactivate", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ac-id", "value": "", "type": "path", "description": "ID of the accounting code you want to deactivate." } ] }, "docs": "This reference describes how to deactivate an accounting code through the REST API.\n\n### Prerequisites\nIf you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission.\n### Limitations\nYou can only deactivate accounting codes that are not associated with any transactions. \nYou cannot disable accounting codes of type AccountsReceivable.\n" }, { "info": { "name": "Retrieve an accounting code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/accounting-codes/:ac-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ac-id", "value": "", "type": "path", "description": "ID of the accounting code you want to query." } ] }, "docs": "This reference describes how to query an accounting code through the REST API." }, { "info": { "name": "Update an accounting code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/accounting-codes/:ac-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ac-id", "value": "", "type": "path", "description": "ID of the accounting code you want to update." } ] }, "docs": "This reference describes how to update an existing accounting code through the REST API.\n### Prerequisites\n If you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission. \n### Limitations\nYou can only update accounting codes that are not already associated with any transactions.\n" }, { "info": { "name": "Delete an accounting code", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/accounting-codes/:ac-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ac-id", "value": "", "type": "path", "description": "ID of the accounting code you want to delete." } ] }, "docs": "This reference describes how to delete an accounting code through the REST API.\n### Prerequisites\nIf you have Zuora Finance enabled on your tenant, then you must have the Delete Unused Accounting Code permission.\n### Limitations\nYou can only delete accounting codes that have never been associated with any transactions. An accounting code must be deactivated before you can delete it.\n" } ] }, { "info": { "name": "Accounting Periods", "type": "folder" }, "items": [ { "info": { "name": "Close an accounting period", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/accounting-periods/:ap-id/close", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ap-id", "value": "", "type": "path", "description": "ID of the accounting period you want to close." } ] }, "docs": "Close an accounting period by accounting period ID.\n\nPrerequisites\n-------------\nYou must have Zuora Finance enabled on your tenant. You must have the Manage Close Process and Run Trial Balance user permissions.\n\nLimitations\n-----------\n* The accounting period cannot already be closed.\n* The accounting period cannot be in the process of running a trial balance.\n* All earlier accounting periods must be closed.\n* There must be no required action items for the accounting period. See Reconcile Trans" }, { "info": { "name": "Set an accounting period to pending close", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/accounting-periods/:ap-id/pending-close", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ap-id", "value": "", "type": "path", "description": "ID of the accounting period you want to set to pending close." } ] }, "docs": "Sets an accounting period to pending close.\n\n\nPrerequisites\n-------------\n\n* You must have Zuora Finance enabled on your tenant.\n* You must have the Manage Close Process and Run Trial Balance user permissions.\n\n \nLimitations \n -----------\n \n * The accounting period cannot be closed or pending close.\n \n * The accounting period cannot be in the process of running a trial balance.\n \n * All earlier accounting periods must be closed.\n \n \nNotes\n-----\nWhen you set an accounting period to pen" }, { "info": { "name": "List all accounting periods", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/accounting-periods", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" } ] }, "docs": "Retrieves all accounting periods on your tenant." }, { "info": { "name": "Create an accounting period", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/accounting-periods", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates an accounting period.\nPrerequisites\n-------------\n* You must have Zuora Finance enabled on your tenant.\n* You must have the Create Accounting Period user permission.\n\nLimitations\n-----------\n* When creating the first accounting period on your tenant, the start date must be equal to or earlier than the date of the earliest transaction on the tenant.\n* Start and end dates of accounting periods must be contiguous. For example, if one accounting period ends on January 31, the next period mus" }, { "info": { "name": "Retrieve an accounting period", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/accounting-periods/:ap-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ap-id", "value": "", "type": "path", "description": "ID of the accounting period you want to get." } ] }, "docs": "Retrieves an accounting period.\nPrerequisites\n-------------\n\nYou must have Zuora Finance enabled on your tenant.\n" }, { "info": { "name": "Update an accounting period", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/accounting-periods/:ap-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ap-id", "value": "", "type": "path", "description": "ID of the accounting period you want to update." } ] }, "docs": "\nUpdates an accounting period.\n\nPrerequisites\n-------------\n\n* You must have Zuora Finance enabled on your tenant.\n\n* You must have the Create Accounting Period user permission. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).\n\nLimitations\n-----------\n\n* You can update the start date of only the earliest accounting period on your tenant. You cannot update the start date of later periods.\n\n* If you update the e" }, { "info": { "name": "Delete an accounting period", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/accounting-periods/:ap-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ap-id", "value": "", "type": "path", "description": "ID of the accounting period you want to delete." } ] }, "docs": "Deletes an accounting period.\n\nPrerequisites\n-------------\n\n * You must have Zuora Finance enabled on your tenant.\n\n * You must have the Delete Accounting Period user permission. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).\n\n\nLimitations\n-----------\n\nThe accounting period to be deleted:\n\n* Must be the most recent accounting period\n\n* Must be an open accounting period\n\n* Must have no revenue distributed int" }, { "info": { "name": "Reopen an accounting period", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/accounting-periods/:ap-id/reopen", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ap-id", "value": "", "type": "path", "description": "ID of the accounting period that you want to re-open." } ] }, "docs": "Re-opens an accounting period.\nPrerequisites\n-------------\n* You must have Zuora Finance enabled on your tenant.\n* You must have the Manage Close Process and Run Trial Balance user permissions.\n\nLimitations\n-----------\n* The accounting period must be closed or pending close.\n* You can only re-open an accounting period that is immediately previous to an open period." }, { "info": { "name": "Run trial balance", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/accounting-periods/:ap-id/run-trial-balance", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ap-id", "value": "", "type": "path", "description": "ID of the accounting period for which you want to run a trial balance." } ] }, "docs": "Runs the trial balance for an accounting period. \n\nPrerequisites\n-------------\n\n* You must have Zuora Finance enabled on your tenant.\n\n* You must have the Manage Close Process and Run Trial Balance user permissions. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).\n\n \nLimitations \n-----------\n \n * The accounting period must be open.\n \n * The accounting period cannot already be in the process of running" } ] }, { "info": { "name": "Accounts", "type": "folder" }, "items": [ { "info": { "name": "Create an account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/accounts", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ] }, "docs": "Creates a customer account with a payment method, a bill-to contact, and an optional sold-to contact. Request and response field descriptions and sample code 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 entire transaction is rolled back.\n\nThis operation is CORS Enabled, so you can use client-side Javascript to invoke the " }, { "info": { "name": "Retrieve an account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/accounts/:account-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "account-key", "value": "", "type": "path", "description": "Account number or account ID." } ] }, "docs": "Retrieves basic information about a customer account.\n\nThis operation is a quick retrieval that doesn't include the account's subscriptions, invoices, payments, or usage details. Use Get account summary to get more detailed information about an account.\n" }, { "info": { "name": "Update an account", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/accounts/:account-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "account-key", "value": "", "type": "path", "description": "Account number or account ID." } ] }, "docs": "Updates a customer account by specifying the account-key.\n\n### Notes\n1. Only the fields to be changed should be specified. Any field that is not included in the request body will not be changed.\n2. If an empty field is submitted with this operation, the corresponding field in the account is emptied.\n3. Email addresses: If no email addresses are specified, no change is made to the email addresses or to the email delivery preference. If either the **personalEmail** or **workEmail** of **billToCon" }, { "info": { "name": "Delete an account", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/accounts/:account-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "account-key", "value": "", "type": "path", "description": "Account number or account ID." } ] }, "docs": "Deletes a specific account asynchronously. \n\n**Notes and Limitations:** \n- For account deletion, the system will start a backend job to remove all transactions under the accounts and change the status of the accounts to 'Cancelled'. This backend job is asynchronous and will take some time, depending on the job size. \n- An account cannot be deleted when the account is either the invoice owner or the subscription owner of a subscription and the subscription's invoice owner and subscription owner " }, { "info": { "name": "Retrieve an account summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/accounts/:account-key/summary", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "account-key", "value": "", "type": "path", "description": "Account number or account ID." }, { "name": "excludeUsage", "value": "", "type": "query", "description": "Indicate whether to exclude usage information in the response. The default value is `false`." } ] }, "docs": "Retrieves detailed information about the specified customer account.\n\nThe response includes the account information and a summary of the account’s subscriptions, invoices, payments, and usages.\n\n### Notes\nReturns only the six most recent subscriptions based on the subscription updatedDate. Within those subscriptions, there may be many rate plans and many rate plan charges. These items are subject to the maximum limit on the array size. \n" }, { "info": { "name": "List payment methods of an account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/accounts/:account-key/payment-methods", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "account-key", "value": "", "type": "path", "description": "Account number or account ID." }, { "name": "isDefaultOnly", "value": "", "type": "query", "description": "Indicates whether to only retrieve the default payment method of the account. The default value is `false`. If this parameter is set to `true`, only the default payment method is retrieved." }, { "name": "isActiveOnly", "value": "", "type": "query", "description": "Indicates whether to only retrieve the active payment methods of the account. The default value is `false`. If this parameter is set to `true`, only the active payment methods are retrieved." } ] }, "docs": "Retrieves the payment methods of the specified customer account.\n\n**Note:** This operation also supports retrieving custom payment methods created through the [Open Payment Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) service.\n" }, { "info": { "name": "Retrieve the default payment method of an account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/accounts/:account-key/payment-methods/default", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "account-key", "value": "", "type": "path", "description": "Account number or account ID." } ] }, "docs": "Retrieves the default payment method of the specified customer account.\n\n**Note:** This operation also supports retrieving the custom payment method created through the [Open Payment Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) service.\n" } ] }, { "info": { "name": "Actions", "type": "folder" }, "items": [ { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action/create", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "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.\n\n### Limitations \n\nThis call has the following limitations:\n\n* A maximum of 50 objects are supported in a single call.\n* The Orders feature is not supported.\n* The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement.\n* The de" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action/delete", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "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.\n\nThe following information applies to this call:\n\n* You will need to first determine the IDs for the objects you wish to delete.\n* You cannot pass in any null IDs.\n* All objects in a specific delete call must be of the same type.\n\n\n### Objects per Call\n50 objects are supported in a single call.\n" }, { "info": { "name": "Query", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action/query", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "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.\n\n\nYou can use [Zuora Object Query Language](https://knowledgecenter.zuora.com/DC_Developers/K_Zuora_Object_Query_Language) (ZOQL) to construct those queries, passing them through the `queryString`.\n\n\nOnce the call is made, the API executes the query against the specified object and returns a query response objec" }, { "info": { "name": "QueryMore", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action/queryMore", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "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.\n\n\nAny `queryLocator` results greater than 2,000, will only be stored by Zuora for 5 days before it is deleted.\n\n\n This call sends a request for additional results from an initial query call. If the initial query call returns more than 2000 results, you can use the `queryLocator` returned from query to request" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action/update", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "\nUpdates 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.\n\n\n### Limitations \n\nThis call has the following limitations:\n\n* A maximum of 50 objects are supported in a single call.\n* The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement.\n* The default WSDL version for" } ] }, { "info": { "name": "Aggregate Queries", "type": "folder" }, "items": [ { "info": { "name": "Submit an aggregate query job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/batch-query/", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ] }, "docs": "Submits an AQuA job that contains an aggregated list of ZOQL and Export ZOQL queries.\n" }, { "info": { "name": "Retrieve an aggregate query job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/batch-query/jobs/:jobid", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "jobid", "value": "", "type": "path", "description": "Internal identifier of the query job.\n" } ] }, "docs": "Retrieves an aggregate query using the Job ID.\n\nNote that the completed AQuA jobs that were created 180 days ago are deleted permanently from Zuora, so you cannot query these jobs through API or AQuA job finder.\n" }, { "info": { "name": "Cancel a running aggregate query job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/batch-query/jobs/:jobid", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "jobid", "value": "", "type": "path", "description": "Internal identifier of the query job.\n" } ] }, "docs": "Cancels the current AQuA job, only if the job is not complete. If the job is complete, an error is thrown.\n" }, { "info": { "name": "Retrieve the last completed aggregate query job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/batch-query/jobs/partner/:partner/project/:project", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "partner", "value": "", "type": "path", "description": "The unique ID of a data integration partner. \n" }, { "name": "project", "value": "", "type": "path", "description": "The unique ID of a data integration project for a particular partner.\n" } ] }, "docs": "Returns the details of the last completed job.\n\nThe completed AQuA jobs that were created 180 days ago are deleted permanently from Zuora, so you cannot query these jobs through API or AQuA job finder.\n" } ] }, { "info": { "name": "API Health", "type": "folder" }, "items": [ { "info": { "name": "List API volume summary records", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/system-health/api-requests/volume-summary", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "path", "value": "", "type": "query", "description": "Filters the volume summary by API path name.\n\nYou can refer to the api listed in the [API System Health Dashboard](https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_System_Health/B_APIs_dashboard) for the path name. Example: `/v1/accounts/{account-key}`.\n" }, { "name": "httpMethod", "value": "", "type": "query", "description": "Filters the volume summary by http method. Example: `POST`.\n" }, { "name": "startTime", "value": "", "type": "query", "description": "Start time of the volume summary.\n\nFormat: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`.\n" }, { "name": "endTime", "value": "", "type": "query", "description": "End time of the volume summary.\n\nFormat: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-29T09:07+0800`.\n" } ] }, "docs": "Returns volume summary of [API](https://knowledgecenter.zuora.com/Central_Platform/API) usage that generated by your Zuora tenant within a specified time range.\n\nYou can filter the summary by API path name and http method.\n" } ] }, { "info": { "name": "Attachments", "type": "folder" }, "items": [ { "info": { "name": "Create an attachment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/attachments", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "description", "value": "", "type": "query", "description": "Description of the attachment document.\n" }, { "name": "associatedObjectType", "value": "", "type": "query", "description": "The type of the object to add attachements for. \n" }, { "name": "associatedObjectKey", "value": "", "type": "query", "description": "For the Subscription type, specify the Subscription Number. An attachment is tied to the Subscription Number and thus viewable with every subscription version.\n\nFor Account, Credit Memo, and Debit Memo, specify the corresponding ID or number. For Invoice, specify the corresponding ID.\n" } ] }, "docs": "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.\n\nYou can only use this operation if you have a Billing role that includes the Manage Attachments permission.\nFor more information, see [Billing roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles).\nTo change your Billing role, contact your Zuora platform administrator." }, { "info": { "name": "List attachments by object type and key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/attachments/:object-type/:object-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "object-type", "value": "", "type": "path", "description": "The type of the object to list attachements for.\n" }, { "name": "object-key", "value": "", "type": "path", "description": "ID of the object to list attachements for.\n - If `object-type` is `account`, specify an account ID or number.\n - If `object-type` is `invoice`, specify an invoice ID.\n - If `object-type` is `subscription`, specify a subscription number.\n - If `object-type` is `creditmemo`, specify a credit memo ID or number.\n - If `object-type` is `debitmemo`, specify a debit memo ID or number.\n" } ] }, "docs": "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.\n\nYou can only use this operation if you have a Billing role that includes the Manage Attachments permission.\nFor more information, see [Billing roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles).\nTo change your Billing role, contact your Zuora platform administrator.\n\n**Note**: The Credit " }, { "info": { "name": "Retrieve an attachment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/attachments/:attachment-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "attachment-id", "value": "", "type": "path", "description": "Id of the attachment you want to view." } ] }, "docs": "Use the View Attachment REST request to retrieve information about an attachment document.\n\nYou can only use this operation if you have a Billing role that includes the Manage Attachments permission.\nFor more information, see [Billing roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles).\nTo change your Billing role, contact your Zuora platform administrator.\n" }, { "info": { "name": "Update an attachment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/attachments/:attachment-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "attachment-id", "value": "", "type": "path", "description": "Id of the attachment to be updated." } ] }, "docs": "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.\n\nYou can only use this operation if you have a Billing role that includes the Manage Attachments permission.\nFor more information, see [Billing roles](https://knowledgece" }, { "info": { "name": "Delete an attachment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/attachments/:attachment-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "attachment-id", "value": "", "type": "path", "description": "Id of the attachment to be deleted." } ] }, "docs": "Use the Delete Attachment REST request to delete an attachment from a Zuora object.\n\nYou can only use this operation if you have a Billing role that includes the Manage Attachments permission and the Delete Attachments permission.\nFor more information, see [Billing roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles).\nTo change your Billing role, contact your Zuora platform administrator.\n" } ] }, { "info": { "name": "Bill Run Health", "type": "folder" }, "items": [ { "info": { "name": "List billing document volume summary records", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/system-health/billing-documents/volume-summary", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Start time of the volume summary.\n\nFormat: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`.\n" }, { "name": "endTime", "value": "", "type": "query", "description": "End time of the volume summary.\n\nFormat: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`.\n" } ] }, "docs": "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.\n" } ] }, { "info": { "name": "Bill Run", "type": "folder" }, "items": [ { "info": { "name": "Create a bill run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/bill-runs", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates an ad-hoc bill run or a scheduled bill run.\n - Support to create ad-hoc or scheduled bill runs by batch\n - Support to create ad-hoc or scheduled bill runs for a single account (all subscriptions under this account)\n - Support to create a bill run by subscription (50 or less subscriptions under the same account)\n\nTo use this operation, you must have the which helps user to select specific components to be migrated.\n\nIt takes the enviroment details from the logged in user automatically, while creating the template.\n" }, { "info": { "name": "List all details of a template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/deployment-manager/deployment_templates/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the template that needs to be retrieved." } ] }, "docs": "Returns the detailed information of a specific template by passing its template ID.\n" }, { "info": { "name": "Delete a template", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/deployment-manager/deployment_templates/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the template that needs to be deleted." } ] }, "docs": "Deletes a specific template by passing the ID.\n" }, { "info": { "name": "Download a template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/deployment-manager/deployment_artifacts", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "deployment_template_id", "value": "", "type": "query", "description": "Id which template needs to be downloaded." } ] }, "docs": "Download a template for migration in the Deployment manager from the source tenant to the target tenant.\n" }, { "info": { "name": "List all details of source components", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/deployment-manager/deployment_artifacts/retrieve-settings", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ] }, "docs": "When the advanced option is clicked, get the details/metadata of the components, such as settings, notifications, workflow, etc.\n" }, { "info": { "name": "Compare settings between a source tenant and a target tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/deployment-manager/deployment_artifacts/compare", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "query", "description": "Customers need to specify tenant ID." } ] }, "docs": "To Compare the configurations from the template downloaded and used in deployment manager for migration which is available in source and target tenant.\n" }, { "info": { "name": "Migrate settings from source tenant to target tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/deployment-manager/deployment_artifacts/deploy", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "query", "description": "Customers need to specify tenant ID in query parameter." } ] }, "docs": "To migrate the selected configuration of a tenant in Deployment Manager migration while using template from the compare screen.\n" } ] }, { "info": { "name": "Contact Snapshots", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a contact snapshot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/contact-snapshots/:contact-snapshot-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "contact-snapshot-id", "value": "", "type": "path", "description": "The unique ID of the contact snapshot to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab.\n" } ] }, "docs": "Retrieves detailed information about the snapshot of a contact, either a bill-to contact or sold-to contact.\n" } ] }, { "info": { "name": "Contacts", "type": "folder" }, "items": [ { "info": { "name": "Scrub a contact", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/contacts/:contactId/scrub", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The ID of the contact that you want to scrub sensitive data from.\n" } ] }, "docs": "\nScrubs the sensitive data of a specific contact. \n\nYou can use this operation to replace all sensitive data in a contact and its related contact snapshot with dummy values that will be stored in Zuora databases. \n\nAfter scrubbing a contact, it is good practice to delete it. Otherwise, it might cause errors in subsequent operations.\n\n**Note**: To use this operation, you must ensure that the \"Scrub Sensitive Data of Contact\" billing permission is enabled in your user role. Contact your tenant adm" }, { "info": { "name": "Create a contact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/contacts", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ] }, "docs": "Creates a contact for a specified account.\n" }, { "info": { "name": "Retrieve a contact", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/contacts/:contactId", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The ID of the contact that you want to retrieve.\n" } ] }, "docs": "Retrieves detailed information about a specific contact.\n" }, { "info": { "name": "Update a contact", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/contacts/:contactId", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The ID of the contact that you want to update.\n" } ] }, "docs": "Updates a contact for a specified account.\n\nYou can update contacts for cancelled accounts.\n" }, { "info": { "name": "Delete a contact", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/contacts/:contactId", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The ID of the contact that you want to delete.\n" } ] }, "docs": "Deletes a contact.\n" } ] }, { "info": { "name": "Credit Memos", "type": "folder" }, "items": [ { "info": { "name": "List credit memos", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/creditmemos", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "accountId", "value": "", "type": "query", "description": "This parameter filters the response based on the `accountId` field.\n" }, { "name": "accountNumber", "value": "", "type": "query", "description": "This parameter filters the response based on the `accountNumber` field.\n" }, { "name": "amount", "value": "", "type": "query", "description": "This parameter filters the response based on the `amount` field. \n" }, { "name": "appliedAmount", "value": "", "type": "query", "description": "This parameter filters the response based on the `appliedAmount` field. \n" }, { "name": "autoApplyUponPosting", "value": "", "type": "query", "description": "This parameter filters the response based on the `autoApplyUponPosting` field. \n" }, { "name": "createdById", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdById` field. \n" }, { "name": "createdDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdDate` field. \n" }, { "name": "creditMemoDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `creditMemoDate` field. \n" }, { "name": "currency", "value": "", "type": "query", "description": "This parameter filters the response based on the `currency` field. \n" }, { "name": "excludeFromAutoApplyRules", "value": "", "type": "query", "description": "This parameter filters the response based on the `excludeFromAutoApplyRules` field. \n" }, { "name": "number", "value": "", "type": "query", "description": "This parameter filters the response based on the `number` field. \n" }, { "name": "referredInvoiceId", "value": "", "type": "query", "description": "This parameter filters the response based on the `referredInvoiceId` field. \n" }, { "name": "refundAmount", "value": "", "type": "query", "description": "This parameter filters the response based on the `refundAmount` field. \n" }, { "name": "status", "value": "", "type": "query", "description": "This parameter filters the response based on the `status` field. \n" }, { "name": "targetDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `targetDate` field. \n" }, { "name": "taxAmount", "value": "", "type": "query", "description": "This parameter filters the response based on the `taxAmount` field. \n" }, { "name": "totalTaxExemptAmount", "value": "", "type": "query", "description": "This parameter filters the response based on the `totalTaxExemptAmount` field.\n" }, { "name": "transferredToAccounting", "value": "", "type": "query", "description": "This parameter filters the response based on the `transferredToAccounting` field. \n" }, { "name": "unappliedAmount", "value": "", "type": "query", "description": "This parameter filters the response based on the `unappliedAmount` field. \n" }, { "name": "updatedById", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedById` field. \n" }, { "name": "updatedDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedDate` field.\n" }, { "name": "sort", "value": "", "type": "query", "description": "This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.\n\n - The `-` operator indicates an ascending order.\n - The `+` operator indicates a descending order.\n\nBy default, the response data is displayed in descending order by credit memo number.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n - accountId\n - amount\n - appliedAmount\n - createdById\n - createdDate\n - creditMemoDate\n - number\n - referredInvoiceId\n - refundAmount\n - status\n - targetDate\n - taxAmount\n - totalTaxExemptAmount\n - transferredToAccounting\n - unappliedAmount\n - updatedDate\n\n \nExamples:\n\n- /v1/creditmemos?sort=+number\n\n- /v1/creditmemos?status=Processed&sort=-number,+amount\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Create a credit memo from a charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/creditmemos", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Create credit memos", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/creditmemos/bulk", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Update credit memos", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/creditmemos/bulk", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Create a credit memo from an invoice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/invoices/:invoiceKey/creditmemos", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "invoiceKey", "value": "", "type": "path", "description": "The ID or number of an invoice that you want to create a credit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Retrieve a credit memo", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "creditMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Update a credit memo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "creditMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Delete a credit memo", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "creditMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Apply a credit memo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/apply", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "creditMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Cancel a credit memo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/cancel", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "creditMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Email a credit memo", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/emails", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "creditMemoKey", "value": "", "type": "path", "description": "The ID or number of a posted credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Upload a file for a credit memo", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/files", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "creditMemoKey", "value": "", "type": "path", "description": "The ID or number of the credit memo that you want to upload a PDF file for. For example, 402890555a7e9791015a879f064a0054 or CM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "List credit memo items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/items", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "creditMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n" }, { "name": "amount", "value": "", "type": "query", "description": "This parameter filters the response based on the `amount` field. \n" }, { "name": "appliedAmount", "value": "", "type": "query", "description": "This parameter filters the response based on the `appliedAmount` field.\n" }, { "name": "createdById", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdById` field. \n" }, { "name": "createdDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdDate` field. \n" }, { "name": "id", "value": "", "type": "query", "description": "This parameter filters the response based on the `id` field. \n" }, { "name": "refundAmount", "value": "", "type": "query", "description": "This parameter filters the response based on the `refundAmount` field. \n" }, { "name": "serviceEndDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `serviceEndDate` field. \n" }, { "name": "serviceStartDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `serviceStartDate` field. \n" }, { "name": "sku", "value": "", "type": "query", "description": "This parameter filters the response based on the `sku` field. \n" }, { "name": "skuName", "value": "", "type": "query", "description": "This parameter filters the response based on the `skuName` field. \n" }, { "name": "sourceItemId", "value": "", "type": "query", "description": "This parameter filters the response based on the `sourceItemId` field. \n" }, { "name": "subscriptionId", "value": "", "type": "query", "description": "This parameter filters the response based on the `subscriptionId` field.\n" }, { "name": "updatedById", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedById` field. \n" }, { "name": "updatedDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedDate` field.\n" }, { "name": "sort", "value": "", "type": "query", "description": "This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.\n\n - The `-` operator indicates an ascending order.\n - The `+` operator indicates a descending order.\n\nBy default, the response data is displayed in descending order by updated date.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n - amount\n - appliedAmount\n - createdById\n - createdDate\n - id\n - refundAmount\n - serviceEndDate\n - serviceStartDate\n - sku\n - skuName\n - sourceItemId\n - subscriptionId\n - updatedById\n - updatedDate\n \nExamples:\n\n- /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?sort=createdDate\n\n- /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Retrieve a credit memo item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/items/:cmitemid", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "cmitemid", "value": "", "type": "path", "description": "The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo items](/api-references/api/operation/GET_CreditMemoItems).\n" }, { "name": "creditMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "List all taxation items of a credit memo item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoId/items/:cmitemid/taxation-items", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "cmitemid", "value": "", "type": "path", "description": "The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo items](/api-references/api/operation/GET_CreditMemoItems).\n" }, { "name": "creditMemoId", "value": "", "type": "path", "description": "The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "List all parts of a credit memo", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/parts", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "creditMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Retrieve a credit memo part", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/parts/:partid", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "partid", "value": "", "type": "path", "description": "The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit memo](/api-references/api/operation/GET_CreditMemoParts).\n" }, { "name": "creditMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Generate a credit memo PDF file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/pdfs", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "creditMemoKey", "value": "", "type": "path", "description": "The unique ID or number of the credit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Post a credit memo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/post", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "creditMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Refund a credit memo", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/refunds", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "creditMemoKey", "value": "", "type": "path", "description": "The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Reverse a credit memo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/reverse", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "creditMemoKey", "value": "", "type": "path", "description": "The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Create taxation items for a credit memo", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/taxationitems", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "creditMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Unapply a credit memo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/unapply", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "creditMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Unpost a credit memo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/unpost", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "creditMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Write off a credit memo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoId/write-off", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "creditMemoId", "value": "", "type": "path", "description": "The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Generate an e-invoice file for a credit memo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/creditmemos/:creditMemoKey/einvoice/generate", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "creditMemoKey", "value": "", "type": "path", "description": "The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM-0000001.\n" } ] }, "docs": "Generates an e-invoice file for a credit memo.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n" } ] }, { "info": { "name": "Custom Event Triggers", "type": "folder" }, "items": [ { "info": { "name": "List event triggers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/events/event-triggers", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "baseObject", "value": "", "type": "query", "description": "The Zuora object that trigger condition is defined upon. The format of the value in this field depends on the base object type:\n- Standard object: object name, which should follow the pattern ^[A-Z][\\w\\-]*$. For example, `Invoice`.\n- Custom object: `default__`. For example, `default__vehicle`.\n" }, { "name": "eventTypeName", "value": "", "type": "query", "description": "The event type name. Should be specified in the pattern: ^[A-Za-z]{1,}[\\w\\-]*$" }, { "name": "active", "value": "", "type": "query", "description": "The status of the event trigger." }, { "name": "start", "value": "", "type": "query", "description": "The first index of the query result. Default to 0 if absent, and the minimum is 0." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of data records to be returned. Default to 10 if absent." } ] }, "docs": "List event triggers" }, { "info": { "name": "Create an event trigger", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/events/event-triggers", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ] }, "docs": "When you create an event trigger, you must specify the base object and define the trigger condition.\n\n### Specify the base object\nUse `baseObject` field to specify which object to define a trigger on. You can define an event trigger on any of the following objects:\n\n * Account\n * AccountingCode\n * AccountingPeriod\n * Amendment\n * BillingRun\n * Contact\n * CreditBalanceAdjustment\n * CreditMemo\n * CreditMemoApplication\n * CreditMemoApplicationItem\n * CreditMemoItem\n * DebitMemo\n * Debi" }, { "info": { "name": "Retrieve an event trigger", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/events/event-triggers/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve an event trigger" }, { "info": { "name": "Update an event trigger", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/events/event-triggers/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Update an event trigger" }, { "info": { "name": "Delete an event trigger", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/events/event-triggers/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an event trigger" } ] }, { "info": { "name": "Custom Exchange Rates", "type": "folder" }, "items": [ { "info": { "name": "List custom exchange rates by currency", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/custom-exchange-rates/:currency", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "currency", "value": "", "type": "path", "description": "The target base currency of the tenant. The exchange rates in the response are calculated in relation to the target currency.\n\nThe value must be a three-letter currency code, for example, USD. \n" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date of the date range for which you want to get exchange rates.\n\nThe date must be in yyyy-mm-dd format, for example, 2016-01-15. The start date cannot be later than the end date.\n" }, { "name": "endDate", "value": "", "type": "query", "description": "End date of the date range for which you want to get exchange rates.\n\nThe date must be in yyyy-mm-dd format, for example, 2016-01-16. The end date can be a maximum of 90 days after the start date.\n" } ] }, "docs": "This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). \n\nThis reference describes how to query custom foreign exchange rates from Zuora. You can use this API method to query exchange rates only if you use a custom exchange rate provider and upload rates with the Import Foreign Exchange Rates mass action. \n" } ] }, { "info": { "name": "Custom Object Definitions", "type": "folder" }, "items": [ { "info": { "name": "List custom object definitions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/objects/definitions/default", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ], "params": [ { "name": "select", "value": "", "type": "query", "description": "If you set `select` to `type`, the response will only contain the `type` of each custom object.\n" } ] }, "docs": "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](/api-references/api/operation/POST_CustomObjectDefinitions) call in the new tenant to import all the custom objects from the old tenant.\n" }, { "info": { "name": "Create custom object definitions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/objects/definitions/default", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ] }, "docs": "You can post custom object definitions with the request body schema described below. \n\nThis operation also allows you to use the [List custom object definitions](/api-references/api/operation/GET_AllCustomObjectDefinitionsInNamespace) response schema as its request schema. If you want to copy all the existing custom objects from an old tenant to a new tenant, you can make a [List custom object definitions](/api-references/api/operation/GET_AllCustomObjectDefinitionsInNamespace) call in your old " }, { "info": { "name": "Retrieve a custom object definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/objects/definitions/default/:object", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ], "params": [ { "name": "object", "value": "", "type": "path", "description": "Specifies the custom object's API name as object. It is case-sensitive." } ] }, "docs": "Retrieves the custom object definition by type for the given tenant.\n" }, { "info": { "name": "Delete a custom object definition", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/objects/definitions/default/:object", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ], "params": [ { "name": "object", "value": "", "type": "path", "description": "Specifies the custom object's API name as object. It is case-sensitive." } ] }, "docs": "Deletes the custom object definition for the provided type.\n\n**Note:** A custom object definition can only be deleted if no record of this custom object type exists.\n" }, { "info": { "name": "Update a custom object definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/objects/migrations", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ] }, "docs": "Updates a custom object definition by posting migration resource to initiate the migration of definitions.\n\n### Limitations \n\nUpdating custom field definition has the following limitations:\n\n* You can only have one action per update request.\n* You cannot delete fields from custom objects that contain records.\n* You can only add required fields to custom objects with no records.\n* You can change optional fields to required only on the custom objects with no records. \n" } ] }, { "info": { "name": "Custom Object Records", "type": "folder" }, "items": [ { "info": { "name": "List records for a custom object", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/objects/records/default/:object", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ], "params": [ { "name": "object", "value": "", "type": "path", "description": "Specifies the custom object's API name as object. It is case-sensitive." }, { "name": "q", "value": "", "type": "query", "description": "The query string to filter the records of a custom object. See the [Query syntax of custom object records](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Data_Model/Custom_object_records/Query_syntax_of_custom_object_records) for more information.\n\nNote that the `q` parameter only applies to filterable fields.\n" }, { "name": "ids", "value": "", "type": "query", "description": "UUIDs of the records to be queried. Each UUID must be a string of 36 characters. For example:\n\n`GET /objects/records/default/passenger?ids=258d65b2-7bc6-4142-88bc-5184931af493&ids=82ecc9f7-b192-4f88-a4a3-4b2af6c750a1`\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response." }, { "name": "cursor", "value": "", "type": "query", "description": "The `cursor` points to the last record of the previous result set. The cursor record is not included in the query result. The call returns the first page if `cursor` is not provided and `pageSize` is valid." } ] }, "docs": "Lists all object records of the given type. You can also use the `q` query parameter to filter the output records.\n\n\n### Custom Objects read consistency\n\nCustom Objects support eventually consistency. When you read custom object records, the response might not reflect the result of a recently completed operation and might include some stale data. The operations include creating, updating, and deleting custom object records. If you repeat your read request after a short time, the response should" }, { "info": { "name": "Create custom object records", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/objects/records/default/:object", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ], "params": [ { "name": "object", "value": "", "type": "path", "description": "Specifies the custom object's API name as object. It is case-sensitive." } ] }, "docs": "Creates custom object records with the given type. \n\nUpon creating records of a custom object type, the 200 response contains a list of records that have been successfully processed and stored.\n\n\n### Limitations \n\nThis call has the following limitations:\n* The maximum number of records that you can create by one call is 1,000.\n* The storage of empty strings in records is not supported.\n* Null values must be formatted as the following example: \n ```\n {\n \"records\": [\n {\n \"fieldNam" }, { "info": { "name": "Retrieve a custom object record", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/objects/records/default/:object/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ], "params": [ { "name": "object", "value": "", "type": "path", "description": "Specifies the custom object's API name as object. It is case-sensitive." }, { "name": "id", "value": "", "type": "path", "description": "Id identifier in uuid form" } ] }, "docs": "Retrieves a record of a given type by ID.\n" }, { "info": { "name": "Update a custom object record", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/objects/records/default/:object/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "Zuora-Version", "value": "" } ], "params": [ { "name": "object", "value": "", "type": "path", "description": "Specifies the custom object's API name as object. It is case-sensitive." }, { "name": "id", "value": "", "type": "path", "description": "Id identifier in uuid form" } ] }, "docs": "Updates a record of the given type and ID.\n\n### Limitations \n\n* The storage of empty strings in records is not supported.\n* Null values must be formatted as the following example: \n ```\n {\n \"records\": [\n {\n \"fieldName__c\": null\n }\n ]\n }\n ```\n" }, { "info": { "name": "Partially update a custom object record", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/objects/records/default/:object/:id", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ], "params": [ { "name": "object", "value": "", "type": "path", "description": "Specifies the custom object's API name as object. It is case-sensitive." }, { "name": "id", "value": "", "type": "path", "description": "Id identifier in uuid form" } ] }, "docs": "Updates one or many fields of a custom object record. Patch update uses JSON Merge Patch as specified in [RFC 7386](https://tools.ietf.org/html/rfc7386).\n\n### Limitations \n\n* The storage of empty strings in records is not supported.\n* Null values must be formatted as the following example: \n ```\n {\n \"records\": [\n {\n \"fieldName__c\": null\n }\n ]\n }\n ```\n" }, { "info": { "name": "Delete a custom object record", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/objects/records/default/:object/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ], "params": [ { "name": "object", "value": "", "type": "path", "description": "Specifies the custom object's API name as object. It is case-sensitive." }, { "name": "id", "value": "", "type": "path", "description": "Id identifier in uuid form" } ] }, "docs": "Deletes a custom object record of the given type and ID.\n\nNote that 200 response will be returned under either of the following conditions:\n* The record is identified and successfully deleted\n* The record could not be found\n\nNote that the record is deleted immediately and, therefore, will not be retained upon successful deletion.\n" }, { "info": { "name": "Update or delete custom object records", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/objects/batch/default/:object", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ], "params": [ { "name": "object", "value": "", "type": "path", "description": "Specifies the custom object's API name as object. It is case-sensitive." } ] }, "docs": "Makes a batch update or delete of custom object records.\n### Limitations \n\nThis call has the following limitations:\n* The maximum number of records that you can update by one call is 1,000.\n* The maximum number of records that you can delete by one call is 1,000.\n* The storage of empty strings in records is not supported.\n* Null values must be formatted as the following example: \n ```\n {\n \"action\": {\n \"type\": \"update\",\n \"records\": {\n \"64edb2a5-2796-4e95-9559" } ] }, { "info": { "name": "Custom Object Jobs", "type": "folder" }, "items": [ { "info": { "name": "List all custom object bulk jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/objects/jobs", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ], "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response." }, { "name": "cursor", "value": "", "type": "query", "description": "The `cursor` points to the last job of the previous result set. The cursor job is not included in this query result. The call returns the first page if `cursor` is not provided and `pageSize` is valid." }, { "name": "status", "value": "", "type": "query", "description": "The status of bulk jobs to be retrieved." } ] }, "docs": "Lists all custom object bulk jobs submitted by your tenant.\n" }, { "info": { "name": "Submit a custom object bulk job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/objects/jobs", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ] }, "docs": "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.\n\n### Limits\nThis custom object bulk jobs have the following limits:\n* The concurrent bulk job limit per tenant is 5. Bulk jobs in `accepted`, `pending`, or `in_progress` status are counted towards the concurrent bulk job limit.\n* The bulk job execuation" }, { "info": { "name": "Retrieve a custom object bulk job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/objects/jobs/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the custom object bulk job to be retrieved." } ] }, "docs": "Retrieves the custom object bulk job details by job ID.\n\nOnly the users that have the \"View Custom Objects\" permission can retrieve custom object bulk jobs. See [Platform Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/h_Platform_Roles#Platform_Permissions) for more information.\n" }, { "info": { "name": "Upload a file for a custom object bulk job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/objects/jobs/:id/files", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the custom object bulk job that the file is uploaded to." } ] }, "docs": "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.\n\nOnly the users that have the \"Edit Custom Objects\" permission can upload files to custom object bulk jobs. See [Platform Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Mana" }, { "info": { "name": "List all errors for a custom object bulk job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/objects/jobs/:id/errors", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the custom object bulk job that you retrieve errors for." } ] }, "docs": "Lists all errors for a custom object bulk job.\n" }, { "info": { "name": "Cancel a custom object bulk job", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/objects/jobs/:id/cancel", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the custom object bulk job that you want to cancel." } ] }, "docs": "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`.\n" } ] }, { "info": { "name": "Custom Scheduled Events", "type": "folder" }, "items": [ { "info": { "name": "List all scheduled events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/events/scheduled-events", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "eventTypeName", "value": "", "type": "query", "description": "The name of the scheduled event. Should be specified in the pattern: ^[A-Za-z]{1,}[\\\\w\\\\-]*$" }, { "name": "apiObject", "value": "", "type": "query", "description": "The base object that the scheduled event is defined upon. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$" }, { "name": "apiField", "value": "", "type": "query", "description": "The base field of the base object in the `apiObject` field. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$" }, { "name": "active", "value": "", "type": "query", "description": "Indicate whether the scheduled event is active or inactive." }, { "name": "start", "value": "", "type": "query", "description": "The first index of the query result. Default to 0 if absent, and the minimum is 0." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of data records to be returned. Default to 10 if absent." } ] }, "docs": "List all scheduled events" }, { "info": { "name": "Create a scheduled event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/events/scheduled-events", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ] }, "docs": "To create a custom scheduled event, you must specify the base object, the base field and the scheduled time.\n" }, { "info": { "name": "Retrieve a scheduled event by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/events/scheduled-events/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the scheduled event." } ] }, "docs": "Retrieve a scheduled event by ID" }, { "info": { "name": "Update a scheduled event by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/events/scheduled-events/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the scheduled event." } ] }, "docs": "Update a scheduled event by ID" }, { "info": { "name": "Delete a scheduled event by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/events/scheduled-events/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the scheduled event." } ] }, "docs": "Delete a scheduled event by ID" } ] }, { "info": { "name": "Data Labeling", "type": "folder" }, "items": [ { "info": { "name": "Submit a data labeling job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/multi-organizations/data-labeling-job", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ] }, "docs": "Submits a data labeling job.\n" }, { "info": { "name": "Retrieve a data labeling job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/multi-organizations/data-labeling-job/:job-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "job-id", "value": "", "type": "path", "description": "Identifier of the data labeling job.\n" } ] }, "docs": "Retrieves a data labeling job. You can use this operation to track the status of the data labeling job.\n" } ] }, { "info": { "name": "Data Queries", "type": "folder" }, "items": [ { "info": { "name": "List data query jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/query/jobs", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "queryStatus", "value": "", "type": "query", "description": "Filters the list of query jobs by status.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" } ] }, "docs": "Returns a list of [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) jobs that have been created in your Zuora tenant. You can filter the list by status.\n\nIf you are an administrator, you can retrieve all the query jobs in your tenant. Otherwise, you can only retrieve your own query jobs.\n" }, { "info": { "name": "Submit a data query", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/query/jobs", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ] }, "docs": "Submits a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) to be performed by Zuora and creates a query job. You can use [Retrieve a data query job](#operation/GET_DataQueryJob) to track the status of the query job and obtain the URL of the query results.\n" }, { "info": { "name": "Retrieve a data query job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/query/jobs/:job-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "job-id", "value": "", "type": "path", "description": "Internal identifier of the query job.\n" } ] }, "docs": "Retrieves a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) job. You can use this operation to track the status of the query job and obtain the URL of the query results.\n\nIf you are an administrator, you can retrieve every query job in your tenant. \n\nIf you are a non-admin user and try to retrieve a query job that you are not the owner of, you will get a 403 response indicating that you are forbidden from viewing this job. As a non-admin user, you can only retrieve yo" }, { "info": { "name": "Cancel a data query job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/query/jobs/:job-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "job-id", "value": "", "type": "path", "description": "Internal identifier of the query job.\n" } ] }, "docs": "Cancels a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_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`.\n" } ] }, { "info": { "name": "Debit Memos", "type": "folder" }, "items": [ { "info": { "name": "List debit memos", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/debitmemos", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "accountId", "value": "", "type": "query", "description": "This parameter filters the response based on the `accountId` field.\n" }, { "name": "accountNumber", "value": "", "type": "query", "description": "This parameter filters the response based on the `accountNumber` field.\n" }, { "name": "amount", "value": "", "type": "query", "description": "This parameter filters the response based on the `amount` field.\n" }, { "name": "balance", "value": "", "type": "query", "description": "This parameter filters the response based on the `balance` field.\n" }, { "name": "beAppliedAmount", "value": "", "type": "query", "description": "This parameter filters the response based on the `beAppliedAmount` field.\n" }, { "name": "createdById", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdById` field.\n" }, { "name": "createdDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdDate` field.\n" }, { "name": "currency", "value": "", "type": "query", "description": "This parameter filters the response based on the `currency` field.\n" }, { "name": "debitMemoDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `debitMemoDate` field.\n" }, { "name": "dueDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `dueDate` field.\n" }, { "name": "number", "value": "", "type": "query", "description": "This parameter filters the response based on the `number` field.\n" }, { "name": "referredInvoiceId", "value": "", "type": "query", "description": "This parameter filters the response based on the `referredInvoiceId` field.\n" }, { "name": "status", "value": "", "type": "query", "description": "This parameter filters the response based on the `status` field.\n" }, { "name": "targetDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `targetDate` field.\n" }, { "name": "taxAmount", "value": "", "type": "query", "description": "This parameter filters the response based on the `taxAmount` field.\n" }, { "name": "totalTaxExemptAmount", "value": "", "type": "query", "description": "This parameter filters the response based on the `totalTaxExemptAmount` field.\n" }, { "name": "updatedById", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedById` field.\n" }, { "name": "updatedDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedDate` field.\n" }, { "name": "sort", "value": "", "type": "query", "description": "This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.\n\n - The `-` operator indicates an ascending order.\n - The `+` operator indicates a descending order.\n\nBy default, the response data is displayed in descending order by debit memo number.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n - number\n - accountId\n - debitMemoDate\n - targetDate\n - dueDate\n - amount\n - taxAmount\n - totalTaxExemptAmount\n - balance\n - beAppliedAmount\n - referredInvoiceId\n - createdDate\n - createdById\n - updatedDate\n - updatedById\n \nExamples:\n\n- /v1/debitmemos?sort=+number\n\n- /v1/debitmemos?status=Processed&sort=-number,+amount\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Create a debit memo from a charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/debitmemos", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Update due dates for debit memos", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/debitmemos", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Create debit memos", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/debitmemos/bulk", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Update debit memos", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/debitmemos/bulk", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Create a debit memo from an invoice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/invoices/:invoiceKey/debitmemos", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "invoiceKey", "value": "", "type": "path", "description": "The ID or number of an invoice that you want to create a debit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Retrieve a debit memo", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "debitMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Update a debit memo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "debitMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Delete a debit memo", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "debitMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "List all application parts of a debit memo", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoId/application-parts", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "debitMemoId", "value": "", "type": "path", "description": "The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Cancel a debit memo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoKey/cancel", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "debitMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Collect a posted debit memo", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoKey/collect", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "debitMemoKey", "value": "", "type": "path", "description": "The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Email a debit memo", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoKey/emails", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "debitMemoKey", "value": "", "type": "path", "description": "The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Upload a file for a debit memo", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoKey/files", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "debitMemoKey", "value": "", "type": "path", "description": "The ID or number of the debit memo that you want to upload a PDF file for. For example, 402890555a87d7f5015a8919e4fe002e or DM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "List debit memo items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoKey/items", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "debitMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n" }, { "name": "amount", "value": "", "type": "query", "description": "This parameter filters the response based on the `amount` field.\n" }, { "name": "beAppliedAmount", "value": "", "type": "query", "description": "This parameter filters the response based on the `beAppliedAmount` field.\n" }, { "name": "createdById", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdById` field.\n" }, { "name": "createdDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdDate` field.\n" }, { "name": "id", "value": "", "type": "query", "description": "This parameter filters the response based on the `id` field.\n" }, { "name": "serviceEndDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `serviceEndDate` field.\n" }, { "name": "serviceStartDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `serviceStartDate` field.\n" }, { "name": "sku", "value": "", "type": "query", "description": "This parameter filters the response based on the `sku` field.\n" }, { "name": "skuName", "value": "", "type": "query", "description": "This parameter filters the response based on the `skuName` field.\n" }, { "name": "sourceItemId", "value": "", "type": "query", "description": "This parameter filters the response based on the `sourceItemId` field.\n" }, { "name": "subscriptionId", "value": "", "type": "query", "description": "This parameter filters the response based on the `subscriptionId` field.\n" }, { "name": "updatedById", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedById` field.\n" }, { "name": "updatedDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedDate` field.\n" }, { "name": "sort", "value": "", "type": "query", "description": "This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.\n\n - The `-` operator indicates an ascending order.\n - The `+` operator indicates a descending order.\n\nBy default, the response data is displayed in descending order by updated date.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n - id\n - amount\n - beAppliedAmount\n - sku\n - skuName\n - serviceStartDate\n - serviceEndDate\n - sourceItemId\n - createdDate\n - createdById\n - updatedDate\n - updatedById\n - subscriptionId\n \nExamples:\n\n- /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate\n\n- /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Retrieve a debit memo item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoKey/items/:dmitemid", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "dmitemid", "value": "", "type": "path", "description": "The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](/api-references/api/operation/GET_DebitMemoItems).\n" }, { "name": "debitMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "List all taxation items of a debit memo item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoId/items/:dmitemid/taxation-items", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "dmitemid", "value": "", "type": "path", "description": "The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](/api-references/api/operation/GET_DebitMemoItems).\n" }, { "name": "debitMemoId", "value": "", "type": "path", "description": "The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Generate a debit memo PDF file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoKey/pdfs", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "debitMemoKey", "value": "", "type": "path", "description": "The unique ID or number of the debit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Post a debit memo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoKey/post", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "debitMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Unpost a debit memo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoKey/unpost", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "debitMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Create taxation items for a debit memo", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoKey/taxationitems", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "debitMemoKey", "value": "", "type": "path", "description": "The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Generate an e-invoice file for a debit memo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/debitmemos/:debitMemoKey/einvoice/generate", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "debitMemoKey", "value": "", "type": "path", "description": "The ID or number of the debit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or DM-0000001.\n" } ] }, "docs": "Generates an e-invoice file for a debit memo.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n" } ] }, { "info": { "name": "Delivery Adjustments", "type": "folder" }, "items": [ { "info": { "name": "List all delivery adjustments of a subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/adjustments", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "subscription-number", "value": "", "type": "query", "description": "A subscription number.\n" } ] }, "docs": "Describes how to retrieve detailed information about delivery adjustments of a subscription.\n\n**Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in " }, { "info": { "name": "Create a delivery adjustment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/adjustments", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Describes how to create one or more delivery adjustments for a subscription. \n\n**Notes**: \n- The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowled" }, { "info": { "name": "Retrieve a delivery adjustment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/adjustments/:adjustment-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "adjustment-key", "value": "", "type": "path", "description": "The delivery adjustment ID or number to retrieve." } ] }, "docs": "Describes how to retrieve detailed information about a delivery adjustment.\n\n**Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Cen" }, { "info": { "name": "Preview a delivery adjustment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/adjustments/preview", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Describes how to preview delivery adjustments of a subscription.\n\n**Notes**: \n- The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center.\n- " }, { "info": { "name": "Cancel a delivery adjustment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/adjustments/:adjustmentId/cancel", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "adjustmentId", "value": "", "type": "path", "description": "The ID of the delivery adjustment to cancel.\n" } ] }, "docs": "Describes how to cancel an unbilled delivery adjustment.\n\n**Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center.\n" } ] }, { "info": { "name": "Describe", "type": "folder" }, "items": [ { "info": { "name": "Describe an object", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/describe/:object", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "object", "value": "", "type": "path", "description": "API name of an object in your Zuora tenant. For example, `InvoiceItem`. See [Zuora Object Model](/rest-api/general-concepts/object-model/) for the list of valid object names.\n\nDepending on the features enabled in your Zuora tenant, you may not be able to list the fields of some objects.\n" }, { "name": "showCurrencyConversionInformation", "value": "", "type": "query", "description": "Set the value to `yes` to get additional currency conversion information in the result.\n**Notes:** \n- When **Automatically include additional Currency Conversion information** in currency conversion settings is checked, you can pass `yes` to get additional fields in the result. See [Configure Foreign Currency Conversion](https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance/D_Finance_Settings/F_Foreign_Currency_Conversion#:~:text=Automatically%20include%20additional%20Currency%20Conversion%20information%20in%20data%20source%20exports%3A%C2%A0Select%20this%20check%20box%20if%20you%20want%20to%20access%20foreign%20currency%20conversion%20data%20through%20data%20source%20exports.) to check the **Automatically include additional Currency Conversion information**.\n- By default if you need additional Currency Conversion information, submit a request at Zuora Global Support. Set this parameter value to `no` to not include the additional currency conversion information in the result.\n" } ] }, "docs": "Provides a reference listing of each object that is available in your Zuora tenant.\n\nThe information returned by this call is useful if you are using [CRUD: Create Export](/api-references/api/operation/Object_POSTExport) or the [AQuA API](https://knowledgecenter.zuora.com/DC_Developers/T_Aggregate_Query_API) to create a data source export. See [Export ZOQL](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL) for more information.\n\n### Response\nThe response contains an XML document tha" } ] }, { "info": { "name": "E-Invoicing", "type": "folder" }, "items": [ { "info": { "name": "List e-invoicing service providers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/einvoice/service-providers", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Lists information about e-invoicing service providers.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n" }, { "info": { "name": "Create an e-invoicing service provider", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/einvoice/service-providers", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates an e-invoicing service provider.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n" }, { "info": { "name": "Retrieve an e-invoicing service provider", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/einvoice/service-providers/:key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "key", "value": "", "type": "path", "description": "The unique ID or number of the e-invoicing service provider that you want to retrieve information about.\n" } ] }, "docs": "Retrieves information about an e-invoicing service privider.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n" }, { "info": { "name": "Update an e-invoicing service provider", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/einvoice/service-providers/:key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "key", "value": "", "type": "path", "description": "The unique ID or number of the e-invoicing service provider that you want to update.\n" } ] }, "docs": "Updates information about an e-invoicing service privider.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n" }, { "info": { "name": "Delete an e-invoicing service provider", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/einvoice/service-providers/:key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "key", "value": "", "type": "path", "description": "The unique ID or number of the e-invoicing service provider that you want to \n" } ] }, "docs": "Deletes an e-invoicing service privider.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n" }, { "info": { "name": "List e-invoicing business regions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/einvoice/business-regions", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Lists information about e-invoicing business regions.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n" }, { "info": { "name": "Create an e-invoicing business region", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/einvoice/business-regions", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates an e-invoicing business region.\n\nYou must create business regions to store the business detail information as a seller. If you have multiple GSTINs for different states, you can create multiple business region objects for India.\n\nThe business region objects can be looked up according to the country and state, and its related fields can be mapped accordingly within the e-invoice file template.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n" }, { "info": { "name": "Update an e-invoicing business region", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/einvoice/business-regions/:key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "key", "value": "", "type": "path", "description": "The unqiue ID or number of the e-invoicing business region that you want to update.\n" } ] }, "docs": "Updates an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. \n" }, { "info": { "name": "Delete an e-invoicing business region", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/einvoice/business-regions/:key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "key", "value": "", "type": "path", "description": "The unqiue ID or number of the e-invoicing business region that you want to delete.\n" } ] }, "docs": "Deletes an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n" }, { "info": { "name": "List e-invoice file templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/einvoice/templates", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "country", "value": "", "type": "query", "description": "The short name of a country or region where you must comply with e-invoicing requirements. For example, `IN` for India. For the full list of country names and codes, see ISO Standard Country Codes.\n" }, { "name": "documentType", "value": "", "type": "query", "description": "The type of billing documents for which the e-invoice file template is intended.\n" }, { "name": "provider", "value": "", "type": "query", "description": "The name of the e-invoicing service provider that assists in generating e-invoice files. \n" } ] }, "docs": "Lists information about e-invoice file templates.\n\nYou can query e-invoice file templates by conditions. For example, if your service provider is Sovos, you can use the following example URL to retrieve information about a list of e-invoice file templates for invoices in India:\n`/v1/einvoice/templates?country=IN&documentType=Invoice&provider=Sovos`\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n" }, { "info": { "name": "Update an e-invoice file template", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/einvoice/templates/:key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "key", "value": "", "type": "path", "description": "The unique number or ID of the e-invoice file template that you want to update.\n" } ] }, "docs": "Updates information about an e-invoice file template.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n" }, { "info": { "name": "Delete an e-invoice file template", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/einvoice/templates/:key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "key", "value": "", "type": "path", "description": "The unique ID or number of the e-invoice file template that you want to delete.\n" } ] }, "docs": "Deletes an e-invoice file template by key. The key can be the unique ID or number of an e-invoice file template.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n" } ] }, { "info": { "name": "Electronic Payments Health", "type": "folder" }, "items": [ { "info": { "name": "List payment volume summary records", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/system-health/payments/volume-summary", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "paymentGatewayType", "value": "", "type": "query", "description": "Filters the volume summary by payment gateway type. Example: `Adyen`.\n" }, { "name": "paymentMethodType", "value": "", "type": "query", "description": "Filters the volume summary by payment method type. Example: `CreditCard`.\n" }, { "name": "startTime", "value": "", "type": "query", "description": "Start time of the volume summary.\n\nFormat: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`.\n" }, { "name": "endTime", "value": "", "type": "query", "description": "End time of the volume summary.\n\nFormat: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`.\n" } ] }, "docs": "Returns a summary of electronic payments handled by your Zuora tenant within a specified time range.\n\nYou can filter the summary by payment gateway type and payment method type.\n" } ] }, { "info": { "name": "Files", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/files/:file-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "file-id", "value": "", "type": "path", "description": "The Zuora ID of the file to retrieve.\n" } ] }, "docs": "Retrieve files such as export results, invoices, and accounting period reports.\n\nThe response content type depends on the type of file that you retrieve.\nFor example, if you retrieve an invoice PDF, the value of the `Content-Type`\nheader in the response is `application/pdf;charset=UTF-8`.\n\nOther content types include:\n\n- `text/csv` for CSV files\n- `application/msword` for Microsoft Word files\n- `application/vnd.ms-excel` and `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`\n f" } ] }, { "info": { "name": "Fulfillments", "type": "folder" }, "items": [ { "info": { "name": "Create fulfillments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/fulfillments", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "\nCreates 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:\n* [Create a sales order line item with fulfillments](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AD_Create_a_sales_order_line_item_with_fulfillments)\n* [Create a return order line item with fulfillments](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/" }, { "info": { "name": "Retrieve a fulfillment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/fulfillments/:key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "key", "value": "", "type": "path", "description": "The id or fulfillment number of the Fulfillment to retrieve." }, { "name": "fulfillment-items", "value": "", "type": "query", "description": "Return the related fulfillment items or not." } ] }, "docs": "Retrieves the detailed information about a specified fulfillment. The following tutorial demonstrates how to use this operation:\n* [View details of a fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/H_View_details_of_a_fulfillment)\n" }, { "info": { "name": "Update a fulfillment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/fulfillments/:key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "key", "value": "", "type": "path", "description": "The id or fulfillment number of the Fulfillment to update." } ] }, "docs": "\n\nUpdates 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.\nThe following tutorial demonstrates how to use this operation:\n* [Update or cancel a fulfillment](https://knowledgecen" }, { "info": { "name": "Delete a fulfillment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/fulfillments/:key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "key", "value": "", "type": "path", "description": "The id or fulfillment number of the Fulfillment to delete." } ] }, "docs": "Deletes a specified fulfillment. A fulfillment can only be deleted when it is in the `Executing` state.\n" }, { "info": { "name": "Create fulfillment items", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/fulfillment-items", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates one or multiple fulfillment items.\n" }, { "info": { "name": "Retrieve a fulfillment item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/fulfillment-items/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the Fulfillment Item to retrieve." } ] }, "docs": "Retrieves the detailed information about a specified fulfillment item. \n" }, { "info": { "name": "Update a fulfillment item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/fulfillment-items/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the Fulfillment Item to update." } ] }, "docs": "Updates a specified fulfillment item. \n" }, { "info": { "name": "Delete a fulfillment item", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/fulfillment-items/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the Fulfillment Item to delete." } ] }, "docs": "Deletes a specified fulfillment item.\n" } ] }, { "info": { "name": "Hosted Pages", "type": "folder" }, "items": [ { "info": { "name": "List hosted pages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/hostedpages", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "versionNumber", "value": "", "type": "query", "description": "Version of the Payment Pages for which you want to retrieve the configuration information. Specify 2 for Payment Pages 2.0.\n" } ] }, "docs": "Returns the Payment Pages configuration metadata,\nspecifically, page ID, page version, payment method type.\n\nThe following are the version-specific and general REST requests for Payment Pages:\n\n* The request for Payment Pages 2.0 configuration information: `GET /hostedpages?version=2`\n* The request for all versions of Payment Pages configuration information: `GET /hostedpages`\n\n### Notes\nIf you do not have the corresponding tenant setting enabled, such as specifying the request" } ] }, { "info": { "name": "Invoice Schedules", "type": "folder" }, "items": [ { "info": { "name": "Create an invoice schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/invoice-schedules", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates an invoice schedule.\n\n### Limitations\n\nThis API operation has the following limitations:\n* You can create at most 50 invoice schedule items in one request.\n* You can associate at most 10 orders with an invoice schedule in one request.\n* You can associate at most 300 subscriptions with an invoice schedule in one request, including those contained in orders and separate subscriptions.\n" }, { "info": { "name": "Retrieve an invoice schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/invoice-schedules/:scheduleKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "scheduleKey", "value": "", "type": "path", "description": "The unique ID or number of the invoice schedule to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n" } ] }, "docs": "Retrieves detailed information about an invoice schedule.\n" }, { "info": { "name": "Update an invoice schedule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/invoice-schedules/:scheduleKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "scheduleKey", "value": "", "type": "path", "description": "The unique ID or number of the invoice schedule to be updated. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n" } ] }, "docs": "Updates a pending invoice schedule.\n\nYou can use this API operation to update invoice schedules in the following aspects:\n- Update notes and pending invoice schedule items\n- Update orders associated with invoice schedules\n- Remove or add invoice schedule items\n\nFor more samples, see [Edit invoice schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule/Billing_Schedule_tutorials/Edit_invoice_schedules).\n\n### Restrictions and limitations \n\nWhen updating invoice s" }, { "info": { "name": "Delete an invoice schedule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/invoice-schedules/:scheduleKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "scheduleKey", "value": "", "type": "path", "description": "The unique ID or number of the invoice schedule to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n" } ] }, "docs": "Deletes an invoice schedule in Pending status. The status of the invoice schedule to be deleted must be `Pending`.\n" }, { "info": { "name": "Pause an invoice schedule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/invoice-schedules/:scheduleKey/pause", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "scheduleKey", "value": "", "type": "path", "description": "The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n" } ] }, "docs": "Pauses an invoice schedule immediately.\n\nAfter one invoice schedule is paused, it cannot be automatically executed by Zuora Scheduler or by the [Execute an invoice schedule](/api-references/api/operation/POST_ExecuteInvoiceSchedule/) API operation.\n\nIf you want to run a paused invoice schedule, you can create a bill run with the target date greater than the next run date of the invoice schedule.\n" }, { "info": { "name": "Resume an invoice schedule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/invoice-schedules/:scheduleKey/resume", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "scheduleKey", "value": "", "type": "path", "description": "The unique ID or number of the schedule to be resumed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n" } ] }, "docs": "Resumes an invoice schedule in Paused status immediately.\n\nAfter an invoice schedule is resumed, it can continue to be automatically executed by Zuora Scheduler or by the [Execute an invoice schedule](/api-references/api/operation/POST_ExecuteInvoiceSchedule/) API operation.\n" }, { "info": { "name": "Execute an invoice schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/invoice-schedules/:scheduleKey/execute", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "scheduleKey", "value": "", "type": "path", "description": "The unique ID or number of the schedule to be executed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n" } ] }, "docs": "Executes an invoice schedule immediately.\n\nDuring the execution, a bill run is created and generates an invoice or a credit memo asynchronously.\n\nWhen you use this API operation to execute an invoice schedule item, you have the flexibility to decide whether to specify a specific item ID.\n\n- If you specify the unique ID of an invoice schedule item to be executed in the request, the corresponding invoice schedule item is executed.\n- If you do not specify the ID of any invoice schedule item in the " } ] }, { "info": { "name": "Invoices", "type": "folder" }, "items": [ { "info": { "name": "Create standalone invoices", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/invoices/batch", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates multiple standalone invoices for selling physical goods, services or other items on a non-recurring basis to your subscription customers.\n\nTo use this operation, you must have the \"Create Standalone Invoice\" and \"Modify Invoice\" user permissions. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. As of Zuora Release 2022.03.R5, newly created standard Billing users have the “Create St" }, { "info": { "name": "Create a standalone invoice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/invoices", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates a standalone invoice for selling physical goods, services or other items on a non-recurring basis to your subscription customers.\n\nTo use this operation, you must have the \"Create Standalone Invoice\" and \"Modify Invoice\" user permissions. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. As of Zuora Release 2022.03.R5, newly created standard Billing users have the “Create Standalone" }, { "info": { "name": "Update invoices", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/invoices", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Updates multiple invoices in batches with one call. \n\n### Limitations \nThis operation has the following limitations:\n* You can update a maximum of 50 invoices by one call.\n" }, { "info": { "name": "Post invoices", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/invoices/bulk-post", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Posts multiple invoices.\n\nYou can post a maximum of 50 invoices in one single request. Additionally, you can also update invoice dates while posting the invoices.\n" }, { "info": { "name": "Retrieve an invoice", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/invoices/:invoiceKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "invoiceKey", "value": "", "type": "path", "description": "The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n" } ] }, "docs": "Retrieves a specific invoice.\n" }, { "info": { "name": "Update an invoice", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/invoices/:invoiceKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "invoiceKey", "value": "", "type": "path", "description": "The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n" } ] }, "docs": "Updates a specific invoice. \n" }, { "info": { "name": "Delete an invoice", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/invoices/:invoiceKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "invoiceKey", "value": "", "type": "path", "description": "The ID or number of the invoice to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n" } ] }, "docs": "Deletes a specific invoice.\n\nWhether to delete an invoice synchronously or asynchronously depends on the number of invoice items contained in the invoice. By default, if an invoice contains less than 100 items, the invoice is deleted synchronously. Otherwise, the invoice is deleted asynchronously. If you want to change the threshold, submit a request at Zuora Global Support.\n" }, { "info": { "name": "List all application parts of an invoice", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/invoices/:invoiceKey/application-parts", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "invoiceKey", "value": "", "type": "path", "description": "The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Email an invoice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/invoices/:invoiceKey/emails", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "invoiceKey", "value": "", "type": "path", "description": "The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n" } ] }, "docs": "Sends a posted invoice to the specified email addresses manually.\n### Notes\n - You must activate the **Manual Email For Invoice | Manual Email For Invoice** notification before emailing invoices. To include the invoice PDF in the email, select the **Include Invoice PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more informa" }, { "info": { "name": "List all files of an invoice", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/invoices/:invoiceKey/files", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "invoiceKey", "value": "", "type": "path", "description": "The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n" } ] }, "docs": "Retrieves the information about all PDF files of a specified invoice. \n\nInvoice PDF files are returned in reverse chronological order by the value of the `versionNumber` field.\n**Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response.\nYou can use the [Query](/api-references/api/operation/Action_POSTquery) action to get the latest PDF file, for example: `\"select Body from Invoice where Id = '2c9380" }, { "info": { "name": "Upload a file for an invoice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/invoices/:invoiceKey/files", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "invoiceKey", "value": "", "type": "path", "description": "The ID or number of the invoice that you want to upload a PDF file for. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n" } ] }, "docs": "Uploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status.\nTo use this operation, you must enable the Modify Invoice permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\nThis operation has the following restrictions:\n- Only the PDF file format is supported.\n- The maximum size of the PDF file to upload is 4 MB.\n- A maximum of 50 PDF files " }, { "info": { "name": "List all items of an invoice", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/invoices/:invoiceKey/items", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "invoiceKey", "value": "", "type": "path", "description": "The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n" } ] }, "docs": "Retrieves the information about all items of a specified invoice. \n" }, { "info": { "name": "List all taxation items of an invoice item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/invoices/:invoiceKey/items/:itemId/taxation-items", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "invoiceKey", "value": "", "type": "path", "description": "The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n" }, { "name": "itemId", "value": "", "type": "path", "description": "The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef.\n" } ] }, "docs": "Retrieves information about the taxation items of a specific invoice item. \n" }, { "info": { "name": "Reverse an invoice", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/invoices/:invoiceKey/reverse", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "invoiceKey", "value": "", "type": "path", "description": "The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Write off an invoice", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/invoices/:invoiceKey/write-off", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "invoiceKey", "value": "", "type": "path", "description": "The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Create taxation items for an invoice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/invoices/:invoiceKey/taxationitems", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "invoiceKey", "value": "", "type": "path", "description": "The unique ID or number of an invoice. For example, 8a8082e65b27f6c3015ba45ff82c7172 or INV00000001.\n" } ] }, "docs": "Creates taxation items for an invoice.\n" }, { "info": { "name": "Generate an e-invoice file for an invoice", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/invoices/:invoiceKey/einvoice/generate", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "invoiceKey", "value": "", "type": "path", "description": "The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n" } ] }, "docs": "Generates an e-invoice file for an invoice.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n" } ] }, { "info": { "name": "Journal Runs", "type": "folder" }, "items": [ { "info": { "name": "Create a journal run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/journal-runs", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "This REST API reference describes how to create a journal run. Request and response field descriptions and sample code are provided.\n" }, { "info": { "name": "Retrieve a journal run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/journal-runs/:jr-number", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "jr-number", "value": "", "type": "path", "description": "Journal run number. Must be a valid journal run number in the format `JR-00000001`.\n" } ] }, "docs": "This REST API reference describes how to get information about a journal run. Request and response field descriptions and sample code are provided.\n" }, { "info": { "name": "Delete a journal run", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/journal-runs/:jr-number", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "jr-number", "value": "", "type": "path", "description": "Journal run number. Must be a valid journal run number in the format `JR-00000001`.\n" } ] }, "docs": "This reference describes how to delete a journal run using the REST API.\n \n You can only delete journal runs that have already been canceled.\n \n You must have the \"Delete Cancelled Journal Run\" Zuora Finance user permission enabled to delete journal runs.\n" }, { "info": { "name": "Cancel a journal run", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/journal-runs/:jr-number/cancel", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "jr-number", "value": "", "type": "path", "description": "Journal run number. Must be a valid journal run number in the format JR-00000001. \nYou can only cancel a journal run whose status is \"Pending\", \"Error\", or \"Completed\".\n" } ] }, "docs": "This reference describes how to cancel a journal run using the REST API.\n \nThe summary journal entries in the journal run are canceled asynchronously. See the \"Example\" section below for details.\n \nYou must have the \"Cancel Journal Run\" Zuora Finance user permission enabled to cancel journal runs.\n\n### Notes\nWhen you cancel a journal run, the summary journal entries associated with that journal run are canceled asynchronously. A response of `{ \"success\": true }` means only that" } ] }, { "info": { "name": "Mass Updater", "type": "folder" }, "items": [ { "info": { "name": "Perform a mass action", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/bulk", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Describes how to perform a mass action through the REST API. \n\nUsing this API method, you send a multipart/form-data request containing a `.csv` file with data about the mass action you want to perform. Zuora returns a key and then asynchronously processes the mass action. You can use the key to get details about the result of the mass action.\n\nIf you want to use this operation to perform the Mass Payment Upload (MPU) mass action, see [Mass Payment Upload](https://knowledgecenter.zuora.com/Billi" }, { "info": { "name": "List all results of a mass action", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/bulk/:bulk-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "bulk-key", "value": "", "type": "path", "description": "String of 32 characters that identifies a mass action. You get the bulk-key after performing a mass action through the REST API.\n" } ] }, "docs": "Describes how to get information about the result of a mass action through the REST API. \n" }, { "info": { "name": "Stop a mass action", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/bulk/:bulk-key/stop", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "bulk-key", "value": "", "type": "path", "description": "String of 32 characters that identifies a mass action. You get the bulk-key after performing a mass action through the REST API.\n" } ] }, "docs": "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.\n\n- If you stop a mass action when its status is Pending, no response file is generated because no records have been processed.\n\n- If you stop a mass action when its status is Processing, a response file is generated. You can check the response file to see which rec" } ] }, { "info": { "name": "Notifications", "type": "folder" }, "items": [ { "info": { "name": "List notification definitions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/notifications/notification-definitions", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "start", "value": "", "type": "query", "description": "The first index of the query result." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results the query should return." }, { "name": "profileId", "value": "", "type": "query", "description": "Id of the profile." }, { "name": "eventTypeName", "value": "", "type": "query", "description": "The name of the event." }, { "name": "emailTemplateId", "value": "", "type": "query", "description": "The ID of the email template." } ] }, "docs": "Queries notification definitions with the specified filters.\n\n**Note**: This operation is only applicable to notifications for custom events and custom scheduled events. You can use the Settings API to list all notifications under a particular communication profile including notificatiions for standard events. For more information, see [Get all notifications under a particular communication profile](https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/BB_C_Settings_API/Settings_API_tutor" }, { "info": { "name": "Create a notification definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/notifications/notification-definitions", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates a notification definition. If a filter rule is specified, it will be evaluated to\nsee if the notification definition is qualified to handle the incoming events \nduring runtime. If the notification is qualified, it will send the email and\ninvoke the callout if it has an email template or a callout. \n\n**Note**: This operation is only applicable to notifications for custom events and custom scheduled events.\n" }, { "info": { "name": "Retrieve a notification definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/notifications/notification-definitions/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the notification definition." } ] }, "docs": "Queries the notification definition of the given ID.\n\n**Note**: This operation is only applicable to notifications for custom events and custom scheduled events. You can use the Settings API to retrieve notifications for standard events. For more information, see [Get a notification definition](https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/BB_C_Settings_API/Settings_API_tutorials/Get_a_notification_definition).\n" }, { "info": { "name": "Update a notification definition", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/notifications/notification-definitions/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the notification definition to be updated." } ] }, "docs": "Updates a notification definition.\n\n**Note**: This operation is only applicable to notifications for custom events and custom scheduled events. You can use the Settings API to update notifications for standard events. For more information, see [Update a notification definition](https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/BB_C_Settings_API/Settings_API_tutorials/Update_a_notification_definition).\n" }, { "info": { "name": "Delete a notification definition", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/notifications/notification-definitions/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the notification definition to be deleted." } ] }, "docs": "Deletes a notification definition.\n\n**Note**: This operation is only applicable to notifications for custom events and custom scheduled events. You can use the Settings API to delete notifications for standard events. For more information, see [Delete a notification definition](https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/BB_C_Settings_API/Settings_API_tutorials/Delete_a_notification_definition).\n" }, { "info": { "name": "List email templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/notifications/email-templates", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "start", "value": "", "type": "query", "description": "The first index of the query result." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results the query should return." }, { "name": "eventCategory", "value": "", "type": "query", "description": "The event category code for standard events." }, { "name": "eventTypeName", "value": "", "type": "query", "description": "The name of the custom event or custom scheduled event." }, { "name": "name", "value": "", "type": "query", "description": "The name of the email template." } ] }, "docs": "Queries email templates. This operation supports querying email templates for all event types.\n" }, { "info": { "name": "Create an email template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/notifications/email-templates", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates an email template. \n\nThis operation supports creating the email template for all event types.\n\n- If you specify the `eventCategory` field, the email template is created based on a standard event. See [Standard Event Categories](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Notification_Histories_API) for all standard event category codes.\n- If you specify the `eventTypeName` field, the email template is created based o" }, { "info": { "name": "Create or update email templates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/notifications/email-templates/import", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "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.\n\nFor each email template when you are creating email templates, whether the template is created for a standard event, a custom event, or a custom scheduled event is dependent on whether you specify the `eventCategory` or `eventTypeName` field.\n\n- If you specify the `eventCategory` field, the email template is created based on" }, { "info": { "name": "Retrieve an email template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/notifications/email-templates/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the email template." } ] }, "docs": "Queries the email template based on the specified ID. This operation supports retrieving the email template for all event types.\n" }, { "info": { "name": "Update an email template", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/notifications/email-templates/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the email template to be updated." } ] }, "docs": "Updates an email template. This operation supports updating the email template for all event types.\n" }, { "info": { "name": "Delete an email template", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/notifications/email-templates/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the email template to be deleted." } ] }, "docs": "Deletes an email template. This operation supports deleting an email template for all event types.\n" }, { "info": { "name": "Delete notification histories for an account", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/notifications/history", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "query", "description": "The ID of the account whose notification histories are to be deleted." } ] }, "docs": "Delete all notification histories for the given account. All email and callout notifications for this account will be deleted upon successful operation.\n" }, { "info": { "name": "Retrieve a notification history deletion task", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/notifications/history/tasks/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the notification history deletion task. You can get the deletion task ID from the 202 response body of the [Delete notification histories for an account](/api-references/api/operation/DELETE_Delete_Notification_History_For_Account) operation.\n" } ] }, "docs": "Get the notification history deletion task by ID.\n" }, { "info": { "name": "Resend email notifications", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/notifications/email-histories/resend", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Resends email notifications if your customers did not receive previous email notifications.\n\nDetails about the status codes and response contents of this operation are as follows:\n\n| Scenario | Status code | Response content |\n|----------------------------------------|-----------------|-------------------------------------------------------------|\n| Success for all notifications | 202 Accepted | (blank) " }, { "info": { "name": "Resend callout notifications", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/notifications/callout-histories/resend", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Resends callout notifications if your customers did not receive previous callout notifications.\n\nDetails about the status codes and response contents of this operation are as follows:\n\n| Scenario | Status code | Response content |\n|----------------------------------------|-----------------|-------------------------------------------------------------|\n| Success for all notifications | 202 Accepted | (blank) " }, { "info": { "name": "List callout notification histories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/notification-history/callout", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The final date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss." }, { "name": "startTime", "value": "", "type": "query", "description": "The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss." }, { "name": "objectId", "value": "", "type": "query", "description": "The ID of an object that triggered a callout notification. \n" }, { "name": "failedOnly", "value": "", "type": "query", "description": "If `true`, only return failed records. If `false`, return all records in the given date range. The default value is `true`.\n" }, { "name": "eventCategory", "value": "", "type": "query", "description": "Category of records to be returned by event category.\n\nThe following formats are supported:\n* `{Event Type Namespace}:{Event Type Name}` if the Custom Events feature is enabled in your tenant. For example: `user.notification:NewSubscriptionCreated`.\n* Numeric code of the event category if the Custom Events feature is not enabled in your tenant. For example, `1210`. See [Event Category Code](https://knowledgecenter.zuora.com/DC_Developers/AA_REST_API/Event_Categories_for_Notification_Histories) for more information.\n" }, { "name": "includeResponseContent", "value": "", "type": "query" } ] }, "docs": "Describes how to get a notification history for callouts.\n" }, { "info": { "name": "List email notification histories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/notification-history/email", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "accountId", "value": "", "type": "query", "description": "ID of an account. By specifying this query parameter, you can filter email notification histories by account." }, { "name": "endTime", "value": "", "type": "query", "description": "The end date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss. The maximum date range (endTime - startTime) is three days." }, { "name": "startTime", "value": "", "type": "query", "description": "The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss. The maximum date range (endTime - startTime) is three days." }, { "name": "objectId", "value": "", "type": "query", "description": "The Id of an object that triggered an email notification.\n" }, { "name": "failedOnly", "value": "", "type": "query", "description": "If `true`, only returns failed records. When `false`, returns all records in the given date range. Defaults to `true` when not specified.\n" }, { "name": "eventCategory", "value": "", "type": "query", "description": "Category of records to be returned by event category.\n\nThe following formats are supported:\n* `{Event Type Namespace}:{Event Type Name}` if the Custom Events feature is enabled in your tenant. For example: `user.notification:NewSubscriptionCreated`.\n* Numeric code of the event category if the Custom Events feature is not enabled in your tenant. For example, `1210`. See [Event Category Code](https://knowledgecenter.zuora.com/DC_Developers/AA_REST_API/Event_Categories_for_Notification_Histories) for more information.\n" } ] }, "docs": "Describes how to get a notification history for notification emails.\n\n\n### Notes\nRequest parameters and their values may be appended with a \"?\" following the HTTPS GET request. Additional request parameter are separated by \"&\". \n\nFor example:\n\n`GET https://rest.zuora.com/v1/notification-history/email?startTime=2015-01-12T00:00:00&endTime=2015-01-15T00:00:00&failedOnly=false&eventCategory=1000&pageSize=1`\n" } ] }, { "info": { "name": "OAuth", "type": "folder" }, "items": [ { "info": { "name": "Create an OAuth token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/oauth/token", "headers": [ { "name": "Zuora-Track-Id", "value": "" } ] }, "docs": "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](/rest-api/general-concepts/authentication/) for more information.\n\n**Note:** When using this operation, do not set any authentication headers such as `Authorization`, `apiAccessKeyId`, or `apiSecretAccessKey`.\n\nYou should not use this operation to generate a large number of bearer tokens in a short period of time; each token" } ] }, { "info": { "name": "Offers", "type": "folder" }, "items": [ { "info": { "name": "List offers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/offers", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" } ] }, "docs": "Retrieves basic information about all offers.\n\n**Note**: This operation is in the **Beta** phase.\n" }, { "info": { "name": "Create an offer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/offers", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates an offer.\n\n**Note**: This operation is in the **Beta** phase.\n" }, { "info": { "name": "Retrieve an offer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/offers/:offer-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "offer-key", "value": "", "type": "path", "description": "The unique number or ID of the offer to be retrieved.\n" } ] }, "docs": "Retrieves basic information about an offer.\n\n**Note**: This operation is in the **Beta** phase.\n" }, { "info": { "name": "Delete an offer", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/offers/:offer-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "offer-key", "value": "", "type": "path", "description": "The unique number or ID of the offer to be deleted.\n" } ] }, "docs": "Deletes an offer.\n\n**Note**: This operation is in the **Beta** phase.\n \n" } ] }, { "info": { "name": "Custom Payment Method Types", "type": "folder" }, "items": [ { "info": { "name": "Create a draft custom payment method type", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/open-payment-method-types", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "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](/api-references/api/operation/PUT_UpdateOpenPaymentMethodType/) operation. You must publish your draft version through the [Publish a custom payment method type](/api-references/api/operation/PUT_PublishOpenPaymentMethodType/) operation before your custom payment method type goes live.\n" }, { "info": { "name": "Publish a custom payment method type", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/open-payment-method-types/publish/:paymentMethodTypeName", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentMethodTypeName", "value": "", "type": "path", "description": "The API name of the custom payment method type, such as `AmazonPay__c_12368`.\n" } ] }, "docs": "Publish the latest draft revision of a specific custom payment method type.\n" }, { "info": { "name": "Update a custom payment method type", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/open-payment-method-types/:paymentMethodTypeName", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentMethodTypeName", "value": "", "type": "path", "description": "The API name of the custom payment method type, such as `AmazonPay__c_12368`.\n" } ] }, "docs": "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](/api-references/api/operation/PUT_PublishOpenPaymentMethodType/) operation before your updated custom payment method type goes live.\n\n**Note:** In the request body, you need to provide all the fields that define thi" }, { "info": { "name": "Retrieve a specific draft revision of a custom payment method type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/open-payment-method-types/:paymentMethodTypeName/draft/:revisionNumber", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentMethodTypeName", "value": "", "type": "path", "description": "The API name of the custom payment method type, such as `AmazonPay__c_12368`.\n" }, { "name": "revisionNumber", "value": "", "type": "path", "description": "The revision number of the draft revision to be retrieved.\n" } ] }, "docs": "Retrieves a specific draft revision of a custom payment method type.\n" }, { "info": { "name": "Retrieve a published custom payment method type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/open-payment-method-types/:paymentMethodTypeName/published", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentMethodTypeName", "value": "", "type": "path", "description": "The API name of the custom payment method type, such as `AmazonPay__c_12368`.\n" } ] }, "docs": "Retrieves a published custom payment method type.\n" } ] }, { "info": { "name": "Operations", "type": "folder" }, "items": [ { "info": { "name": "Invoice and collect", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/operations/invoice-collect", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ] }, "docs": "Generates and posts invoices and credit memos and collects payments for posted invoices. Credit memos are only available if you have the Invoice Settlement feature enabled and negative charges exist. Credit memos will not be applied to invoices. If draft invoices and credit memos exist when you run this operation, this operation will post the invoices and credit memos. Note that draft credit memos created from an invoice or a product rate plan charge will not be posted.\n\nYou can use this operati" }, { "info": { "name": "Generate a billing preview", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/operations/billing-preview", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "\nGenerates 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.\n\nAdditionally, you can use the BillingPreview service to access real-time data on an individual customer's usage consumption. \n\nThe BillingPreview call only calculates taxes for charges in the subscription if you use [Zuora Tax](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Retrieve an operation job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/operations/jobs/:jobId", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the operation job to retrieve information about. For example, 2c92c8955bd63cc1015bd7c151af02ab.\n" } ] }, "docs": "Retrieves information about a specific operation job.\n\nCurrently, you can only use this API operation to retrieve the status information about invoice deletion operation jobs.\n" } ] }, { "info": { "name": "Order Actions", "type": "folder" }, "items": [ { "info": { "name": "Update an order action", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/orderActions/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the Order Action to update." } ] }, "docs": "Updates the change reason and custom fields for an order action." } ] }, { "info": { "name": "Order Line Items", "type": "folder" }, "items": [ { "info": { "name": "Retrieve an order line item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/order-line-items/:itemId", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "itemId", "value": "", "type": "path", "description": "The id of the Order Line Item to retrieve." }, { "name": "fulfillment", "value": "", "type": "query", "description": "Return the related fulfillments or not.\n" } ] }, "docs": "**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As" }, { "info": { "name": "Update an order line item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/order-line-items/:itemId", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "itemId", "value": "", "type": "path", "description": "The id of the Order Line Item to update." } ] }, "docs": "**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As" }, { "info": { "name": "Update order line items", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/order-line-items/bulk", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As" } ] }, { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Preview an order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/orders/preview", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "**Notes**:\n - This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Subscribe and Amend customer, we recommend you enable Subscribe and Amend customer, we recommend you enable Subscribe and Amend customer, we recommend you enable Subscribe and Amend customer, we recommend you enable Subscribe and Amend customer, we recommend you enable Subscribe and Amend customer, we recommend you enable Subscribe and Amend customer, we recommend you enable Subscribe and Amend customer, we recommend you enable Subscribe and Amend customer, we recommend you enable Subscribe and Amend customer, we recommend you enable Delayed Capture.\n" } ] }, { "info": { "name": "Payment Gateway Reconciliation", "type": "folder" }, "items": [ { "info": { "name": "Settle a payment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/gateway-settlement/payments/:payment-key/settle", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "payment-key", "value": "", "type": "path", "description": "The payment number starting with \"P-\" or the unique payment ID." } ] }, "docs": "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.\n\nIf the Asynchronous Payment Statuses feature is enabled, for ACH and Bank Transfer payments, this API operation sets the Payment Status field to `Processed` and " }, { "info": { "name": "Reject a payment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/gateway-settlement/payments/:payment-key/reject", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "payment-key", "value": "", "type": "path", "description": "The payment number starting with \"P-\" or the unique payment ID." } ] }, "docs": "If the Asynchronous Payment Statuses feature is not enabled, this API operation sets the Gateway State field of the payment to `FailedToSettle`, creates a refund for the payment amount, and returns the Refund object as response.\n\nIf the Asynchronous Payment Statuses feature is enabled, for ACH and Bank Transfer payments, this API operation s" }, { "info": { "name": "Reverse a payment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/gateway-settlement/payments/:payment-key/chargeback", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "payment-key", "value": "", "type": "path", "description": "The payment number starting with \"P-\" or the unique payment ID." } ] }, "docs": "If the Asynchronous Payment Statuses feature is not enabled, this API operation sets the Gateway State field of the payment to `Settled`, creates a refund for the amount specified in the request, and returns the Refund object as response.\n\nIf the Asynchronous Payment Statuses feature is enabled, for ACH and Bank Transfer payments that are re" }, { "info": { "name": "Reconcile a refund", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/refunds/:refund-key/reconcile", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "refund-key", "value": "", "type": "path", "description": "The refund number starting with “R-” or the unique refund ID." } ] }, "docs": "Reconciles a refund when receiving the gateway reconciliation request or event.\n" } ] }, { "info": { "name": "Payment Gateways", "type": "folder" }, "items": [ { "info": { "name": "List all payment gateways", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/paymentgateways", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Retrieves the basic information about all the payment gateways.\n" } ] }, { "info": { "name": "Payment Method Updater", "type": "folder" }, "items": [ { "info": { "name": "Create a Payment Method Updater batch asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-method-updaters/batches", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates a Payment Method Updater (PMU) batch asynchronously. PMU for American Express (AMEX) is not supported.\n" }, { "info": { "name": "List Payment Method Updater instances", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-method-updaters", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Retrieves the detailed information of all Payment Method Updater (PMU) instances on your tenant, except for American Express (AMEX).\n" } ] }, { "info": { "name": "Payment Methods", "type": "folder" }, "items": [ { "info": { "name": "Create a payment method", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-methods", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "You can use this operation to create either a payment method associated with a specific customer account, or an orphan payment method that is not associated with any customer account. The orphan payment method must be associated with a customer account within 10 days. Otherwise, it will be deleted.\n\nThis operation supports the payment methods listed below.\n \n### Credit Card\nThe following request body fields are applicable to this payment method:\n* `cardHolderInfo` (`cardHolderName` requir" }, { "info": { "name": "Create an Apple Pay payment method", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-methods/decryption", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "The decryption API endpoint can conditionally perform 4 tasks in one atomic call:\n * Decrypt Apple Pay Payment token\n * Create Credit Card Payment Method in Zuora with decrypted Apple Pay information\n * Create a stored credential profile within the Apple Pay payment method\n * Process Payment on a specified Invoice (optional)\n" }, { "info": { "name": "Retrieve a payment method", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-methods/:payment-method-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "payment-method-id", "value": "", "type": "path", "description": "Unique ID of the payment method to update." } ] }, "docs": "This operation allows you to get the detailed information about a payment method.\n\n**Note:** This operation also supports retrieving the custom payment method created through the [Open Payment Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) service.\n" }, { "info": { "name": "Update a payment method", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payment-methods/:payment-method-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "payment-method-id", "value": "", "type": "path", "description": "Unique ID of the payment method to update." } ] }, "docs": "This operation allows you to update an existing payment method. \n\nThe following request body fields can be updated for any payment method types except for Credit Card Reference Transaction:\n* `authGateway`\n* `gatewayOptions`\n* `accountHolderInfo`\n* `ipAddress`\n* Custom fields\n\nThe following request body fields can be updated only for the Credit Card payment method:\n* `expirationMonth` \n* `expirationYear`\n* `securityCode`\n\nThe following request body field can be updated for the Credit Card, Credi" }, { "info": { "name": "Delete a payment method", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/payment-methods/:payment-method-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "payment-method-id", "value": "", "type": "path", "description": "Unique identifier of a payment method. (Since this ID is unique, and linked to a customer account in the system, no customer identifier is needed.)" } ] }, "docs": "Deletes a credit card payment method.\n\nIf the specified payment method is the account's default payment\nmethod, the request will fail. In that case, you must first designate a\ndifferent payment method for that customer to be the default.\n" }, { "info": { "name": "Verify a payment method", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payment-methods/:payment-method-id/verify", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "payment-method-id", "value": "", "type": "path", "description": "The ID of the payment method to be verified.\n" } ] }, "docs": "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.\n\nZuora now supports performing a standalone zero dollar verification or one dollar authorization for credit cards. It also supports a billing agreement status check on PayPal payment methods.\n\nIf a payment method is created by Hosted Payment Pages and is not assigned to any billing account," }, { "info": { "name": "Scrub a payment method", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payment-methods/:payment-method-id/scrub", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "payment-method-id", "value": "", "type": "path", "description": "The ID of the payment method where you want to scrub the sensitive data.\n" } ] }, "docs": "\nThis 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. \n\nThis operation will scrub the sensitive data and soft-delete the specified payment method at the same time. \n\nIf you want to delete or anonymize personal data in Zuora, you must scrub the payment method before anonymizing the associated account and contact. See [Delete or anonymize personal da" }, { "info": { "name": "List stored credential profiles of a payment method", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-methods/:payment-method-id/profiles", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "payment-method-id", "value": "", "type": "path", "description": "ID of a payment method.\n" }, { "name": "includeAll", "value": "", "type": "query", "description": "Specifies whether to retrieve all the stored credential profiles within the payment method.\n\nBy default, Zuora returns only the stored credential profiles with `Agreed` or `Active` status. If you set this parameter to `true`, Zuora returns all the stored credential profiles.\n" } ] }, "docs": "Retrieves the stored credential profiles within a payment method.\n" }, { "info": { "name": "Create a stored credential profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-methods/:payment-method-id/profiles", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "payment-method-id", "value": "", "type": "path", "description": "ID of a payment method.\n" } ] }, "docs": "Creates a stored credential profile within a payment method.\n\nThe stored credential profile represents a consent agreement that you have established with a customer. When you use the payment method in a transaction, Zuora may include information from the stored credential profile to inform the payment processor that the transaction is related to your pre-existing consent agreement with the customer.\n" }, { "info": { "name": "Cancel a stored credential profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-methods/:payment-method-id/profiles/:profile-number/cancel", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "payment-method-id", "value": "", "type": "path", "description": "ID of a payment method.\n" }, { "name": "profile-number", "value": "", "type": "path", "description": "Number that identifies a stored credential profile within the payment method.\n" } ] }, "docs": "Cancels a stored credential profile within a payment method.\n\nCancelling the stored credential profile indicates that the stored credentials are no longer valid, per a customer request. You cannot reactivate the stored credential profile after you have cancelled it.\n" }, { "info": { "name": "Expire a stored credential profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-methods/:payment-method-id/profiles/:profile-number/expire", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "payment-method-id", "value": "", "type": "path", "description": "ID of a payment method.\n" }, { "name": "profile-number", "value": "", "type": "path", "description": "Number that identifies a stored credential profile within the payment method.\n" } ] }, "docs": "Expires a stored credential profile within a payment method.\n\nExpiring the stored credential profile indicates that the stored credentials are no longer valid, per an expiration policy in the stored credential transaction framework. You cannot reactivate the stored credential profile after you have expired it.\n" }, { "info": { "name": "List registered Apple Pay domains", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/payment-methods/apple-pay/domains", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "domainName", "value": "", "type": "query", "description": "Specifies a domain name such as `zuora.com` and the registered domains containing the specified domain name will be returned. \n\nFor example, `test1.zuora.com` and `test2.zuora.com` are two registered domains, but `zuora.com` is not registered. If you specify `zuora.com` in this query field, the data of `test1.zuora.com` and `test2.zuora.com` will be returned.\n" } ] }, "docs": "Use this operation to retrieve details of your domains that are already registered with Apple for Apple Pay button integration implemented through Zuora's JavaScript SDK.\n\nYou can use `domainName` as the query parameter to restrict domains returned in the response. Specify a domain name and the registered domains containing the specified domain name will be returned.\n\nFor more information about Zuora's JavaScript SDK for Apple Pay integration, see " }, { "info": { "name": "Unregister an Apple Pay domain", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/payment-methods/apple-pay/domains/:id", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the domain, such as `402881a38924ff1001892502da090021`." } ] }, "docs": "Use this operation to unregister a domain with Apple for Apple Pay button integration implemented through Zuora's JavaScript SDK.\n\nFor more information about Zuora's JavaScript SDK for Apple Pay integration, see Set up Apple Pay through the JavaScript SDK approach.\n" }, { "info": { "name": "Create a payment session", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/web-payments/sessions", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "When implementing Apple Pay integration by using Zuora's JavaScript SDK, use this operation to create a payment session on your server side. The response of this API operation contains a token for the payment session data. Send the token back to your client side to use in the subsequent implementation step. For more information, see [Set up Apple Pay through the JavaScript SDK approach](https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B_Define_Payment_Methods/Set_up_Apple_Pay_for" } ] }, { "info": { "name": "Payment Runs", "type": "folder" }, "items": [ { "info": { "name": "List payment runs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-runs", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "createdById", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdById` field.\n" }, { "name": "createdDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdDate` field.\n" }, { "name": "status", "value": "", "type": "query", "description": "This parameter filters the response based on the `status` field.\n" }, { "name": "targetDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `targetDate` field.\n" }, { "name": "updatedById", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedById` field.\n" }, { "name": "updatedDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedDate` field.\n" }, { "name": "sort", "value": "", "type": "query", "description": "This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.\n\n - The `-` operator indicates an ascending order.\n - The `+` operator indicates a descending order.\n\nBy default, the response data is displayed in descending order by payment run number.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n - targetDate\n - status\n - createdDate\n - createdById\n - updatedDate\n - updatedById\n\nExamples:\n\n- /v1/payment-runs?sort=+createdDate\n\n- /v1/payment-runs?status=Processing&sort=-createdById,+targetDate\n" } ] }, "docs": "Retrieves the information about all payment runs. You can define filterable fields to restrict the data returned in the response.\n\n### Filtering\n\nYou can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body.\n\nIf the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. \n\nExamples:\n\n- /v1/" }, { "info": { "name": "Create a payment run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-runs", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "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.\n\nTo filter the payments to be collected for a payment run, you can use either of the following methods but not both:\n\n - Use the `accountId`, `batch`, `billCycleDay`, `currency`, `paymentGatewayId`, and `billingRunId` fields to define the billing documents to be collected.\n - Use the `data` field to specify the records of accounts and billing " }, { "info": { "name": "Retrieve a payment run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-runs/:paymentRunKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentRunKey", "value": "", "type": "path", "description": "The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.\n" } ] }, "docs": "Retrives the information about a specific payment run.\n" }, { "info": { "name": "Update a payment run", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payment-runs/:paymentRunKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentRunKey", "value": "", "type": "path", "description": "The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.\n" } ] }, "docs": "Updates the information about an unexecuted payment run. Only pending payment runs can be updated.\n\nIf none of the **accountId**, **batch**, **billCycleDay**, **currency**, **paymentGatewayId**, and **billingRunId** fields is specified in the request body, the corresponding payment run collects payments for all accounts.\n" }, { "info": { "name": "Delete a payment run", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/payment-runs/:paymentRunKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "paymentRunKey", "value": "", "type": "path", "description": "The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.\n" } ] }, "docs": "Deletes a payment run. Only payment runs with the Canceled or Error status can be deleted.\n" }, { "info": { "name": "Retrieve a payment run summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-runs/:paymentRunKey/summary", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "paymentRunKey", "value": "", "type": "path", "description": "The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.\n" } ] }, "docs": "Retrives the summary of a payment run.\n" }, { "info": { "name": "Retrieve payment run data", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-runs/:paymentRunKey/data", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "paymentRunKey", "value": "", "type": "path", "description": "The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.\n" } ] }, "docs": "Retrieves payment run data and the processing result with details, if the `data` field was specified in the Create payment run operation.\n \n" } ] }, { "info": { "name": "Payment Schedules", "type": "folder" }, "items": [ { "info": { "name": "List payment schedules by customer account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-schedules", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "lastProcessedItems", "value": "", "type": "query", "description": "Number of the most recent processed payment schedules dispalyed in the response body.\n" }, { "name": "nextPendingItems", "value": "", "type": "query", "description": "Number of next pending payment schedule items displayed in the response body.\n" }, { "name": "accountId", "value": "", "type": "query", "description": "The ID of the customer account. If neither `accountId` nor `accountNumber` is specified, all payment schedules will be returned. \n" }, { "name": "accountNumber", "value": "", "type": "query", "description": "The number of the customer account. If neither `accountId` nor `accountNumber` is specified, all payment schedules will be returned. \n" } ] }, "docs": "Retrieves payment schedules of a customer account.\n\n**Note:**\n- The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.\n- This operation is only available if you have [Invoice" }, { "info": { "name": "Create a payment schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-schedules", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ] }, "docs": "Creates a payment schedule. You can create either recurring payment schedules or custom payment schedules.\n\n**Note:**\n- This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled.\n- You can choose to use payment schedules to process payments associated with billing documents or unapplied payments. If Standalone Payment is enabled, you can also use payment schedules to process standalone payments.\n- " }, { "info": { "name": "Create multiple payment schedules at once", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-schedules/batch", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ] }, "docs": "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.\n\n**Note:**\n- The Paymen" }, { "info": { "name": "Retrieve a payment schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-schedules/:paymentScheduleKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "nextPendingItems", "value": "", "type": "query", "description": "Number of next pending payment schedule items displayed in the response body.\n" }, { "name": "lastProcessedItems", "value": "", "type": "query", "description": "Number of the most recent processed payment schedule items dispalyed in the response body.\n" }, { "name": "paymentScheduleKey", "value": "", "type": "path", "description": "The unique ID or number of a payment schedule. For example, `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.\n" } ] }, "docs": "Retrieves a payment schedule by payment schedule key.\n\n**Note:**\n- The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.\n- This operation is only available if you have [Invo" }, { "info": { "name": "Update a payment schedule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payment-schedules/:paymentScheduleKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "paymentScheduleKey", "value": "", "type": "path", "description": "The unique ID or number of a payment schedule. For example, `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.\n" } ] }, "docs": "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](/api-references/api/operation/PUT_PaymentScheduleItem/) operation to update payment schedule items of custom payment schedule.\n\nNote the following rules for the `periodStartDate`, `period`, and `occurrences`:\n\n- If `periodStartDate` is specified, all pending payment schedule items will be rescheduled using this new `periodStartDate`. I" }, { "info": { "name": "Preview the result of payment schedule updates", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payment-schedules/:paymentScheduleKey/preview", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "paymentScheduleKey", "value": "", "type": "path", "description": "The unique ID or number of a payment schedule. For example, `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.\n" } ] }, "docs": "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](/v1-api-reference/api/PUT_PaymentScheduleItem) operation to update payment schedule items of custom payment schedule.\n\nNote the following rules for the `periodStartDate`, `period`, and `occurrences`:\n\n- If `periodStartDate` is specifie" }, { "info": { "name": "Cancel a payment schedule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payment-schedules/:paymentScheduleKey/cancel", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "paymentScheduleKey", "value": "", "type": "path", "description": "The unique ID or number of a payment schedule. For example, `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.\n" } ] }, "docs": "Cancels a payment schedule.\n\n**Note:**\n- All pending payment schedule items will be canceled, effective from `cancelDate`. \n- The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge C" }, { "info": { "name": "Add payment schedule items to a custom payment schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-schedules/:paymentScheduleKey/items", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "paymentScheduleKey", "value": "", "type": "path", "description": "The unique ID or number of a payment schedule. For example, `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.\n" } ] }, "docs": "Adds payment schedule items to a custom payment schedule. You cannot use this operation to add payment schedule items to recurring payment schedules.\n\n**Note:**\n- The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Setting" }, { "info": { "name": "Retrieve payment schedule statistic of a date", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-schedules/statistics/:yyyy-mm-dd", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "yyyy-mm-dd", "value": "", "type": "path", "description": "Specifies the date of the payment schedule statistic you want to view. \n" } ] }, "docs": "Retrieves the payment schedule statistic of a specific date.\n\n**Note:**\n- The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.\n" }, { "info": { "name": "Retrieve a payment schedule item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-schedule-items/:item-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "item-id", "value": "", "type": "path", "description": "The unique ID of a payment schedule item.\n" } ] }, "docs": "Retrieves a payment schedule item by ID.\n\n**Note:**\n- The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.\n- This operation is only available if you have [Invoice Settlemen" }, { "info": { "name": "Update a payment schedule item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payment-schedule-items/:item-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "item-id", "value": "", "type": "path", "description": "The unique ID of a payment schedule item.\n" } ] }, "docs": "Updates a payment schedule item by ID.\n\n**Note:**\n- The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manag](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features).\n- This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled.\n- To link a s" }, { "info": { "name": "Cancel a payment schedule item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payment-schedule-items/:item-id/cancel", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "item-id", "value": "", "type": "path", "description": "The unique ID of a payment schedule item. \n" } ] }, "docs": "Cancels a payment schedule item by ID.\n\n**Note:**\n- The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.\n- This operation is only available if you have [Invoice Settlement]" }, { "info": { "name": "Skip a payment schedule item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payment-schedule-items/:item-id/skip", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "item-id", "value": "", "type": "path", "description": "The unique ID of a payment schedule item. \n" } ] }, "docs": "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.\n\n**Note:**\n- Only payment schedule items in recurring payment schedules can be skipped, and the item must be in the `pending` status.\n- The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it a" }, { "info": { "name": "Retry failed payment schedule items", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-schedule-items/retry-payment", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ] }, "docs": "Retries failed payment schedule items. The payment method and payment gateway of the failed payment can be updated to new values before the retry.\n\nNote that you can retry a payment schedule item only when the payment schedule item is either in the `Error` or `Pending` status.\n\n**Note:**\n- The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this fea" } ] }, { "info": { "name": "Payments", "type": "folder" }, "items": [ { "info": { "name": "List payments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payments", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "accountId", "value": "", "type": "query", "description": "This parameter filters the response based on the `accountId` field.\n" }, { "name": "amount", "value": "", "type": "query", "description": "This parameter filters the response based on the `amount` field.\n" }, { "name": "appliedAmount", "value": "", "type": "query", "description": "This parameter filters the response based on the `appliedAmount` field.\n" }, { "name": "createdById", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdById` field.\n" }, { "name": "createdDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdDate` field.\n" }, { "name": "creditBalanceAmount", "value": "", "type": "query", "description": "This parameter filters the response based on the `creditBalanceAmount` field.\n" }, { "name": "currency", "value": "", "type": "query", "description": "This parameter filters the response based on the `currency` field.\n" }, { "name": "effectiveDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `effectiveDate` field.\n" }, { "name": "number", "value": "", "type": "query", "description": "This parameter filters the response based on the `number` field.\n" }, { "name": "refundAmount", "value": "", "type": "query", "description": "This parameter filters the response based on the `refundAmount` field.\n" }, { "name": "status", "value": "", "type": "query", "description": "This parameter filters the response based on the `status` field.\n" }, { "name": "type", "value": "", "type": "query", "description": "This parameter filters the response based on the `type` field.\n" }, { "name": "unappliedAmount", "value": "", "type": "query", "description": "This parameter filters the response based on the `unappliedAmount` field.\n" }, { "name": "updatedById", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedById` field.\n" }, { "name": "updatedDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedDate` field.\n" }, { "name": "sort", "value": "", "type": "query", "description": "This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.\n\n - The `-` operator indicates an ascending order.\n - The `+` operator indicates a descending order.\n\nBy default, the response data is displayed in descending order by payment number.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n - number\n - accountId\n - amount\n - appliedAmount\n - unappliedAmount\n - refundAmount\n - creditBalanceAmount\n - effectiveDate\n - createdDate\n - createdById\n - updatedDate\n - updatedById\n \nExamples:\n\n- /v1/payments?sort=+number\n\n- /v1/payments?status=Processed&sort=-number,+amount\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Create a payment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payments", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Update a payment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payments/:paymentId", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentId", "value": "", "type": "path", "description": "The unique ID of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Retrieve a payment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payments/:paymentKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Delete a payment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/payments/:paymentKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Transfer a payment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payments/:paymentKey/transfer", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. \n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Apply a payment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payments/:paymentKey/apply", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Cancel a payment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payments/:paymentKey/cancel", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "List all parts of a payment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payments/:paymentKey/parts", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "paymentKey", "value": "", "type": "path", "description": "The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Retrieve a payment part", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payments/:paymentKey/parts/:partid", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "partid", "value": "", "type": "path", "description": "The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](/api-references/api/operation/GET_PaymentParts).\n" }, { "name": "paymentKey", "value": "", "type": "path", "description": "The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "List all payment part items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payments/:paymentKey/parts/:partid/itemparts", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "partid", "value": "", "type": "path", "description": "The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](/api-references/api/operation/GET_PaymentParts).\n" }, { "name": "paymentKey", "value": "", "type": "path", "description": "The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.\n" } ] }, "docs": "**Note:** This operation is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_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](https://knowledgecenter.zuora.com/Billing/Billing_and_P" }, { "info": { "name": "Retrieve a payment part item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payments/:paymentKey/parts/:partid/itemparts/:itempartid", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "partid", "value": "", "type": "path", "description": "The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](/api-references/api/operation/GET_PaymentParts).\n" }, { "name": "itempartid", "value": "", "type": "path", "description": "The unique ID of a specific payment part item. You can get the payment part item ID from the response of [List all payment part items](/api-references/api/operation/GET_PaymentItemParts).\n" }, { "name": "paymentKey", "value": "", "type": "path", "description": "The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.\n" } ] }, "docs": "**Note:** This operation is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_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](https://knowledgecenter.zuora.com/Billing/Billing_and_P" }, { "info": { "name": "Refund a payment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payments/:paymentKey/refunds", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Unapply a payment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payments/:paymentKey/unapply", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Refund a payment with auto-unapplying", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payments/:paymentKey/refunds/unapply", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" } ] }, { "info": { "name": "Prepaid with Drawdown", "type": "folder" }, "items": [ { "info": { "name": "Trigger fund rollover", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/ppdd/rollover", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ] }, "docs": "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.\n\n**Note**: This API will not work if rollover is enabled in the associated prepayment charge. If you want to trigger rollover automatically" }, { "info": { "name": "Reverse fund rollover", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/ppdd/reverse-rollover", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ] }, "docs": "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.\n\n**Note**: This API will not work if the associated prepayment charge has rollover enabled.\n" } ] }, { "info": { "name": "Price Book Items", "type": "folder" }, "items": [ { "info": { "name": "List price book items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/price-book-items", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "offer", "value": "", "type": "query", "description": "Used if you want to filter the PBIs associated with one offer. Can be offer id or number\n" }, { "name": "charge", "value": "", "type": "query", "description": "Used if you want to filter the PBIs of a charge. Charge id for now.\n" } ] }, "docs": "Retrieves basic information about all price book items.\n\n**Note**: This operation is in the **Beta** phase.\n" }, { "info": { "name": "Create a price book item", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/price-book-items", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates a price book item.\n\n**Note**: This operation is in the **Beta** phase. \n" }, { "info": { "name": "Retrieve a price book item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/price-book-items/:price-book-item-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "price-book-item-key", "value": "", "type": "path", "description": "The unique number or ID of the price book item to be retrieved.\n" } ] }, "docs": "Retrieves basic information about a price book item.\n\n**Note**: This operation is in the **Beta** phase.\n" }, { "info": { "name": "Update a price book item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/price-book-items/:price-book-item-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "price-book-item-key", "value": "", "type": "path", "description": "The unique number or ID of the price book item to be updated.\n" } ] }, "docs": "Update a price book item.\n\n**Note**: This operation is in the **Beta** phase.\n" }, { "info": { "name": "Delete a price book item", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/price-book-items/:price-book-item-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "price-book-item-key", "value": "", "type": "path", "description": "The unique number or ID of the price book item to be deleted.\n" } ] }, "docs": "Deletes a price book item.\n\n**Note**: This operation is in the **Beta** phase.\n" } ] }, { "info": { "name": "Product Charge Definitions", "type": "folder" }, "items": [ { "info": { "name": "List product charge definitions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/product-charge-definitions", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" } ], "params": [ { "name": "charge", "value": "", "type": "query", "description": "The unique number or ID of the charge for which the product charge definitions are to be retrieved.\n" }, { "name": "rateplan", "value": "", "type": "query", "description": "The unique number or ID of the product rate plan for which the product charge definitions are to be retrieved.\n" }, { "name": "hide-inherited-values", "value": "", "type": "query", "description": "The flag that controls whether the response will merge the default charge definition fields for those fields that are not overridden.\n" } ] }, "docs": "Retrieves basic information about the product charge definitions. \n\n**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. \n" }, { "info": { "name": "Create a product charge definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/product-charge-definitions", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" } ] }, "docs": "Creates a product charge definition for a charge. You can create as many product charge definitions as needed for one charge.\n\nIn the request, you must specify the unique ID or number of the charge for which this charge definition is to be created. \nThe ID or number of a product rate plan is optional.\n\n**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pri" }, { "info": { "name": "Create product charge definitions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/product-charge-definitions/bulk", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" } ] }, "docs": "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.\n\nIn the request, you must specify the unique ID or number of the charge for which this charge definition is to be created. \nThe ID or number of a product rate plan is optional.\n\n**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of" }, { "info": { "name": "Update product charge definitions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/product-charge-definitions/bulk", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" } ] }, "docs": "Bulk updates multiple product charge definitions.\n\n**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. \n" }, { "info": { "name": "Retrieve a product charge definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/product-charge-definitions/:product-charge-definition-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" } ], "params": [ { "name": "product-charge-definition-key", "value": "", "type": "path", "description": "The unique number or ID of the product charge definition to be retrieved.\n" }, { "name": "hide-inherited-values", "value": "", "type": "query", "description": "The flag that controls whether the response will merge the default charge definition fields for those fields that are not overridden.\n" } ] }, "docs": "Retrieves basic information about a product charge definition.\n\n**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. \n" }, { "info": { "name": "Update a product charge definition", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/product-charge-definitions/:product-charge-definition-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" } ], "params": [ { "name": "product-charge-definition-key", "value": "", "type": "path", "description": "The unique number or ID of the product charge definition to be updated.\n" } ] }, "docs": "Update a product charge definition.\n\n**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. \n" }, { "info": { "name": "Delete a product charge definition", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/product-charge-definitions/:product-charge-definition-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" } ], "params": [ { "name": "product-charge-definition-key", "value": "", "type": "path", "description": "The unique number or ID of the product charge definition to be deleted.\n" } ] }, "docs": "Deletes a product charge definition.\n\n**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. \n" } ] }, { "info": { "name": "Product Rate Plan Charges", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a product rate plan charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/product-rate-plan-charges/:product-rate-plan-charge-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" } ], "params": [ { "name": "product-rate-plan-charge-key", "value": "", "type": "path", "description": "The unique number or ID of the product rate plan charge to be retrieved.\n" }, { "name": "show-charge-definitions", "value": "", "type": "query", "description": "Specifies whether to include the product charge definitions of this charge in the response.\n\n**Note**: This parameter is applicable only if the Attribute-based Pricing feature is enabled. The Attribute-based Pricing feature in the **Early Adopter** phase. \nWe are actively soliciting feedback from a small set of early adopters. If you are interested, please reach out to your CSM.\n" } ] }, "docs": "Retrieves basic information about a product rate plan charge.\n" }, { "info": { "name": "CRUD: Create a product rate plan charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/object/product-rate-plan-charge", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "Creates a product rate plan charge for a specified rate plan charge. \n\nProduct rate plan charges can be of three types, one-time fees, recurring fees, and usage fees. \n" }, { "info": { "name": "CRUD: Retrieve a product rate plan charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/object/product-rate-plan-charge/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "Object fields to return" }, { "name": "id", "value": "", "type": "path", "description": "The unique ID of a product rate plan charge to be retrieved. For example, 2c93808457d787030157e031fcd34e19.\n" } ] }, "docs": "CRUD: Retrieve a product rate plan charge" }, { "info": { "name": "CRUD: Update a product rate plan charge", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/object/product-rate-plan-charge/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" }, { "name": "id", "value": "", "type": "path", "description": "The unique ID of the product rate plan charge to be updated. For example, 2c93808457d787030157e031fcd34e19.\n" } ] }, "docs": "Updates the information about a product rate plan charge.\n" }, { "info": { "name": "CRUD: Delete a product rate plan charge", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/object/product-rate-plan-charge/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique ID of the product rate plan charge to be deleted. For example, 2c93808457d787030157e031fcd34e19.\n" } ] }, "docs": "Deletes a product rate plan charge.\n" } ] }, { "info": { "name": "Product Rate Plan Definitions", "type": "folder" }, "items": [ { "info": { "name": "List product rate plan definitions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/product-rateplan-definitions", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" } ], "params": [ { "name": "charge", "value": "", "type": "query", "description": "The unique number or ID of the charge for which the product rate plan definitions are to be retrieved.\n" }, { "name": "rateplan", "value": "", "type": "query", "description": "The unique number or ID of the product rate plan for which the product rate plan definitions are to be retrieved.\n" } ] }, "docs": "Retrieves basic information about the product rate plan definitions for a product rate plan. \n\n**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. \n" }, { "info": { "name": "Create a product rate plan definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/product-rateplan-definitions", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" } ] }, "docs": "Creates a product rate plan definition to use a charge in a product rate plan.\n\nIn the request, you must specify either the unique ID or number of both the charge and the product rate plan to add the specified charge to a specific rate plan.\n\n**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter*" }, { "info": { "name": "Retrieve a product rate plan definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/product-rateplan-definitions/:product-rateplan-definition-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" } ], "params": [ { "name": "product-rateplan-definition-key", "value": "", "type": "path", "description": "The unique ID of the product rate plan definition to be retrieved.\n" } ] }, "docs": "Retrieves basic information about a product rate plan definition.\n\n**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. \n" }, { "info": { "name": "Delete a product rate plan definition", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/product-rateplan-definitions/:product-rateplan-definition-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" } ], "params": [ { "name": "product-rateplan-definition-key", "value": "", "type": "path", "description": "The unique ID of the product rate plan definition to be deleted.\n" } ] }, "docs": "Deletes a product rate plan definition.\n\n**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. \n" } ] }, { "info": { "name": "Product Rate Plans", "type": "folder" }, "items": [ { "info": { "name": "List all product rate plans of a product", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/products/:product-key/product-rate-plans", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "product-key", "value": "", "type": "path", "description": "The unique ID or SKU of a product. For example, 2c92c0f96487e16a016487f663c71a61 or SKU-00000987.\n" }, { "name": "show-charge-definitions", "value": "", "type": "query", "description": "Specifies whether to include the product charge definitions of this rate plan in the response.\n\n**Note**: This parameter is applicable only if the Attribute Based Pricing feature is enabled. To access this feature, submit a request at Zuora Global Support.\n" } ] }, "docs": "Retrieves information about all product rate plans of a specific product.\n" }, { "info": { "name": "Retrieve a product rate plan by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/product-rate-plans/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID, external ID, or the natural key of the product rate plan to be retrieved. For example, `402888e67f8b3a68017f8bbb2a06062d`, `Apple0001`, or `PRP-00000008`.\n" } ] }, "docs": "Retrieves a product rate plan by its ID.\n" }, { "info": { "name": "List product rate plans by external ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/product-rate-plans/external-id/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The external ID of the product rate plan to be retrieved. For example, `Apple0001`.\n" } ] }, "docs": "Retrieves information about one or multiple product rate plans by external ID.\n" }, { "info": { "name": "CRUD: Create a product rate plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/object/product-rate-plan", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "Retrieves a product rate plan.\n" }, { "info": { "name": "CRUD: Retrieve a product rate plan", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/object/product-rate-plan/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "Object fields to return" }, { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "Retrieves a product rate plan.\n" }, { "info": { "name": "CRUD: Update a product rate plan", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/object/product-rate-plan/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" }, { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "Updates a product rate plan.\n" }, { "info": { "name": "CRUD: Delete a product rate plan", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/object/product-rate-plan/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "Deletes a product rate plan.\n" } ] }, { "info": { "name": "Ramps", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a ramp", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/ramps/:rampNumber", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "rampNumber", "value": "", "type": "path", "description": "The automatically generated number of a ramp. For example, R-00000268.\n" } ] }, "docs": "**Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zu" }, { "info": { "name": "List all ramp metrics of a ramp", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/ramps/:rampNumber/ramp-metrics", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "rampNumber", "value": "", "type": "path", "description": "The automatically generated number of a ramp. For example, R-00000268.\n" } ] }, "docs": "**Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zu" }, { "info": { "name": "Retrieve a ramp by subscription key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/subscriptions/:subscriptionKey/ramps", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "subscriptionKey", "value": "", "type": "path", "description": "The ID or number of an existing subscription.\n" } ] }, "docs": "**Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zu" }, { "info": { "name": "List ramp metrics by subscription key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/subscriptions/:subscriptionKey/ramp-metrics", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "subscriptionKey", "value": "", "type": "path", "description": "The ID or number of an existing subscription.\n" } ] }, "docs": "**Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zu" }, { "info": { "name": "List ramp metrics by order number", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/orders/:orderNumber/ramp-metrics", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "orderNumber", "value": "", "type": "path", "description": "The number of the existing order.\n" } ] }, "docs": "**Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zu" } ] }, { "info": { "name": "Rate Plans", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a rate plan", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/rateplans/:ratePlanId", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ratePlanId", "value": "", "type": "path", "description": "The ID of the subscription rate plan to be retrieved." } ] }, "docs": "\nRetrieves the detailed information about a specific subscription rate plan.\n\n* If you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled, this operation retrieves information about a subscription rate plan and the related order that has amended the rate plan.\n\n* If you have the [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) feature en" } ] }, { "info": { "name": "Refunds", "type": "folder" }, "items": [ { "info": { "name": "List refunds", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/refunds", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "accountId", "value": "", "type": "query", "description": "This parameter filters the response based on the `accountId` field.\n" }, { "name": "amount", "value": "", "type": "query", "description": "This parameter filters the response based on the `amount` field.\n" }, { "name": "createdById", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdById` field.\n" }, { "name": "createdDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdDate` field.\n" }, { "name": "methodType", "value": "", "type": "query", "description": "This parameter filters the response based on the `methodType` field.\n" }, { "name": "number", "value": "", "type": "query", "description": "This parameter filters the response based on the `number` field.\n" }, { "name": "paymentId", "value": "", "type": "query", "description": "This parameter filters the response based on the `paymentId` field.\n" }, { "name": "refundDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `refundDate` field.\n" }, { "name": "status", "value": "", "type": "query", "description": "This parameter filters the response based on the `status` field.\n" }, { "name": "type", "value": "", "type": "query", "description": "This parameter filters the response based on the `type` field.\n" }, { "name": "updatedById", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedById` field.\n" }, { "name": "updatedDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedDate` field.\n" }, { "name": "sort", "value": "", "type": "query", "description": "This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.\n\n - The `-` operator indicates an ascending order.\n - The `+` operator indicates a descending order.\n\nBy default, the response data is displayed in descending order by refund number.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n - number\n - accountId\n - amount\n - refundDate\n - paymentId\n - createdDate\n - createdById\n - updatedDate\n - updatedById\n \nExamples:\n\n- /v1/refunds?sort=+number\n\n- /v1/refunds?status=Processed&sort=-number,+amount\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Update a refund", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/refunds/:refundId", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "refundId", "value": "", "type": "path", "description": "The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Retrieve a refund", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/refunds/:refundKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "refundKey", "value": "", "type": "path", "description": "The unique ID of a refund or the refund number. For example, 4028905f5a87c0ff015a889e590e00c9.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Delete a refund", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/refunds/:refundKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "refundKey", "value": "", "type": "path", "description": "The unique ID of a refund or the refund number. For example, 4028905f5a87c0ff015a889e590e00c9.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Cancel a refund", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/refunds/:refundKey/cancel", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "refundKey", "value": "", "type": "path", "description": "The unique ID of a refund or the refund number. For example, 4028905f5a87c0ff015a889e590e00c9. \n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "List all parts of a refund", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/refunds/:refundKey/parts", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "refundKey", "value": "", "type": "path", "description": "The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "Retrieve a refund part", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/refunds/:refundKey/parts/:refundpartid", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "refundpartid", "value": "", "type": "path", "description": "The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a refund](/api-references/api/operation/GET_RefundParts).\n" }, { "name": "refundKey", "value": "", "type": "path", "description": "The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.\n" } ] }, "docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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](https://knowledgecenter.zuora.com/Billin" }, { "info": { "name": "List all refund part items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/refunds/:refundKey/parts/:refundpartid/itemparts", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "refundpartid", "value": "", "type": "path", "description": "The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a refund](/api-references/api/operation/GET_RefundParts).\n" }, { "name": "refundKey", "value": "", "type": "path", "description": "The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.\n" } ] }, "docs": "**Note:** This operation is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_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](https://knowledgecenter.zuora.com/Billing/Billing_and_P" }, { "info": { "name": "Retrieve a refund part item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/refunds/:refundKey/parts/:refundpartid/itemparts/:itempartid", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "itempartid", "value": "", "type": "path", "description": "The unique ID of a specific refund part item. You can get the refund part item ID from the response of [Get refund part items](/api-references/api/operation/GET_RefundItemParts).\n" }, { "name": "refundpartid", "value": "", "type": "path", "description": "The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a refund](/api-references/api/operation/GET_RefundParts).\n" }, { "name": "refundKey", "value": "", "type": "path", "description": "The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.\n" } ] }, "docs": "**Note:** This operation is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_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](https://knowledgecenter.zuora.com/Billing/Billing_and_P" } ] }, { "info": { "name": "Regenerate", "type": "folder" }, "items": [ { "info": { "name": "Regenerate booking transactions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/uno-regenerate/booking-transaction", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "reMigrate", "value": "", "type": "query", "description": "Indicates if existing data in the database will be overridden. \n" } ] }, "docs": "Use this operation to generate booking transactions. This call is useful in the following two use cases:\n* During customer onboarding, there is a common scenario when customers perform data backfill or data fixes. To synchronize these changes from Billing to Revenue, use this API operation to regenerate booking transaction objects.\n* Customers choose to experiment with their use cases in the Sandbox environment before implementing them in the Production environment. During this experimentation p" }, { "info": { "name": "Regenerate billing transactions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/uno-regenerate/billing-transaction", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "reMigrate", "value": "", "type": "query", "description": "Indicates if existing data in the database will be overridden. \n" } ] }, "docs": "Use this operation to generate billing transactions. This call is useful in the following two use cases: \n* During customer onboarding, there is a common scenario when customers perform data backfill or data fixes. To synchronize these changes from Billing to Revenue, use this API operation to regenerate billing transaction objects.\n* Customers choose to experiment with their use cases in the Sandbox environment before implementing them in the Production environment. During this experimentation " }, { "info": { "name": "Regenerate revenue recognition events transactions for Delivery Schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/rev-rec-events", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "subscriptionNumber", "value": "", "type": "query", "description": "The subcription number.\n" }, { "name": "mode", "value": "", "type": "query", "description": "The generation mode." } ] }, "docs": "Use this operation to generate Delivery Schedule based revenue recognition events transactions.\n" }, { "info": { "name": "Regenerate revenue recognition events transactions for Daily Consumption", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/rev-rec-events/daily-consumption", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Use this operation to generate Daily Consumption based revenue recognition events transactions when the Prepaid with Drawdown feature is enabled.\n" } ] }, { "info": { "name": "Zuora Revenue Integration", "type": "folder" }, "items": [ { "info": { "name": "Update a Zuora Revenue accounting code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/revpro-accounting-codes", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ] }, "docs": "Update the Zuora Revenue accounting code that corresponds to a specific Product Rate Plan Charge Id in Zuora Billing." } ] }, { "info": { "name": "RSA Signatures", "type": "folder" }, "items": [ { "info": { "name": "Generate an RSA signature", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/rsa-signatures", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "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. \n \nThis REST service should be used only when you implement Payment Pages 2.0. \n\n**Note:** To avoid potential credit card fraud attacks, you should sec" }, { "info": { "name": "Decrypt an RSA signature", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/rsa-signatures/decrypt", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "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.\n\nThis REST service should be used only when you implement Payment Pages 2.0. \n" } ] }, { "info": { "name": "Sequence Sets", "type": "folder" }, "items": [ { "info": { "name": "List sequence sets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/sequence-sets", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "name", "value": "", "type": "query", "description": "The name of a specific sequence set.\n" } ] }, "docs": "Retrieves information about all sequence sets configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos.\n\nYou can use query parameters to restrict the data returned in the response.\n\n**Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuor" }, { "info": { "name": "Create sequence sets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/sequence-sets", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ] }, "docs": "Creates sequence sets, allowing distinct numbering sequences for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos.\n\nYou can create a maximum of 100 sequence sets in one single request. A sequence set comprises a set of custom prefixes and starting numbers that are used for billing documents to generate, and payments and refunds to create.\n\nSee [Prefix and Numbering Configuration for Billing Documents](https://knowledgecenter.zuora.com/CB" }, { "info": { "name": "Retrieve a sequence set", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/sequence-sets/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the sequence set to retrieve information about.\n" } ] }, "docs": "Retrieves information about a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos\n\n**Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Paym" }, { "info": { "name": "Update a sequence set", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/sequence-sets/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the sequence set to update.\n" } ] }, "docs": "Updates a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos.\n\n**Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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 De" }, { "info": { "name": "Delete a sequence set", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/sequence-sets/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the sequence set to delete.\n" } ] }, "docs": "Deletes a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos.\n\n**Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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 De" } ] }, { "info": { "name": "Settings", "type": "folder" }, "items": [ { "info": { "name": "List all settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/listing", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Accept", "value": "" } ] }, "docs": "Get a list of all available settings in your tenant. \n\nThe response message is by default in JSON format. If you want to receive all the available settings in csv format, include `Accept` in the header parameters and set it to `application/csv`.\n \nSee a [200 response sample in JSON format](/settings-api/ListAllSettingsResponseSample.json) that lists all available settings. \n\nSee a [200 response sample in CSV format](/settings-api/ListAllSettingsResponseSample.csv) that lists all avail" }, { "info": { "name": "Submit settings requests", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/batch-requests", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ] }, "docs": "Submit a batch of settings requests by this single API operation.\n\nBy default, one batch settings request can contain a maximum of 100 single operation requests, including: \n* All the single requests in the process batch settings request.\n* All the children requests of the single requests.\n\nThis maximum value is configurable.\n" } ] }, { "info": { "name": "Sign Up", "type": "folder" }, "items": [ { "info": { "name": "Sign up", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/sign-up", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Accept", "value": "" } ] }, "docs": "This call performs many actions. You can use this operation to implement the standard requirements for signing up a customer, such as validating the uniqueness of an account and limiting the number of 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. \n\n**Note:** You need to have the [Orders](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders) or [Orders Harmonization](ht" } ] }, { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Preview a subscription", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/subscriptions/preview", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ] }, "docs": "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.\n\n### Notes\n- The response of the Preview Subscription call is based on the REST API minor version you set in the request header. The respon" }, { "info": { "name": "Create a subscription", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/subscriptions", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ] }, "docs": "This REST API reference describes how to create a new subscription for an existing customer account.\n\n### Notes\n\nIf you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs.\n\nIf `invoiceCollect` is `true`, the call will not return `success` = `true` unless the subscription, invoice, and payment are all successful.\n" }, { "info": { "name": "List subscriptions by account key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/subscriptions/accounts/:account-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "account-key", "value": "", "type": "path", "description": "\nPossible values are:\n* an account number\n* an account ID\n" }, { "name": "charge-detail", "value": "", "type": "query", "description": "The segmented rate plan charges.\n\nWhen an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges.\n\nPossible values are:\n\n* __last-segment__: (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription.\n * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate).\n \n * __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments.\n\n * __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd.\n" }, { "name": "exclude-rate-plans-with-no-charges", "value": "", "type": "query", "description": "If the `exclude-rate-plans-with-no-charges` is `true`, only the active charges and rate plans will be in the response. The default value is `false`.\n" } ] }, "docs": "Retrieves all subscriptions associated with the specified account. Zuora only returns the latest version of the subscriptions.\n\nSubscription data is returned in reverse chronological order based on `updatedDate`. Note that the rate plans inside the subscriptions are not sorted specifically and are returned in a random order.\n" }, { "info": { "name": "Retrieve a subscription by key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/subscriptions/:subscription-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "path", "description": "Possible values are:\n * a subscription number\n * a subscription ID\n" }, { "name": "charge-detail", "value": "", "type": "query", "description": "\nThe segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges.\n\nPossible values are:\n\n * __last-segment__: (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription.\n * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate).\n \n * __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments.\n\n * __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified ((specific date = effectiveStartDate) OR (effectiveStartDate < specific date < effectiveEndDate)). The format of the date is yyyy-mm-dd.\n" }, { "name": "exclude-rate-plans-with-no-charges", "value": "", "type": "query", "description": "If the `exclude-rate-plans-with-no-charges` is `true`, only the active charges and rate plans will be in the response. The default value is `false`.\n" } ] }, "docs": "This REST API reference describes how to retrieve detailed information about a specified subscription in the latest version.\n" }, { "info": { "name": "Update a subscription", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/subscriptions/:subscription-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "path", "description": "\nSubscription number or ID. \nID can be the latest version or any history version of ID. \n* To make sure you update the last version of the subscription, use one of the following operations to retrieve the last version of ID:\n * [List subscriptions by account key](/api-references/api/operation/GET_SubscriptionsByAccount)\n * [Retrieve a subscription by key](/api-references/api/operation/GET_SubscriptionsByKey) by using the subscription number as the subscription-key\n* If you want to use any history version of ID, the `STABLE_ID_PUBLIC_API` permission must be enabled. Submit a request at [Zuora Global Support](http://support.zuora.com/) to enable the permission. To retrieve a history version of ID, use the [Retrieve a subscription by key and version](/api-references/api/operation/GET_SubscriptionsByKeyAndVersion) operation.\n" } ] }, "docs": "Use this call to make the following kinds of changes to a subscription:\n * Add a note\n * Change the renewal term or auto-renewal flag\n * Change the term length or change between evergreen and termed\n * Add a new product rate plan\n * Remove an existing subscription rate plan\n * Change the quantity or price of an existing subscription rate plan\n * Change rate plans - to replace the existing rate plans in a subscription with other rate plans. Changing rate plans is currently not supported fo" }, { "info": { "name": "Retrieve a subscription by key and version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/subscriptions/:subscription-key/versions/:version", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "path", "description": "Subscription number. For example, A-S00000135.\n" }, { "name": "version", "value": "", "type": "path", "description": "Subscription version. For example, 1.\n" }, { "name": "charge-detail", "value": "", "type": "query", "description": "\nThe segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges.\n\nPossible values are:\n\n * __last-segment__: (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription.\n * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate).\n \n * __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments.\n\n * __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd.\n" }, { "name": "exclude-rate-plans-with-no-charges", "value": "", "type": "query", "description": "If the `exclude-rate-plans-with-no-charges` is `true`, only the active charges and rate plans will be in the response. The default value is `false`.\n" } ] }, "docs": "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.\n" }, { "info": { "name": "Renew a subscription", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/subscriptions/:subscription-key/renew", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "path", "description": "Subscription number or ID" } ] }, "docs": "Renews a termed subscription using existing renewal terms. \nWhen you renew a subscription, the current subscription term is extended by creating a new term. \nIf any charge in your subscription has the billing period set as `SubscriptionTerm`， a new charge segment is generated for the new term.\n\n\n**Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](/api-references/api/overview/#section/API-" }, { "info": { "name": "Cancel a subscription", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/subscriptions/:subscription-key/cancel", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "path", "description": "Subscription number or ID. Subscription status must be `Active`." } ] }, "docs": "This REST API reference describes how to cancel an active subscription.\n\n**Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs.\n" }, { "info": { "name": "Resume a subscription", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/subscriptions/:subscription-key/resume", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "path", "description": "Subscription number or ID. Subscription status must be Suspended." } ] }, "docs": "This REST API reference describes how to resume a suspended subscription. \n\n**Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs.\n" }, { "info": { "name": "Suspend a subscription", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/subscriptions/:subscription-key/suspend", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "zuora-version", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "path", "description": "Subscription number or ID. Subscription status must be Active." } ] }, "docs": "This REST API reference describes how to suspend an active subscription. \n\n**Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs.\n" }, { "info": { "name": "Delete a subscription by number", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/subscriptions/:subscription-key/delete", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "path", "description": "Subscription number" } ] }, "docs": "This REST API reference describes how to delete a subscription of the specified subscription number.\n" }, { "info": { "name": "Update subscription custom fields of a subscription version", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/subscriptions/:subscriptionNumber/versions/:version/customFields", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "subscriptionNumber", "value": "", "type": "path", "description": "The subscription number to be updated." }, { "name": "version", "value": "", "type": "path", "description": "The subscription version to be updated." } ] }, "docs": "Updates the custom fields of a specified subscription version.\n" } ] }, { "info": { "name": "Summary Journal Entries", "type": "folder" }, "items": [ { "info": { "name": "Create a summary journal entry", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/journal-entries", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "This REST API reference describes how to manually create a summary journal entry. Request and response field descriptions and sample code are provided.\n### Requirements\n1.The sum of debits must equal the sum of credits in the summary journal entry.\n\n2.The following applies only if you use foreign currency conversion:\n * If you have configured Aggregate transactions with different currencies during a Journal Run to \"Yes\", the value of the **currency** field must be the same as your tenant's home" }, { "info": { "name": "List all summary journal entries in a journal run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/journal-entries/journal-runs/:jr-number", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "jr-number", "value": "", "type": "path", "description": "Journal run number." } ] }, "docs": "\nThis REST API reference describes how to retrieve information about all summary journal entries in a journal run.\n" }, { "info": { "name": "Retrieve a summary journal entry", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/journal-entries/:je-number", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "je-number", "value": "", "type": "path" } ] }, "docs": "This REST API reference describes how to get information about a summary journal entry by its journal entry number.\n" }, { "info": { "name": "Delete a summary journal entry", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/journal-entries/:je-number", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "je-number", "value": "", "type": "path", "description": "Journal entry number in the format JE-00000001." } ] }, "docs": "This reference describes how to delete a summary journal entry using the REST API.\n\nYou must have the \"Delete Cancelled Journal Entry\" user permission enabled to delete summary journal entries.\n\nA summary journal entry must be canceled before it can be deleted.\n" }, { "info": { "name": "Cancel a summary journal entry", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/journal-entries/:je-number/cancel", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "je-number", "value": "", "type": "path", "description": "Journal entry number in the format JE-00000001." } ] }, "docs": "\nThis reference describes how to cancel a summary journal entry using the REST API.\n \nYou must have the \"Cancel Journal Entry\" user permission enabled to cancel summary journal entries.\n \nA summary journal entry cannot be canceled if its Transferred to Accounting status is \"Yes\" or \"Processing\".\n" }, { "info": { "name": "Update a summary journal entry", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/journal-entries/:je-number/basic-information", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "je-number", "value": "", "type": "path", "description": "Journal entry number in the format JE-00000001." } ] }, "docs": "\nThis 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.\n" } ] }, { "info": { "name": "Taxation Items", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a taxation item\n", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/taxationitems/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique ID of a taxation item.\n" } ] }, "docs": "Retrieves the information about a specific taxation item by ID.\n" }, { "info": { "name": "Update a taxation item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/taxationitems/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique ID of a taxation item.\n" } ] }, "docs": "Updates a specific taxation item by ID.\n" }, { "info": { "name": "Delete a taxation item", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/taxationitems/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique ID of a taxation item.\n" } ] }, "docs": "Deletes a specific taxation item by ID.\n" }, { "info": { "name": "CRUD: Create a taxation item", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/object/taxation-item", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "CRUD: Create a taxation item" } ] }, { "info": { "name": "Usage", "type": "folder" }, "items": [ { "info": { "name": "Upload a usage file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/usage", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "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. \n\n### How this REST API Call Works\nThe content of the uploaded usage file must follow the format used by the UI import tool. It must be a comma-separated (CSV) file with a corresponding .csv extension. The length of the file name must not exceed 50" }, { "info": { "name": "Retrieve a usage record", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/usage/accounts/:account-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "account-key", "value": "", "type": "path", "description": "Account number or account ID." } ] }, "docs": "This REST API reference describes how to retrieve usage details for an account. Usage data is returned in reverse chronological order.\n" }, { "info": { "name": "Retrieve usage rate detail for an invoice item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/invoices/invoice-item/:invoice-item-id/usage-rate-detail", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "invoice-item-id", "value": "", "type": "path", "description": "Invoice item ID. For example, `402880e57f725d85017f7267c4ad002b`. Available through Data Source export." } ] }, "docs": "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](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Create_a_custom_invoice_template/DD_Display_Usage_Charge_Breakdown#How_UsageSummary.RateDetail_is_displayed_on_invoices). \n\n**Notes and limitations:**\n- Do not support the Overage Charge Model, Tiered with Overage Cha" }, { "info": { "name": "CRUD: Create a usage record", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/object/usage", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "CRUD: Create a usage record" }, { "info": { "name": "CRUD: Retrieve a usage record", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/object/usage/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "Object fields to return" }, { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "CRUD: Retrieve a usage record" }, { "info": { "name": "CRUD: Update a usage record", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/object/usage/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" }, { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "CRUD: Update a usage record" }, { "info": { "name": "CRUD: Delete a usage record", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/object/usage/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "CRUD: Delete a usage record" } ] }, { "info": { "name": "Workflows", "type": "folder" }, "items": [ { "info": { "name": "List workflows", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "callout_trigger", "value": "", "type": "query", "description": "If set to true, the operation retrieves workflows that have the callout trigger enabled. If set to false, the operation retrieves workflows that have the callout trigger disabled. If not specified, the operation will not use this filter.\n" }, { "name": "interval", "value": "", "type": "query", "description": "A CRON expession that specifies a schedule (for example, `0 0 * * *`). If specified, the operation retrieves the workflow that is run based on the specified schedule.\n" }, { "name": "name", "value": "", "type": "query", "description": "If specified, the operation retrieves the workflow that is in the specified name.\n" }, { "name": "ondemand_trigger", "value": "", "type": "query", "description": "If set to true, the operation retrieves workflows that have the ondemand trigger enabled. If set to false, the operation retrieves workflows that have the ondemand trigger disabled. If not specified, the operation will not use this filter.\n" }, { "name": "scheduled_trigger", "value": "", "type": "query", "description": "If set to true, the operation retrieves workflows that have the scheduled trigger enabled. If set to false, the operation retrieves workflows that have the scheduled trigger disabled. If not specfied, the operation will not use this filter.\n" }, { "name": "page", "value": "", "type": "query", "description": "If you want to retrieve only the workflows on a specific page, you can specify the `page` number in the query.\n" }, { "name": "page_length", "value": "", "type": "query", "description": "The number of workflows shown in a single call. If the `page` parameter is not specified, the operation will return only the first page of results. If there are multiple pages of results, use it with the `page` parameter to get the results on subsequent pages. The maximum value is 50.\n" } ] }, "docs": "Retrieves a list of workflow definitions available in your Zuora tenant.\n\n### User Access Permission\nYou must be assigned the **Workflow View Access** permission to run this operation. \n" }, { "info": { "name": "Retrieve a workflow", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows/:workflow_id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique ID of a workflow definition. For example, 19080.\n" } ] }, "docs": "Retrieves information about a specific workflow by its ID.\n\n### User Access Permission\nYou must be assigned the **Workflow View Access** permission to run this operation.\n" }, { "info": { "name": "Update a workflow", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/workflows/:workflow_id", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique ID of a workflow definition. For example, 19080.\n" } ] }, "docs": "Updates a specific workflow by its ID, which allows you to [configure the settings of a workflow](https://knowledgecenter.zuora.com/CE_Workflow/Using_Workflow/B_Configure_a_Workflow) via API.\n\n### User Access Permission\nYou must be assigned the **Workflow Manage Access** permission to run this operation.\n" }, { "info": { "name": "Delete a workflow", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/workflows/:workflow_id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique ID of a workflow definition. For example, 19080.\n" } ] }, "docs": "Deletes a specific workflow by its ID.\n\n### User Access Permission\nYou must be assigned the **Workflow Manage Access** permission to run this operation.\n" }, { "info": { "name": "Retrieve a workflow run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows/workflow_runs/:workflow_run_id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "workflow_run_id", "value": "", "type": "path", "description": "The unique ID of a workflow run. For example, 19080.\n" } ] }, "docs": "Retrieves information about a specific workflow run by its ID.\n\n### User Access Permission\nYou must be assigned the **Workflow View Access** permission to run this operation.\n" }, { "info": { "name": "Run a workflow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workflows/:workflow_id/run", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The ID of the workflow definition you want to run." } ] }, "docs": "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.\n\n**Note**: To run a workflow, do not use the following reserved words in the request body of the parameters.\n - `controller`\n - `action`\n - `id`\n - `user_email`\n - `user_token`\n - `format`\n\n### User Access Permission\nYou must be assigned the **Workflow Run Access** perm" }, { "info": { "name": "Export a workflow version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows/:workflow_id/export", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The ID of the workflow definition to export." }, { "name": "version", "value": "", "type": "query", "description": "Default result is the active version of the workflow definition. Version number and 'latest' can be used to export a specific version of the workflow definition. \n" } ] }, "docs": "\nExports a workflow version into a JSON file. This file can be used to create a copy of this workflow version.\n\n### User Access Permission\nYou must be assigned the **Workflow View Access** permission to run this operation.\n" }, { "info": { "name": "Import a workflow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workflows/import", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "workflow_definition_id", "value": "", "type": "query", "description": "The unique id of the workflow definition to import a workflow version under." }, { "name": "version", "value": "", "type": "query", "description": "The version number of the new workflow version to import. Must be greater than any existing version numbers." }, { "name": "activate", "value": "", "type": "query", "description": "Indicates whether the imported version is an active version. Default to be false." } ] }, "docs": "Create a new workflow definition and its first version using the exported JSON document of an existing workflow version.\n\n### User Access Permission\nYou must be assigned the **Workflow Manage Access** permission to run this operation.\n" }, { "info": { "name": "Import a workflow version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workflows/:workflow_id/versions/import", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id of the workflow definition to import a workflow version under." }, { "name": "version", "value": "", "type": "query", "description": "The version number of the new workflow version to import. Must be greater than any existing version numbers." }, { "name": "activate", "value": "", "type": "query", "description": "Indicates whether the imported version is an active version. Default to be false." } ] }, "docs": "Create a new workflow version under a workflow definition using the exported JSON document of an existing workflow version.\n\n### User Access Permission\nYou must be assigned the **Workflow Manage Access** permission to run this operation.\n" }, { "info": { "name": "Delete a workflow version", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/versions/:version_id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "version_id", "value": "", "type": "path", "description": "The unique id of the workflow version." } ] }, "docs": "Delete a workflow version based on the version id. \n\n### User Access Permission\nYou must be assigned the **Workflow Manage Access** permission to run this operation.\n" }, { "info": { "name": "List all versions of a workflow definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows/:workflow_id/versions", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id of the workflow definition to import a workflow version under." } ] }, "docs": "Return a list of all workflow versions under a workflow definition\n\n### User Access Permission\nYou must be assigned the **Workflow View Access** permission to run this operation.\n" }, { "info": { "name": "List workflow tasks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows/tasks", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "If specified, the operation retrieves the task that is with specified id.\n" }, { "name": "name", "value": "", "type": "query", "description": "If specified, the operation retrieves tasks that is in the specified name.\n" }, { "name": "instance", "value": "", "type": "query", "description": "If set to true, the operation retrieves workflows that have the scheduled trigger enabled. If set to false, the operation retrieves workflows that have the scheduled trigger disabled. If not specfied, the operation will not use this filter.\n" }, { "name": "action_type", "value": "", "type": "query", "description": "If specified, the operation retrieves tasks that is the specified type.\n" }, { "name": "object", "value": "", "type": "query", "description": "If specified, the operation retrieves tasks with the specified object.\n" }, { "name": "object_id", "value": "", "type": "query", "description": "If specified, the operation retrieves tasks with the specified object id.\n" }, { "name": "call_type", "value": "", "type": "query", "description": "If specified, the operation retrieves tasks with the specified api call type used.\n" }, { "name": "workflow_id", "value": "", "type": "query", "description": "If specified, the operation retrieves tasks that for the specified workflow id.\n" }, { "name": "tags", "value": "", "type": "query", "description": "If specified, the operation retrieves tasks that with the specified filter tags. Use the following syntax to specify multiple tags: `tags[]=tag_value_1&tags[]=tag_value_2`.\n\n**Note:** All the workflow tasks that have any of the specified tags will be listed in the response body.\n" }, { "name": "page", "value": "", "type": "query", "description": "If you want to retrieve only the workflows on a specific page, you can specify the `page` number in the query.\n" }, { "name": "page_length", "value": "", "type": "query", "description": "The number of workflow tasks shown in a single call. If the `page` parameter is not specified, the operation will return only the first page of results. If there are multiple pages of results, use it with the `page` parameter to get the results on subsequent pages. The maximum value is 100.\n" } ] }, "docs": "Retrieves a list of workflow tasks available in your Zuora tenant.\n\n### User Access Permission\nYou must be assigned the **Workflow View Access** permission to run this operation.\n" }, { "info": { "name": "Retrieve a workflow task", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows/tasks/:task_id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "The unique ID of the task.\n" } ] }, "docs": "Retrieves a specific workflow task by its ID.\n\n### User Access Permission\nYou must be assigned the **Workflow View Access** permission to run this operation.\n" }, { "info": { "name": "Rerun a workflow task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workflows/tasks/:task_id/rerun", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "The unique ID of the task.\n" } ] }, "docs": "Reruns a specific workflow task by its ID.\n\n### User Access Permission\nYou must be assigned the **Workflow Run Access** permission to run this operation.\n" }, { "info": { "name": "Update workflow tasks", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/workflows/tasks/batch_update", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ] }, "docs": "Updates a group of workflow tasks.\n\n### User Access Permission\nYou must be assigned the **Workflow Manage Access** permission to run this operation.\n" }, { "info": { "name": "Retrieve workflow task usage", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows/metrics.json", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "startDate", "value": "", "type": "query", "description": "The start date of the usage data that you want to get. For example, 2019-01-01.\n" }, { "name": "endDate", "value": "", "type": "query", "description": "The end date of the usage data that you want to get. For example, 2019-12-31.\n" }, { "name": "metrics", "value": "", "type": "query", "description": "The type of metric that you want to get. Currently, only `taskCount` is supported. `taskCount` is the amount of task runs.\n" } ] }, "docs": "Gets workflow task usage sorted by day within a specified time frame.\n\n### User Access Permission\nYou must be assigned the **Workflow View Access** permission to run this operation. \n" } ] }, { "info": { "name": "Imports", "type": "folder" }, "items": [ { "info": { "name": "CRUD: Retrieve an import", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/object/import/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "Object fields to return" }, { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "CRUD: Retrieve an import" }, { "info": { "name": "CRUD: Create an import", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/object/import", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "Creates a data import.\n" } ] }, { "info": { "name": "Payment Method Snapshots", "type": "folder" }, "items": [ { "info": { "name": "CRUD: Retrieve a payment method snapshot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/object/payment-method-snapshot/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "Object fields to return" }, { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "This REST API reference describes how to retrieve a Payment Method Snapshot.\n\nA Payment Method Snapshot is a copy of the particular Payment Method used in a transaction. If the Payment Method is deleted, the Payment Method Snapshot continues to retain the data used in each of the past transactions.\n\n### Notes\nThe following Payment Method fields are not available in Payment Method Snapshots:\n\n* `Active`\n* `AchAddress1`\n* `AchAddress2`\n* `CreatedById`\n* `CreatedDate`\n* `UpdatedById`\n* `UpdatedDate" } ] }, { "info": { "name": "Payment Method Transaction Logs", "type": "folder" }, "items": [ { "info": { "name": "CRUD: Retrieve a payment method transaction log", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/object/payment-method-transaction-log/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "Object fields to return" }, { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "CRUD: Retrieve a payment method transaction log" } ] }, { "info": { "name": "Payment Transaction Logs", "type": "folder" }, "items": [ { "info": { "name": "CRUD: Retrieve a payment transaction log", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/object/payment-transaction-log/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a payment transaction log.\n" } ] }, "docs": "Retrieves information about a specific payment transaction log.\n" } ] }, { "info": { "name": "Products", "type": "folder" }, "items": [ { "info": { "name": "CRUD: Create a product", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/object/product", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "CRUD: Create a product" }, { "info": { "name": "CRUD: Retrieve a product", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/object/product/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "Object fields to return" }, { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "CRUD: Retrieve a product" }, { "info": { "name": "CRUD: Update a product", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/object/product/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" }, { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "CRUD: Update a product" }, { "info": { "name": "CRUD: Delete a product", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/object/product/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "CRUD: Delete a product" } ] }, { "info": { "name": "Product Rate Plan Charge Tiers", "type": "folder" }, "items": [ { "info": { "name": "CRUD: Retrieve a product rate plan charge tier", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/object/product-rate-plan-charge-tier/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "Object fields to return" }, { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "CRUD: Retrieve a product rate plan charge tier" }, { "info": { "name": "CRUD: Update a product rate plan charge tier", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/object/product-rate-plan-charge-tier/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" }, { "name": "id", "value": "", "type": "path", "description": "The unique ID of the product rate plan charge tier to be updated. For example, 2c92c0f86c85891e016c88d55a6e543b.\n" } ] }, "docs": "Updates the price of a product rate plan charge tier.\n\nTo make other updates to product rate plan charge tiers, use [CRUD: Update a product rate plan charge](/api-references/api/operation/Object_PUTProductRatePlanCharge) and specify `ProductRatePlanChargeTierData` in the request body.\n" } ] } ], "bundled": true }